langchain_community.vectorstores.tiledb.TileDB

class langchain_community.vectorstores.tiledb.TileDB(embedding: Embeddings, index_uri: str, metric: str, *, vector_index_uri: str = '', docs_array_uri: str = '', config: Optional[Mapping[str, Any]] = None, timestamp: Any = None, allow_dangerous_deserialization: bool = False, **kwargs: Any)[source]

TileDB向量存储。

要使用,您应该已安装``tiledb-vector-search`` python包。

示例:
from langchain_community import TileDB
embeddings = OpenAIEmbeddings()
db = TileDB(embeddings, index_uri, metric)

初始化必要组件。

参数:
allow_dangerous_deserialization: 是否允许反序列化数据,涉及使用pickle加载数据。

数据可能被恶意用户修改,以传递恶意有效负载,导致在您的计算机上执行任意代码。

Attributes

embeddings

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

Methods

__init__(embedding, index_uri, metric, *[, ...])

初始化必要组件。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas, ids, timestamp])

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

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)

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

consolidate_updates(**kwargs)

create(index_uri, index_type, dimensions, ...)

delete([ids, timestamp])

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

from_documents(documents, embedding, **kwargs)

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

from_embeddings(text_embeddings, embedding, ...)

从嵌入构建TileDB索引。

from_texts(texts, embedding[, metadatas, ...])

从原始文档构建TileDB索引。

load(index_uri, embedding, *[, metric, ...])

从URI加载TileDB索引。

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

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

max_marginal_relevance_search_by_vector(...)

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

max_marginal_relevance_search_with_score_by_vector(...)

使用最大边际相关性返回选定的文档及其相似性分数。

process_index_results(ids, scores, *[, k, ...])

将TileDB的结果转换为文档列表和分数列表。

search(query, search_type, **kwargs)

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

similarity_search(query[, k, filter, fetch_k])

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

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

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

similarity_search_with_relevance_scores(query)

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

similarity_search_with_score(query, *[, k, ...])

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

similarity_search_with_score_by_vector(...)

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

Parameters
  • embedding (Embeddings) –

  • index_uri (str) –

  • metric (str) –

  • vector_index_uri (str) –

  • docs_array_uri (str) –

  • config (Optional[Mapping[str, Any]]) –

  • timestamp (Any) –

  • allow_dangerous_deserialization (bool) –

  • kwargs (Any) –

__init__(embedding: Embeddings, index_uri: str, metric: str, *, vector_index_uri: str = '', docs_array_uri: str = '', config: Optional[Mapping[str, Any]] = None, timestamp: Any = None, allow_dangerous_deserialization: bool = False, **kwargs: Any)[source]

初始化必要组件。

参数:
allow_dangerous_deserialization: 是否允许反序列化数据,涉及使用pickle加载数据。

数据可能被恶意用户修改,以传递恶意有效负载,导致在您的计算机上执行任意代码。

Parameters
  • embedding (Embeddings) –

  • index_uri (str) –

  • metric (str) –

  • vector_index_uri (str) –

  • docs_array_uri (str) –

  • config (Optional[Mapping[str, Any]]) –

  • timestamp (Any) –

  • allow_dangerous_deserialization (bool) –

  • kwargs (Any) –

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[str]] = None, timestamp: int = 0, **kwargs: Any) List[str][source]

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

参数:

texts:要添加到向量存储的字符串的可迭代对象。 metadatas:与文本相关的元数据的可选列表。 ids:每个文本对象的可选id。 timestamp:写入新文本的可选时间戳。 kwargs:向量存储特定参数

返回:

将文本添加到向量存储中的id列表。

Parameters
  • texts (Iterable[str]) –

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

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

  • timestamp (int) –

  • 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]]

consolidate_updates(**kwargs: Any) None[source]
Parameters

kwargs (Any) –

Return type

None

