以编程方式使用文档

> Databricks Lakehouse 平台将数据、分析和 AI 统一在一个平台上。

本指南提供了快速入门 DatabricksEmbeddings 嵌入模型的快速概览。如需查看所有 DatabricksEmbeddings 功能和配置的详细文档,请前往 API 参考.

概述

集成详情

DatabricksEmbeddingsdatabricks-langchain

支持的方法

DatabricksEmbeddings 支持所有 Embeddings 类的方法,包括异步 API。

端点要求

服务端点 DatabricksEmbeddings wraps must have OpenAI-compatible embedding input/output format (参考)。只要输入格式兼容, DatabricksEmbeddings 可用于托管在 Databricks 模型服务:

1. 基础模型 - 精选的最先进基础模型列表,例如 BAAI 通用嵌入 (BGE)。这些端点已准备好在您的 Databricks 工作区中使用,无需任何设置。 2. 自定义模型 - 您还可以通过 MLflow 将自定义嵌入模型部署到服务端点 使用您选择的框架,如 LangChain、Pytorch、Transformers 等。 3. 外部模型 - Databricks 端点可以作为代理来服务托管在 Databricks 外部的模型,如 OpenAI text-embedding-3 等专有模型服务。

设置

要访问 Databricks 模型,您需要创建一个 Databricks 账户、设置凭据(仅在 Databricks 工作区外部时才需要),并安装所需的包。

凭据(仅在 Databricks 外部时)

如果您在 Databricks 内运行 LangChain 应用,则可以跳过此步骤。

否则,您需要手动将 Databricks 工作区主机名和个人访问令牌分别设置为 DATABRICKS_HOSTDATABRICKS_TOKEN 环境变量。请参阅 身份验证文档 了解如何获取访问令牌。

os.environ["DATABRICKS_HOST"] = "https://your-workspace.cloud.databricks.com"
if "DATABRICKS_TOKEN" not in os.environ:
    os.environ["DATABRICKS_TOKEN"] = getpass.getpass(
        "Enter your Databricks access token: "
    )

安装

LangChain Databricks 集成位于 databricks-langchain package:

pip install -qU databricks-langchain

实例化

from databricks_langchain import DatabricksEmbeddings

embeddings = DatabricksEmbeddings(
    endpoint="databricks-bge-large-en",
    # Specify parameters for embedding queries and documents if needed
    # query_params={...},
    # document_params={...},
)

索引和检索

嵌入模型常用于检索增强生成 (RAG) 流程,既可用于索引数据,也可用于后续检索。如需详细说明,请参阅我们的 RAG 教程.

下面,请查看如何使用上面初始化的 embeddings 对象来索引和检索数据。在此示例中,我们将在 InMemoryVectorStore.

# Create a vector store with a sample text
from langchain_core.vectorstores import InMemoryVectorStore

text = "LangChain is the framework for building context-aware reasoning applications"

vectorstore = InMemoryVectorStore.from_texts(
    [text],
    embedding=embeddings,
)

# Use the vectorstore as a retriever
retriever = vectorstore.as_retriever()

# Retrieve the most similar text
retrieved_document = retriever.invoke("What is LangChain?")

# show the retrieved document's content
retrieved_document[0].page_content

直接使用

在底层,向量存储和检索器实现调用了 embeddings.embed_documents(...)embeddings.embed_query(...) 来为 from_texts 和检索 invoke 操作,分别。

您可以直接调用这些方法来获取嵌入向量以满足您的使用场景。

嵌入单个文本

您可以使用以下方式嵌入单个文本或文档 embed_query:

single_vector = embeddings.embed_query(text)
print(str(single_vector)[:100])  # Show the first 100 characters of the vector

嵌入多个文本

您可以使用以下方式嵌入多个文本 embed_documents:

text2 = (
    "LangGraph is a library for building stateful, multi-actor applications with LLMs"
)
two_vectors = embeddings.embed_documents([text, text2])
for vector in two_vectors:
    print(str(vector)[:100])  # Show the first 100 characters of the vector

异步用法

您也可以使用 aembed_queryaembed_documents 来异步生成嵌入向量:

async def async_example():
    single_vector = await embeddings.aembed_query(text)
    print(str(single_vector)[:100])  # Show the first 100 characters of the vector


asyncio.run(async_example())

API 参考

有关 DatabricksEmbeddings 功能和配置选项的详细文档,请参阅 API 参考.