阿里云开放搜索设置#
- 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: List[str] | None = None)[source]#
阿里云Opensearch客户端配置。
- Attribute:
- endpoint (str)The endpoint of opensearch instance, You can find it
来自阿里云OpenSearch的控制台。
- instance_id (str)The identify of opensearch instance, You can find
它来自阿里云OpenSearch的控制台。
用户名 (str) : 购买实例时指定的用户名。 密码 (str) : 购买实例时指定的密码,
实例创建后,您可以在控制台上对其进行修改。
tablename (str): 实例配置期间指定的表名。 field_name_mapping (Dict): 在opensearch之间使用字段名称映射
向量存储和OpenSearch实例配置表字段名称:
- {
‘id’: ‘索引文档的id字段名称映射。’, ‘document’: ‘索引文档的文本字段名称映射。’, ‘embedding’: ‘在opensearch实例的embedding字段中,
值必须是浮点类型,并用分隔符分隔,默认是逗号。
- ‘metadata_field_x’: ‘Metadata field mapping includes the mapped
映射值中的字段名称和操作符,映射字段名称和操作符之间用逗号分隔。
} protocol (str): SDK与服务器之间的通信协议,默认为http。 namespace (str): 实例数据将根据“namespace”进行分区
字段,如果启用了命名空间,您需要在初始化期间指定命名空间字段名称,否则查询将无法正确执行。
- embedding_field_separator(str): Delimiter specified for writing vector
字段数据,默认为逗号。
- output_fields: Specify the field list returned when invoking OpenSearch,
默认情况下,它是字段映射字段的值列表。
方法
__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)
命名空间 (字符串)
embedding_field_separator (str)
output_fields (List[str] | 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: List[str] | None = None) None [来源]#
- Parameters:
endpoint (str)
instance_id (str)
username (str)
password (str)
table_name (str)
field_name_mapping (Dict[str, str])
protocol (str)
命名空间 (字符串)
embedding_field_separator (str)
output_fields (List[str] | None)
- Return type:
无
使用 AlibabaCloudOpenSearchSettings 的示例