langchain_community.vectorstores.databricks_vector_search.DatabricksVectorSearch

class langchain_community.vectorstores.databricks_vector_search.DatabricksVectorSearch(index: VectorSearchIndex, *, embedding: Optional[Embeddings] = None, text_column: Optional[str] = None, columns: Optional[List[str]] = None)[source]

Databricks Vector Search 向量存储。

要使用，应安装 databricks-vectorsearch python 包。

示例:
from langchain_community.vectorstores import DatabricksVectorSearch
from databricks.vector_search.client import VectorSearchClient

vs_client = VectorSearchClient()
vs_index = vs_client.get_index(
  endpoint_name="vs_endpoint",
  index_name="ml.llm.index"
)
vectorstore = DatabricksVectorSearch(vs_index)
参数:

index: 一个 Databricks Vector Search 索引对象。 embedding: 嵌入模型。

对于直接访问索引或具有自管理嵌入的增量同步索引，需要。

text_column: 用于嵌入的文本列的名称。

对于直接访问索引或具有自管理嵌入的增量同步索引，需要。 确保指定的文本列在索引中。

columns: 在进行搜索时要获取的列名列表。

默认为 [primary_key, text_column]。

具有由 Databricks 管理的嵌入的增量同步索引会为您管理摄入、删除和嵌入。 不支持手动摄入/删除文档/文本以用于增量同步索引。

如果要使用具有自管理嵌入的增量同步索引，需要提供嵌入模型和要用于嵌入的文本列名称。

示例:
from langchain_community.vectorstores import DatabricksVectorSearch
from databricks.vector_search.client import VectorSearchClient
from langchain_community.embeddings.openai import OpenAIEmbeddings

vs_client = VectorSearchClient()
vs_index = vs_client.get_index(
  endpoint_name="vs_endpoint",
  index_name="ml.llm.index"
)
vectorstore = DatabricksVectorSearch(
  index=vs_index,
  embedding=OpenAIEmbeddings(),
  text_column="document_content"
)

如果要自行管理文档的摄入/删除，可以使用直接访问索引。

示例:
from langchain_community.vectorstores import DatabricksVectorSearch
from databricks.vector_search.client import VectorSearchClient
from langchain_community.embeddings.openai import OpenAIEmbeddings

vs_client = VectorSearchClient()
vs_index = vs_client.get_index(
  endpoint_name="vs_endpoint",
  index_name="ml.llm.index"
)
vectorstore = DatabricksVectorSearch(
  index=vs_index,
  embedding=OpenAIEmbeddings(),
  text_column="document_content"
)
vectorstore.add_texts(
  texts=["text1", "text2"]
)

