跳到主要内容

Elastic

Bundles 按提供方对组件进行分组,这些组件可将第三方服务与 SkillFlaw 集成。

本页介绍 Elastic bundle 中可用的组件。

Elasticsearch

Elasticsearch 组件使用 ElasticsearchStore 实例对 Elasticsearch 实例进行读写。

关于向量存储实例

由于 SkillFlaw 基于 LangChain,向量存储组件会使用一个 LangChain 向量存储 实例来驱动底层的读写功能。 这些实例具有提供商特定性,并根据组件参数进行配置,例如连接字符串、索引名称和 schema。

在组件代码中,这通常会被实例化为 vector_store,但某些向量存储组件会使用其他名称,例如提供商名称。

有些 LangChain 类不会将所有可选项都暴露为组件参数。 根据提供商不同,这些选项可能使用默认值,或者在 SkillFlaw 支持的情况下通过环境变量进行修改。 有关具体选项,请参阅 LangChain API 参考和向量存储提供商文档。

如果你使用向量存储组件查询向量数据库,它会生成搜索结果,你可以将这些结果作为 Data 对象列表或表格形式的 DataFrame 传递给流程中的下游组件。 如果同时支持这两种类型,你可以在可视化编辑器中、向量存储组件输出端口附近设置输出格式。

Elasticsearch 参数

你可以查看向量存储组件的参数,以了解它可接受的输入、支持的功能以及配置方式。

有些参数在可视化编辑器中默认处于隐藏状态。 你可以通过组件标题栏菜单中的 控件 来修改全部参数。

有些参数是条件参数,只有在你设置了其他参数,或为其他参数选择了特定选项之后才会显示。 在满足所需依赖之前,条件参数可能不会出现在 控件 面板中。

有关可接受值和功能的信息,请参见 Elasticsearch documentation 或查看组件代码

NameTypeDescription
elasticsearch_urlString输入参数。Elasticsearch 服务器 URL。
cloud_idString输入参数。Elasticsearch Cloud ID。
index_nameString输入参数。Elasticsearch index 的名称。
ingest_dataData输入参数。要加载到向量存储中的记录。
search_queryString输入参数。用于相似性搜索的查询字符串。
cache_vector_storeBoolean输入参数。如果为 true,组件会将向量存储缓存在内存中,以加快读取速度。默认值:启用(true)。
usernameString输入参数。用于 Elasticsearch 身份验证的用户名。所有本地部署都必填。云部署中如果 api_key 为空,也为必填。
passwordSecretString输入参数。用于 Elasticsearch 身份验证的密码。所有本地部署都必填。云部署中如果 api_key 为空,也为必填。
embeddingEmbeddings输入参数。要使用的 embedding model。
search_typeString输入参数。要执行的搜索类型。可选值为 similarity(默认)或 mmr
number_of_resultsInteger输入参数。返回的结果数。默认值:4。
search_score_thresholdFloat输入参数。搜索结果的最小相似度分数阈值。默认值:0。
api_keySecretString输入参数。用于 Elastic Cloud 身份验证的 API key。如果已提供,则不需要 usernamepassword
verify_certsBoolean输入参数。连接到 Elasticsearch 时是否验证 SSL 证书。默认值:启用(true)。

OpenSearch

OpenSearch 组件使用 OpenSearchVectorSearch 对 OpenSearch 实例进行读写。

关于向量存储实例

由于 SkillFlaw 基于 LangChain,向量存储组件会使用一个 LangChain 向量存储 实例来驱动底层的读写功能。 这些实例具有提供商特定性,并根据组件参数进行配置,例如连接字符串、索引名称和 schema。

在组件代码中,这通常会被实例化为 vector_store,但某些向量存储组件会使用其他名称,例如提供商名称。

有些 LangChain 类不会将所有可选项都暴露为组件参数。 根据提供商不同,这些选项可能使用默认值,或者在 SkillFlaw 支持的情况下通过环境变量进行修改。 有关具体选项,请参阅 LangChain API 参考和向量存储提供商文档。

OpenSearch 参数

你可以查看向量存储组件的参数,以了解它可接受的输入、支持的功能以及配置方式。;

有些参数在可视化编辑器中默认处于隐藏状态。 你可以通过组件标题栏菜单中的 控件 来修改全部参数。

有些参数是条件参数,只有在你设置了其他参数,或为其他参数选择了特定选项之后才会显示。 在满足所需依赖之前,条件参数可能不会出现在 控件 面板中。

有关可接受值和功能的信息,请参见 OpenSearch documentation 或查看组件代码

NameTypeDescription
opensearch_urlString输入参数。OpenSearch 集群的 URL,例如 https://192.168.1.1:9200
index_nameString输入参数。OpenSearch 集群中存储向量的 index 名称。默认值:组件内置的 index 名称。
ingest_dataData输入参数。要导入向量存储的数据。
search_inputString输入参数。输入搜索查询。若要检索所有文档或正在使用混合搜索,可留空。
cache_vector_storeBoolean输入参数。如果为 true,组件会将向量存储缓存在内存中,以加快读取速度。默认值:启用(true)。
embeddingEmbeddings输入参数。连接一个embedding model 组件,以从搜索查询生成 embedding。
search_typeString输入参数。要执行的搜索类型。可选值为 similarity(默认)、similarity_score_thresholdmmr
number_of_resultsInteger输入参数。搜索返回的结果数。默认值:4。
search_score_thresholdFloat输入参数。搜索结果的最小相似度分数阈值。默认值:0。
usernameString输入参数。OpenSearch 集群的用户名。默认值:admin
passwordSecretString输入参数。OpenSearch 集群的密码。
use_sslBoolean输入参数。是否使用 SSL。默认值:启用(true)。
verify_certsBoolean输入参数。是否验证 SSL 证书。默认值:禁用(false)。
hybrid_search_queryString输入参数。以 JSON 格式提供自定义混合搜索查询。这样可以将向量相似性与关键词匹配结合起来。

OpenSearch 输出

如果你使用向量存储组件查询向量数据库,它会生成搜索结果,你可以将这些结果作为 Data 对象列表或表格形式的 DataFrame 传递给流程中的下游组件。 如果同时支持这两种类型,你可以在可视化编辑器中、向量存储组件输出端口附近设置输出格式。

Vector Store Connection 端口

OpenSearch 组件还带有一个已弃用的 Vector Store Connection 输出。 该输出只能连接到 VectorStore 输入端口,原本用于专门的 Graph RAG 组件。

OpenSearch 组件不需要单独的 Graph RAG 组件,因为 OpenSearch 实例通过内置 RAG 功能和插件支持 Graph traversal。