此组件计算的向量对于对文档集合执行 embedding 检索是必需的。在检索时，代表查询的向量将与文档的向量进行比较，以找到最相似或最相关的文档。


pipeline 中的最常见位置	在索引管道中的 `DocumentWriter` 之前
必需的初始化变量	"api_key": OpenAI API 密钥。可以使用`OPENAI_API_KEY` 环境变量设置。
强制运行变量	"documents": 文档列表
输出变量	"documents": 文档列表（已添加 embedding） "meta": 元数据字典
API 参考	Embedders (嵌入器)
GitHub 链接	https://github.com/deepset-ai/haystack/blob/main/haystack/components/embedders/openai_document_embedder.py

概述

要查看兼容的 OpenAI 嵌入模型列表，请访问 OpenAI 的文档。默认模型是OpenAIDocumentEmbeddertext-embedding-ada-002。您可以通过model 参数指定其他模型。

此组件用于嵌入文档列表。要嵌入单个字符串，请使用 OpenAITextEmbedder。

该组件默认使用OPENAI_API_KEY 环境变量，默认为此。否则，您可以在初始化时使用api_key:

embedder = OpenAIDocumentEmbedder(api_key=Secret.from_token("<your-api-key>"))

Embedding 元数据

文本文档通常附带一组元数据。如果它们具有辨识度和语义意义，您可以将它们与文档文本一起 embedding，以提高检索效果。

您可以通过使用 Document Embedder 轻松做到这一点

from haystack import Document
from haystack.components.embedders import OpenAIDocumentEmbedder

doc = Document(content="some text",meta={"title": "relevant title", "page number": 18})

embedder = OpenAIDocumentEmbedder(meta_fields_to_embed=["title"])

docs_w_embeddings = embedder.run(documents=[doc])["documents"]

用法

单独使用

以下是独立使用该组件的方法：

from haystack.components.embedders import OpenAIDocumentEmbedder

doc = Document(content="I love pizza!")

document_embedder = OpenAIDocumentEmbedder(api_key=Secret.from_token("<your-api-key>"))

result = document_embedder.run([doc])
print(result['documents'][0].embedding)

# [0.017020374536514282, -0.023255806416273117, ...]

📘
我们建议将 OPENAI_API_KEY 设置为环境变量，而不是将其作为参数进行设置。

在 pipeline 中

from haystack import Pipeline
from haystack.document_stores.in_memory import InMemoryDocumentStore
from haystack.components.embedders import OpenAITextEmbedder, OpenAIDocumentEmbedder
from haystack.components.writers import DocumentWriter
from haystack.components.retrievers.in_memory import InMemoryEmbeddingRetriever

document_store = InMemoryDocumentStore(embedding_similarity_function="cosine")

documents = [Document(content="My name is Wolfgang and I live in Berlin"),
             Document(content="I saw a black horse running"),
             Document(content="Germany has many big cities")]

indexing_pipeline = Pipeline()
indexing_pipeline.add_component("embedder", OpenAIDocumentEmbedder())
indexing_pipeline.add_component("writer", DocumentWriter(document_store=document_store))
indexing_pipeline.connect("embedder", "writer")

indexing_pipeline.run({"embedder": {"documents": documents}})

query_pipeline = Pipeline()
query_pipeline.add_component("text_embedder", OpenAITextEmbedder())
query_pipeline.add_component("retriever", InMemoryEmbeddingRetriever(document_store=document_store))
query_pipeline.connect("text_embedder.embedding", "retriever.query_embedding")

query = "Who lives in Berlin?"

result = query_pipeline.run({"text_embedder":{"text": query}})

print(result['retriever']['documents'][0])

# Document(id=..., mimetype: 'text/plain', 
#  text: 'My name is Wolfgang and I live in Berlin')