langchain_elasticsearch.embeddings.ElasticsearchEmbeddings

class langchain_elasticsearch.embeddings.ElasticsearchEmbeddings(client: MlClient, model_id: str, *, input_field: str = 'text_field')[source]

Elasticsearch 嵌入模型。

此类提供了一个接口，用于使用部署在 Elasticsearch 集群中的模型生成嵌入。它需要 Elasticsearch 连接对象和部署在集群中的模型的 model_id。

在 Elasticsearch 中，您需要加载和部署嵌入模型。 - https://elastic.ac.cn/guide/en/elasticsearch/reference/current/infer-trained-model.html - https://elastic.ac.cn/guide/en/machine-learning/current/ml-nlp-deploy-models.html

初始化 ElasticsearchEmbeddings 实例。

参数

  • client (MlClient) – Elasticsearch ML 客户端对象。

  • model_id (str) – 部署在 Elasticsearch 集群中的模型的 model_id。

  • input_field (str) – 文档中输入文本字段的键名。默认为 ‘text_field’。

方法

__init__(client, model_id, *[, input_field])

初始化 ElasticsearchEmbeddings 实例。

aembed_documents(texts)

异步嵌入搜索文档。

aembed_query(text)

异步嵌入查询文本。

embed_documents(texts)

为文档列表生成嵌入。

embed_query(text)

为单个查询文本生成嵌入。

from_credentials(model_id, *[, es_cloud_id, ...])

从 Elasticsearch 凭据实例化嵌入。

from_es_connection(model_id, es_connection)

从现有的 Elasticsearch 连接实例化嵌入。
__init__(client: MlClient, model_id: str, *, input_field: str = 'text_field')[source]

初始化 ElasticsearchEmbeddings 实例。

参数

  • client (MlClient) – Elasticsearch ML 客户端对象。

  • model_id (str) – 部署在 Elasticsearch 集群中的模型的 model_id。

  • input_field (str) – 文档中输入文本字段的键名。默认为 ‘text_field’。

async aembed_documents(texts: List[str]) → List[List[float]]

异步嵌入搜索文档。

参数

texts (List[str]) – 要嵌入的文本列表。

返回值

嵌入列表。

返回类型

List[List[float]]

async aembed_query(text: str) → List[float]

异步嵌入查询文本。

参数

text (str) – 要嵌入的文本。

返回值

嵌入。

返回类型

List[float]

embed_documents(texts: List[str]) → List[List[float]][source]

为文档列表生成嵌入。

参数

texts (List[str]) – 用于生成嵌入的文档文本字符串列表。

返回值

嵌入列表，输入列表中的每个文档对应一个嵌入。

列表。

返回类型

List[List[float]]

embed_query(text: str) → List[float][source]

为单个查询文本生成嵌入。

参数

text (str) – 用于生成嵌入的查询文本。

返回值

输入查询文本的嵌入。

返回类型

List[float]

classmethod from_credentials(model_id: str, *, es_cloud_id: Optional[str] = None, es_api_key: Optional[str] = None, input_field: str = 'text_field') → ElasticsearchEmbeddings[source]

从 Elasticsearch 凭据实例化嵌入。

参数

  • model_id (str) – 部署在 Elasticsearch 集群中的模型的 model_id。

  • input_field (str) – 文档中输入文本字段的键名。默认为 ‘text_field’。

  • es_cloud_id (Optional[str]) – (str, optional): 要连接的 Elasticsearch 云 ID。

  • es_user – (str, optional): Elasticsearch 用户名。

  • es_password – (str, optional): Elasticsearch 密码。

  • es_api_key (Optional[str]) –

返回类型

ElasticsearchEmbeddings

示例

from langchain_elasticserach.embeddings import ElasticsearchEmbeddings

# Define the model ID and input field name (if different from default)
model_id = "your_model_id"
# Optional, only if different from 'text_field'
input_field = "your_input_field"

# Credentials can be passed in two ways. Either set the env vars
# ES_CLOUD_ID, ES_USER, ES_PASSWORD and they will be automatically
# pulled in, or pass them in directly as kwargs.
embeddings = ElasticsearchEmbeddings.from_credentials(
    model_id,
    input_field=input_field,
    # es_cloud_id="foo",
    # es_user="bar",
    # es_password="baz",
)

documents = [
    "This is an example document.",
    "Another example document to generate embeddings for.",
]
embeddings_generator.embed_documents(documents)
classmethod from_es_connection(model_id: str, es_connection: Elasticsearch, input_field: str = 'text_field') → ElasticsearchEmbeddings[source]

从现有的 Elasticsearch 连接实例化嵌入。

此方法提供了一种使用现有 Elasticsearch 连接创建 ElasticsearchEmbeddings 类实例的方法。连接对象用于创建 MlClient，然后 MlClient 用于初始化 ElasticsearchEmbeddings 实例。

Args: model_id (str): 部署在 Elasticsearch 集群中的模型的 model_id。 es_connection (elasticsearch.Elasticsearch): 现有的 Elasticsearch 连接对象。 input_field (str, optional): 文档中输入文本字段的键名。默认为 ‘text_field’。

Returns: ElasticsearchEmbeddings: ElasticsearchEmbeddings 类的实例。

示例

from elasticsearch import Elasticsearch

from langchain_elasticsearch.embeddings import ElasticsearchEmbeddings

# Define the model ID and input field name (if different from default)
model_id = "your_model_id"
# Optional, only if different from 'text_field'
input_field = "your_input_field"

# Create Elasticsearch connection
es_connection = Elasticsearch(
    hosts=["localhost:9200"], http_auth=("user", "password")
)

# Instantiate ElasticsearchEmbeddings using the existing connection
embeddings = ElasticsearchEmbeddings.from_es_connection(
    model_id,
    es_connection,
    input_field=input_field,
)

documents = [
    "This is an example document.",
    "Another example document to generate embeddings for.",
]
embeddings_generator.embed_documents(documents)
参数

  • model_id (str) –

  • es_connection (Elasticsearch) –

  • input_field (str) –

返回类型

ElasticsearchEmbeddings