Databricks嵌入

Databricks 湖库平台在一个平台上统一了数据、分析和AI。

本笔记本提供了有关如何开始使用 Databricks 嵌入模型的快速概览。有关所有 DatabricksEmbeddings 功能和配置的详细文档，请访问API 参考。

概览

集成细节

Class	包
DatabricksEmbeddings	databricks-langchain

Supported Methods

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

Endpoint 要求

该服务端点 DatabricksEmbeddings 包装的必须具有与 OpenAI 兼容的嵌入输入/输出格式（参考）。只要输入格式兼容，DatabricksEmbeddings 可用于托管在 Databricks 模型服务 上的任何端点类型：

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

设置

要访问Databricks模型，您需要创建一个Databricks账户、设置凭据（如果您在Databricks工作区之外，请仅在此步骤操作）并安装所需的包。

Credentials（仅如果您在Databricks之外）

如果您在Databricks中运行LangChain应用，请跳过此步骤。

否则，您需要手动设置 Databricks 工作空间主机名和个人访问令牌环境变量分别为 DATABRICKS_HOST 和 DATABRICKS_TOKEN。有关获取访问令牌的方法，请参阅 认证文档。

import getpass
import os

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 包中：

%pip install -qU databricks-langchain

Instantiation

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

API 参考:内存向量存储

直接使用​

在底层，向量存储和检索器实现会调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...) 分别为用于 from_texts 和检索 invoke 操作的文本生成嵌入。

您可以直接调用这些方法，以获取适用于您自身用例的嵌入（embeddings）。

嵌入单个文本​

您可以使用 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

Async Usage

您也可以使用 aembed_query 和 aembed_documents 来异步生成嵌入（embeddings）：

import asyncio


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 参考。

相关

• 嵌入模型 概念指南
• 嵌入模型 使用指南