langchain_community.vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearchSettings

class langchain_community.vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearchSettings(endpoint: str, instance_id: str, username: str, password: str, table_name: str, field_name_mapping: Dict[str, str], protocol: str = 'http', namespace: str = '', embedding_field_separator: str = ',', output_fields: Optional[List[str]] = None)[源代码]

阿里云 OpenSearch 客户端配置。

属性
endpoint (str)OpenSearch 实例的端点，您可以在阿里云 OpenSearch 控制台中找到。

instance_id (str)OpenSearch 实例的标识，您可以在阿里云 OpenSearch 控制台中找到。

username (str) : 购买实例时指定的用户名。

password (str) : 购买实例时指定的密码。

创建实例后，您可以在控制台中修改这些信息。

tablename (str): 实例配置期间指定的表名。

{

field_name_mapping (Dict): 使用 OpenSearch 索引存储和 OpenSearch 实例配置表字段名之间的字段名映射。

'id': '索引文档的 ID 字段映射', 'document': '索引文档的文本字段映射', 'embedding': '在 OpenSearch 实例的嵌入字段中，值必须为浮点型，并使用分隔符分隔，默认为逗号。

'metadata_field_x': '元数据字段映射包括映射值中的映射字段名和运算符，映射字段名和运算符之间用逗号分隔。',

protocol (str): SDK 和服务器之间的通信协议，默认为 http。

namespace (str): 根据实例数据将根据 "namespace" 字段进行分区。

如果启用命名空间，则在初始化期间需要指定命名空间字段名称，否则查询无法正确执行。

embedding_field_separator(str): 写入向量的指定分隔符。

字段数据，默认为逗号。

output_fields：指定在调用 OpenSearch 时返回的字段列表，

默认为字段映射字段值列表。

方法

__init__(endpoint, instance_id, username, ...)

参数

  • endpoint (str) –

  • instance_id (str) –

  • username (str) –

  • password (str) –

  • table_name (str) –

  • field_name_mapping (Dict[str, str]) –

  • protocol (str) –

  • namespace (str) –

  • embedding_field_separator (str) –

  • output_fields (Optional[List[str]]) –

__init__(endpoint: str, instance_id: str, username: str, password: str, table_name: str, field_name_mapping: Dict[str, str], protocol: str = 'http', namespace: str = '', embedding_field_separator: str = ',', output_fields: Optional[List[str]] = None) → None[source]
参数

  • endpoint (str) –

  • instance_id (str) –

  • username (str) –

  • password (str) –

  • table_name (str) –

  • field_name_mapping (Dict[str, str]) –

  • protocol (str) –

  • namespace (str) –

  • embedding_field_separator (str) –

  • output_fields (Optional[List[str]]) –

返回类型

None

使用 AlibabaCloudOpenSearchSettings 的示例