classmethod create(index_uri: str, index_type: str, dimensions: int, vector_type: dtype, *, metadatas: bool = True, config: Optional[Mapping[str, Any]] = None) None[source]
Parameters
  • index_uri (str) –

  • index_type (str) –

  • dimensions (int) –

  • vector_type (dtype) –

  • metadatas (bool) –

  • config (Optional[Mapping[str, Any]]) –

Return type

None

delete(ids: Optional[List[str]] = None, timestamp: int = 0, **kwargs: Any) Optional[bool][source]

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

参数:

ids:要删除的ID列表。 timestamp:可选的时间戳以删除。 **kwargs:子类可能使用的其他关键字参数。

返回:

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

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

  • timestamp (int) –

  • kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters
Return type

VST

classmethod from_embeddings(text_embeddings: List[Tuple[str, List[float]]], embedding: Embeddings, index_uri: str, *, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, metric: str = 'euclidean', index_type: str = 'FLAT', config: Optional[Mapping[str, Any]] = None, index_timestamp: int = 0, **kwargs: Any) TileDB[source]

从嵌入构建TileDB索引。

参数:

text_embeddings:包含(文本,嵌入)元组的列表 embedding:要使用的嵌入函数。 index_uri:要写入TileDB数组的URI metadatas:要与文档关联的元数据字典列表。 metric:可选,用于索引的度量。默认为”euclidean”。 index_type:可选,向量索引类型(”FLAT”,IVF_FLAT”) config:可选,TileDB配置 index_timestamp:可选,用于写入新文本的时间戳。

示例:
from langchain_community import TileDB
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
text_embeddings = embeddings.embed_documents(texts)
text_embedding_pairs = list(zip(texts, text_embeddings))
db = TileDB.from_embeddings(text_embedding_pairs, embeddings)
Parameters
  • text_embeddings (List[Tuple[str, List[float]]]) –

  • embedding (Embeddings) –

  • index_uri (str) –

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

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

  • metric (str) –

  • index_type (str) –

  • config (Optional[Mapping[str, Any]]) –

  • index_timestamp (int) –

  • kwargs (Any) –

Return type

TileDB

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, metric: str = 'euclidean', index_uri: str = '/tmp/tiledb_array', index_type: str = 'FLAT', config: Optional[Mapping[str, Any]] = None, index_timestamp: int = 0, **kwargs: Any) TileDB[source]

从原始文档构建TileDB索引。

参数:

texts:要索引的文档列表。 embedding:要使用的嵌入函数。 metadatas:要与文档关联的元数据字典列表。 ids:每个文本对象的可选ID。 metric:用于索引的度量。默认为”euclidean”。 index_uri:要写入TileDB数组的URI。 index_type:可选,向量索引类型(”FLAT”,IVF_FLAT”)。 config:可选,TileDB配置。 index_timestamp:可选,用于写入新文本的时间戳。

示例:
from langchain_community import TileDB
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
index = TileDB.from_texts(texts, embeddings)
Parameters
  • texts (List[str]) –

  • embedding (Embeddings) –

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

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

  • metric (str) –

  • index_uri (str) –

  • index_type (str) –

  • config (Optional[Mapping[str, Any]]) –

  • index_timestamp (int) –

  • kwargs (Any) –

Return type

TileDB

classmethod load(index_uri: str, embedding: Embeddings, *, metric: str = 'euclidean', config: Optional[Mapping[str, Any]] = None, timestamp: Any = None, **kwargs: Any) TileDB[source]

从URI加载TileDB索引。

参数:

index_uri:TileDB向量索引的URI。 embedding:生成查询时要使用的嵌入。 metric:可选,用于索引的度量。默认为”euclidean”。 config:可选的TileDB配置。 timestamp:可选的时间戳,用于打开数组。

Parameters
  • index_uri (str) –

  • embedding (Embeddings) –

  • metric (str) –

  • config (Optional[Mapping[str, Any]]) –

  • timestamp (Any) –

  • kwargs (Any) –

