`langchain_community.vectorstores.lancedb`.LanceDB¶

class langchain_community.vectorstores.lancedb.LanceDB(connection: Optional[Any] = None, embedding: Optional[Embeddings] = None, uri: Optional[str] = '/tmp/lancedb', vector_key: Optional[str] = 'vector', id_key: Optional[str] = 'id', text_key: Optional[str] = 'text', table_name: Optional[str] = 'vectorstore', api_key: Optional[str] = None, region: Optional[str] = None, mode: Optional[str] = 'overwrite')[source]¶

`LanceDB`向量存储。

要使用，您应该安装``lancedb`` python包。您可以使用``pip install lancedb``进行安装。

参数:: connection: 要使用的LanceDB连接。如果未提供，将创建一个新连接。 embedding: 用于向量存储的嵌入。 vector_key: 数据库中向量使用的键。默认为``vector``。 id_key: 数据库中id使用的键。默认为``id``。 text_key: 数据库中文本使用的键。默认为``text``。 table_name: 要使用的表的名称。默认为``vectorstore``。 api_key: 用于LanceDB云数据库的API密钥。 region: 用于LanceDB云数据库的区域。 mode: 用于向表中添加数据的模式。默认为``overwrite``。
示例:

使用Lance DB向量存储进行初始化

Attributes

embeddings

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

Methods

`__init__`([connection, embedding, uri, ...])	使用Lance DB向量存储进行初始化
`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)	使用异步方式运行相似性搜索与距离。
`create_index`([col_name, vector_col, ...])	在表上创建一个标量（用于非向量列）或向量索引。在创建索引之前，请确保您的向量列有足够的数据。
`delete`([ids, delete_all, filter, ...])	允许通过过滤、按id删除行或从表中删除列。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
`get_table`([name, set_default])	从数据库中获取一个表对象。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, name])	返回与查询最相似的文档
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(args, *kwargs)	使用距离进行相似性搜索。

Parameters

connection (Optional[Any]) –
embedding (Optional[Embeddings]) –
uri (Optional[str]) –
vector_key (Optional[str]) –
id_key (Optional[str]) –
text_key (Optional[str]) –
table_name (Optional[str]) –
api_key (Optional[str]) –
region (Optional[str]) –
mode (Optional[str]) –

__init__(connection: Optional[Any] = None, embedding: Optional[Embeddings] = None, uri: Optional[str] = '/tmp/lancedb', vector_key: Optional[str] = 'vector', id_key: Optional[str] = 'id', text_key: Optional[str] = 'text', table_name: Optional[str] = 'vectorstore', api_key: Optional[str] = None, region: Optional[str] = None, mode: Optional[str] = 'overwrite')[source]¶

使用Lance DB向量存储进行初始化

Parameters

connection (Optional[Any]) –
embedding (Optional[Embeddings]) –
uri (Optional[str]) –
vector_key (Optional[str]) –
id_key (Optional[str]) –
text_key (Optional[str]) –
table_name (Optional[str]) –
api_key (Optional[str]) –
region (Optional[str]) –
mode (Optional[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[str]] = None, **kwargs: Any) → List[str][source]¶

将文本转换为嵌入并将其添加到数据库

参数：: texts：要添加到向量存储中的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：要与文本关联的可选id列表。
返回：: 已添加文本的id列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
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

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

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

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数：: 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]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → 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]]

create_index(col_name: Optional[str] = None, vector_col: Optional[str] = None, num_partitions: Optional[int] = 256, num_sub_vectors: Optional[int] = 96, index_cache_size: Optional[int] = None, metric: Optional[str] = 'L2') → None[source]¶

在表上创建一个标量（用于非向量列）或向量索引。在创建索引之前，请确保您的向量列有足够的数据。

参数：: vector_col：如果要在向量列上创建索引，请提供。 col_name：如果要在非向量列上创建索引，请提供。 metric：提供用于向量索引的度量标准。默认为’L2’

度量标准选择：’L2’，’dot’，’cosine’
返回：: 无

Parameters

col_name (Optional[str]) –
vector_col (Optional[str]) –
num_partitions (Optional[int]) –
num_sub_vectors (Optional[int]) –
index_cache_size (Optional[int]) –
metric (Optional[str]) –

Return type

None

delete(ids: Optional[List[str]] = None, delete_all: Optional[bool] = None, filter: Optional[str] = None, drop_columns: Optional[List[str]] = None, name: Optional[str] = None, **kwargs: Any) → None[source]¶

允许通过过滤、按id删除行或从表中删除列。

参数：: filter: 提供一个字符串SQL表达式 - “{col} {operation} {value}”。 ids: 提供要从表中删除的id列表。 drop_columns: 提供要从表中删除的列列表。 delete_all: 如果为True，则删除表中的所有行。

Parameters

ids (Optional[List[str]]) –
delete_all (Optional[bool]) –
filter (Optional[str]) –
drop_columns (Optional[List[str]]) –
name (Optional[str]) –
kwargs (Any) –

Return type

None

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

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

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, connection: Any = None, vector_key: Optional[str] = 'vector', id_key: Optional[str] = 'id', text_key: Optional[str] = 'text', table_name: Optional[str] = 'vectorstore', **kwargs: Any) → LanceDB[source]¶

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

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
connection (Any) –
vector_key (Optional[str]) –
id_key (Optional[str]) –
text_key (Optional[str]) –
table_name (Optional[str]) –
kwargs (Any) –

Return type

LanceDB

get_table(name: Optional[str] = None, set_default: Optional[bool] = False) → Any[source]¶

从数据库中获取一个表对象。

参数:: name (str, optional): 要获取的表的名称。默认为None，获取当前表对象。 set_default (bool, optional): 将获取的表设置为默认表。默认为False。
返回:: Any: 获取的表对象。
引发:: ValueError: 如果在数据库中找不到指定的表。

Parameters

name (Optional[str]) –
set_default (Optional[bool]) –

Return type

Any

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数：: 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]

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

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

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

参数：: 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) –
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]

similarity_search(query: str, k: int = 4, name: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

返回与查询最相似的文档

参数：: query: 用于查询向量存储的字符串。 k: 要返回的文档数量。
返回：: 与查询最相似的文档列表。

Parameters

query (str) –
k (int) –
name (Optional[str]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：: embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。
返回：: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
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(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

使用距离进行相似性搜索。

Parameters

args (Any) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

langchain_community.vectorstores.lancedb.LanceDB¶

Examples using LanceDB¶

`langchain_community.vectorstores.lancedb`.LanceDB¶