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)[source]

阿里云 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 时指定返回的字段列表，默认为字段映射字段的值列表。

Methods

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

Parameters

  • 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]]) –

Return type

None

__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]
Parameters

  • 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]]) –

Return type

None

Examples using AlibabaCloudOpenSearchSettings