自定义嵌入
LangChain 与许多 第三方嵌入模型 集成。在本指南中，我们将向您展示如何创建自定义的 Embedding 类，以应对尚未内置相应模型的情况。嵌入在自然语言处理应用中至关重要，因为它能将文本转换为算法可理解的数值形式，从而支持多种应用，如相似性搜索、文本分类和聚类。
使用标准的 Embeddings 接口实现嵌入，将使您的嵌入能够被现有的 LangChain 抽象（例如，作为 VectorStore 的嵌入支持或使用 CacheBackedEmbeddings 缓存）所利用。
界面
LangChain 当前的 Embeddings 抽象设计用于处理文本数据。在此实现中，输入可以是单个字符串或字符串列表，输出则是数值数组（向量）列表，其中每个向量代表将输入文本映射到某个 n 维空间中的嵌入表示。
您的自定义嵌入必须实现以下方法：
| Method/Property | 描述 | Required/Optional |
|---|---|---|
embed_documents(texts) | Generates embeddings for a list of strings. | Required |
embed_query(text) | Generates an embedding for a single text query. | Required |
aembed_documents(texts) | Asynchronously generates embeddings for a list of strings. | Optional |
aembed_query(text) | Asynchronously generates an embedding for a single text query. | Optional |
这些方法可确保您的嵌入模型能够无缝集成到 LangChain 框架中，为可扩展性和性能优化提供同步和异步功能。
Embeddings 当前未实现 Runnable 接口，且也不是 pydantic BaseModel 的实例。
嵌入查询与文档
embed_query 和 embed_documents 方法是必需的。这两个方法都作用于字符串输入。由于历史原因，Document.page_content 属性的访问由向量存储使用嵌入模型来处理。
embed_query 接受一个字符串并返回一个浮点数列表形式的单一嵌入。
如果您的模型在嵌入查询和基础文档方面有不同的模式，您可以
实现此方法来处理这种情况。
embed_documents 接受一个字符串列表，并返回一个嵌入向量列表，即浮点数列表的列表。
embed_documents 接受纯文本列表，而不是 LangChain Document 对象列表。此方法的名称可能在 LangChain 的未来版本中更改。
实现
例如，我们将实现一个简单的嵌入模型，该模型返回一个常量向量。此模型仅用于演示目的。
from typing import List
from langchain_core.embeddings import Embeddings
class ParrotLinkEmbeddings(Embeddings):
"""ParrotLink embedding model integration.
# TODO: Populate with relevant params.
Key init args — completion params:
model: str
Name of ParrotLink model to use.
See full list of supported init args and their descriptions in the params section.
# TODO: Replace with relevant init params.
Instantiate:
.. code-block:: python
from langchain_parrot_link import ParrotLinkEmbeddings
embed = ParrotLinkEmbeddings(
model="...",
# api_key="...",
# other params...
)
Embed single text:
.. code-block:: python
input_text = "The meaning of life is 42"
embed.embed_query(input_text)
.. code-block:: python
# TODO: Example output.
# TODO: Delete if token-level streaming isn't supported.
Embed multiple text:
.. code-block:: python
input_texts = ["Document 1...", "Document 2..."]
embed.embed_documents(input_texts)
.. code-block:: python
# TODO: Example output.
# TODO: Delete if native async isn't supported.
Async:
.. code-block:: python
await embed.aembed_query(input_text)
# multiple:
# await embed.aembed_documents(input_texts)
.. code-block:: python
# TODO: Example output.
"""
def __init__(self, model: str):
self.model = model
def embed_documents(self, texts: List[str]) -> List[List[float]]:
"""Embed search docs."""
return [[0.5, 0.6, 0.7] for _ in texts]
def embed_query(self, text: str) -> List[float]:
"""Embed query text."""
return self.embed_documents([text])[0]
# optional: add custom async implementations here
# you can also delete these, and the base class will
# use the default implementation, which calls the sync
# version in an async executor:
# async def aembed_documents(self, texts: List[str]) -> List[List[float]]:
# """Asynchronous Embed search docs."""
# ...
# async def aembed_query(self, text: str) -> List[float]:
# """Asynchronous Embed query text."""
# ...
让我们来测试一下 🧪
embeddings = ParrotLinkEmbeddings("test-model")
print(embeddings.embed_documents(["Hello", "world"]))
print(embeddings.embed_query("Hello"))
[[0.5, 0.6, 0.7], [0.5, 0.6, 0.7]]
[0.5, 0.6, 0.7]
贡献
我们欢迎为 LangChain 代码库贡献嵌入模型。
如果您希望为新的服务提供商（例如，带有新依赖项或SDK）贡献嵌入模型，我们建议您将实现发布在单独的 langchain-* 集成包中。这将使您能够妥善管理依赖项并版本化您的包。有关此过程的详细说明，请参阅我们的 贡献指南。