Return type

TileDB

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

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

参数:

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) –

  • filter (Optional[Dict[str, 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, filter: Optional[Dict[str, Any]] = None, **kwargs: Any) List[Document][source]

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

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

参数:

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

返回:

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

Parameters
  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Document]

max_marginal_relevance_search_with_score_by_vector(embedding: List[float], *, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Optional[Dict[str, Any]] = None, **kwargs: Any) List[Tuple[Document, float]][source]

使用最大边际相关性返回选定的文档及其相似性分数。

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

参数:

embedding:要查找相似文档的嵌入。 k:要返回的文档数量。默认为4。 fetch_k:在过滤到MMR算法之前要获取的文档数量。 lambda_mult:介于0和1之间的数字,确定结果之间多样性的程度,其中0对应于最大多样性,1对应于最小多样性。默认为0.5。

返回:

通过最大边际相关性选择的文档和相似性分数的列表,以及每个文档的分数。

Parameters
  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

  • filter (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

process_index_results(ids: List[int], scores: List[float], *, k: int = 4, filter: Optional[Dict[str, Any]] = None, score_threshold: float = 1.7976931348623157e+308) List[Tuple[Document, float]][source]

将TileDB的结果转换为文档列表和分数列表。

参数:

ids:文档在索引中的索引列表。 scores:文档在索引中的距离列表。 k:要返回的文档数量。默认为4。 filter(可选[Dict[str, Any]]):按元数据筛选。默认为None。 score_threshold:可选,一个浮点值,用于过滤检索到的文档集。

返回:

文档和分数的列表。

Parameters
  • ids (List[int]) –

  • scores (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • score_threshold (float) –

Return type

List[Tuple[Document, float]]

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。 filter: (可选[Dict[str, str]]):按元数据筛选。默认为None。 fetch_k: (可选[int])在过滤之前要获取的文档数量。

默认为20。

返回:

与查询最相似的文档列表。

Parameters
  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • fetch_k (int) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, Any]] = None, fetch_k: int = 20, **kwargs: Any) List[Document][source]

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

参数:

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter(可选[Dict[str, str]]):按元数据过滤。默认为None。 fetch_k: (可选[int])在过滤之前要获取的文档数量。

默认为20。

返回:

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

Parameters
  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • fetch_k (int) –

  • kwargs (Any) –

Return type

List[Document]

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, filter: Optional[Dict[str, Any]] = None, fetch_k: int = 20, **kwargs: Any) List[Tuple[Document, float]][source]

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

参数:

query:要查找类似文档的文本。 k:要返回的文档数量。默认为4。 filter(可选[Dict[str,str]]):按元数据筛选。默认为无。 fetch_k:(可选[int])在过滤之前要获取的文档数量。

默认为20。

返回:

与查询文本最相似的文档列表,带有浮点距离。较低的分数表示更相似。

Parameters
  • query (str) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • fetch_k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_score_by_vector(embedding: List[float], *, k: int = 4, filter: Optional[Dict[str, Any]] = None, fetch_k: int = 20, **kwargs: Any) List[Tuple[Document, float]][source]

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

参数:

embedding: 要查找相似文档的嵌入向量。 k: 要返回的文档数量。默认为4。 filter (Optional[Dict[str, Any]]): 按元数据过滤。默认为None。 fetch_k: (Optional[int]) 在过滤之前要获取的文档数量。

默认为20。

**kwargs: 要传递给相似性搜索的kwargs。可以包括:

nprobe: 可选,如果使用IVF_FLAT索引,则要检查的分区数 score_threshold: 可选,一个浮点值,用于过滤

检索到的文档集的结果

返回:

查询文本最相似的文档列表,以及每个文档的浮点距离。较低的分数表示更相似。

Parameters
  • embedding (List[float]) –

  • k (int) –

  • filter (Optional[Dict[str, Any]]) –

  • fetch_k (int) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using TileDB