有关 Databricks Vector Search 的更多信息，请参阅 `Databricks Vector Search 文档: https://docs.databricks.com/en/generative-ai/vector-search.html.

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

__init__(index, *[, embedding, text_column, ...])

aadd_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

aadd_texts(texts[, metadatas])

运行更多的文本通过嵌入，并添加到向量存储中。

add_documents(documents, **kwargs)

运行更多的文档通过嵌入并添加到向量存储中。

add_texts(texts[, metadatas, ids])

将文本添加到索引中。

adelete([ids])

根据向量ID或其他条件进行删除。

afrom_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

afrom_texts(texts, embedding[, metadatas])

返回从文本和嵌入初始化的VectorStore。

amax_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

amax_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

as_retriever(**kwargs)

返回从此VectorStore初始化的VectorStoreRetriever。

asearch(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

asimilarity_search(query[, k])

返回与查询最相似的文档。

asimilarity_search_by_vector(embedding[, k])

返回与嵌入向量最相似的文档。

asimilarity_search_with_relevance_scores(query)

返回文档和相关性分数在范围[0, 1]内，异步执行。

asimilarity_search_with_score(*args, **kwargs)

使用异步方式运行相似性搜索与距离。

delete([ids])

从索引中删除文档。

from_documents(documents, embedding, **kwargs)

返回从文档和嵌入初始化的VectorStore。

from_texts(texts, embedding[, metadatas])

返回从文本和嵌入初始化的VectorStore。

max_marginal_relevance_search(query[, k, ...])

返回使用最大边际相关性选择的文档。

max_marginal_relevance_search_by_vector(...)

返回使用最大边际相关性选择的文档。

search(query, search_type, **kwargs)

返回使用指定搜索类型的查询最相似的文档。

similarity_search(query[, k, filters])

返回与查询最相似的文档。

similarity_search_by_vector(embedding[, k, ...])

返回与嵌入向量最相似的文档。

similarity_search_by_vector_with_score(embedding)

返回与嵌入向量最相似的文档，以及相似度分数。

similarity_search_with_relevance_scores(query)

返回文档和相关性得分在[0, 1]范围内。

similarity_search_with_score(query[, k, filters])

返回与查询最相似的文档，以及分数。
Parameters

  • index (VectorSearchIndex) –

  • embedding (Optional[Embeddings]) –

  • text_column (Optional[str]) –

  • columns (Optional[List[str]]) –

__init__(index: VectorSearchIndex, *, embedding: Optional[Embeddings] = None, text_column: Optional[str] = None, columns: Optional[List[str]] = None)[source]
Parameters

  • index (VectorSearchIndex) –

  • embedding (Optional[Embeddings]) –

  • text_column (Optional[str]) –

  • columns (Optional[List[str]]) –

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]

运行更多的文本通过嵌入，并添加到向量存储中。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]

运行更多的文档通过嵌入并添加到向量存储中。

参数:

documents (List[Document]): 要添加到向量存储中的文档。

返回:

List[str]: 添加的文本的ID列表。

Parameters

  • documents (List[Document]) –

  • kwargs (Any) –

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, ids: Optional[List[Any]] = None, **kwargs: Any) → List[str][source]

将文本添加到索引中。

仅支持直接访问索引。

参数：

texts：要添加的文本列表。 metadatas：每个文本的元数据列表。默认为None。 ids：每个文本的id列表。默认为None。

如果未提供，则将为每个文本生成一个随机uuid。

返回：

将文本添加到索引后的id列表。

Parameters

  • texts (Iterable[str]) –

  • metadatas (Optional[List[dict]]) –

  • ids (Optional[List[Any]]) –

  • kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]

根据向量ID或其他条件进行删除。

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

  • ids (Optional[List[str]]) –

  • kwargs (Any) –

Return type

Optional[bool]

async classmethod afrom_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST

返回从文本和嵌入初始化的VectorStore。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

VST

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

async amax_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]

返回使用最大边际相关性选择的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

参数：
search_type（可选[str]）：定义Retriever应执行的搜索类型。

可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。

search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：

k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)
Parameters

kwargs (Any) –

Return type

VectorStoreRetriever

async asearch(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

返回与查询最相似的文档。

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]

返回与嵌入向量最相似的文档。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性分数在范围[0, 1]内，异步执行。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似度分数）的列表

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]

使用异步方式运行相似性搜索与距离。

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

delete(ids: Optional[List[Any]] = None, **kwargs: Any) → Optional[bool][source]

从索引中删除文档。

仅支持直接访问索引。

参数：

ids: 要删除的文档的id列表。

返回：

如果成功则返回True。

Parameters

  • ids (Optional[List[Any]]) –

  • kwargs (Any) –

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST

返回从文档和嵌入初始化的VectorStore。

Parameters
Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST[source]

返回从文本和嵌入初始化的VectorStore。

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

  • metadatas (Optional[List[dict]]) –

  • kwargs (Any) –

Return type

VST

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。 filters：要应用于查询的过滤器。默认为无。

返回：

由最大边际相关性选择的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filters: Optional[Any] = None, **kwargs: Any) → List[Document][source]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：

embedding: 用于查找类似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取的文档数量以传递给MMR算法。 lambda_mult: 0到1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 filters: 要应用于查询的过滤器。默认为无。

返回：

通过最大边际相关性选择的文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]

返回使用指定搜索类型的查询最相似的文档。

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

返回与查询最相似的文档。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filters：要应用于查询的过滤器。默认为None。

返回：

与嵌入最相似的文档列表。

Parameters

  • query (str) –

  • k (int) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filters: Optional[Any] = None, **kwargs: Any) → List[Document][source]

返回与嵌入向量最相似的文档。

参数:

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filters: 要应用于查询的过滤器。默认为None。

返回:

与嵌入最相似的文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector_with_score(embedding: List[float], k: int = 4, filters: Optional[Any] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与嵌入向量最相似的文档，以及相似度分数。

参数：

embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 filters：要应用于查询的过滤器。默认为None。

返回：

返回与嵌入最相似的文档列表，以及每个文档的分数。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]

返回文档和相关性得分在[0, 1]范围内。

0表示不相似，1表示最相似。

参数：

query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集

返回：

元组列表（doc，相似性得分）

Parameters

  • query (str) –

  • k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filters: Optional[Any] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

返回与查询最相似的文档，以及分数。

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 filters：要应用于查询的过滤器。默认为None。

返回：

返回与嵌入最相似的文档列表，以及每个文档的分数。

Parameters

  • query (str) –

  • k (int) –

  • filters (Optional[Any]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using DatabricksVectorSearch