`langchain_community.vectorstores.awadb`.AwaDB¶

class langchain_community.vectorstores.awadb.AwaDB(table_name: str = 'langchain_awadb', embedding: Optional[Embeddings] = None, log_and_data_dir: Optional[str] = None, client: Optional[awadb.Client] = None, **kwargs: Any)[source]¶

AwaDB 向量存储。

使用AwaDB客户端进行初始化。如果未指定table_name，将自动生成一个随机的table_name，格式为`_DEFAULT_TABLE_NAME + uuid的最后一段`。

参数：: table_name: 创建的表的名称，默认为_DEFAULT_TABLE_NAME。 embedding: 可选的初始嵌入。 log_and_data_dir: 可选的日志和数据的根目录。 client: 可选的AwaDB客户端。 kwargs: 未来可能扩展的任何参数。
返回：: 无。

Attributes

embeddings

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

Methods

`__init__`([table_name, embedding, ...])	使用AwaDB客户端进行初始化。如果未指定table_name，将自动生成一个随机的table_name，格式为`_DEFAULT_TABLE_NAME + uuid的最后一段`。
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas, is_duplicate_texts])	运行更多文本通过嵌入并添加到向量存储中。参数： texts：要添加到向量存储中的字符串的可迭代对象。 metadatas：可选的与文本相关联的元数据列表。 is_duplicate_texts：可选是否复制文本。默认为True。 kwargs：将来可能扩展的任何可能的参数。
`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_table`(table_name, **kwargs)	创建一个新表。
`delete`([ids])	删除具有指定id的文档。
`from_documents`(documents[, embedding, ...])	从文档列表创建一个AwaDB向量存储。
`from_texts`(texts[, embedding, metadatas, ...])	从原始文档创建一个AwaDB向量存储。
`get`([ids, text_in_page_content, ...])	根据ids返回文档。
`get_current_table`(**kwargs)	获取当前表格。
`list_tables`(**kwargs)	列出客户端创建的所有表格。
`load_local`(table_name, **kwargs)	加载本地指定的表格。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, ...])	返回与查询最相似的文档。
`similarity_search_by_vector`([embedding, k, ...])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, ...])	指定查询的最相似的 k 个文档及其得分。
`update`(ids, texts[, metadatas])	更新具有指定ID的文档。
`use`(table_name, **kwargs)	使用指定的表。如果不知道表，请调用list_tables。

Parameters

table_name (str) –
embedding (Optional[Embeddings]) –
log_and_data_dir (Optional[str]) –
client (Optional[awadb.Client]) –
kwargs (Any) –

Return type

None

__init__(table_name: str = 'langchain_awadb', embedding: Optional[Embeddings] = None, log_and_data_dir: Optional[str] = None, client: Optional[awadb.Client] = None, **kwargs: Any) → None[source]¶

使用AwaDB客户端进行初始化。如果未指定table_name，将自动生成一个随机的table_name，格式为`_DEFAULT_TABLE_NAME + uuid的最后一段`。

参数：: table_name: 创建的表的名称，默认为_DEFAULT_TABLE_NAME。 embedding: 可选的初始嵌入。 log_and_data_dir: 可选的日志和数据的根目录。 client: 可选的AwaDB客户端。 kwargs: 未来可能扩展的任何参数。
返回：: 无。

Parameters

table_name (str) –
embedding (Optional[Embeddings]) –
log_and_data_dir (Optional[str]) –
client (Optional[awadb.Client]) –
kwargs (Any) –

Return type

None

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, is_duplicate_texts: Optional[bool] = None, **kwargs: Any) → List[str][source]¶

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

texts：要添加到向量存储中的字符串的可迭代对象。 metadatas：可选的与文本相关联的元数据列表。 is_duplicate_texts：可选是否复制文本。默认为True。 kwargs：将来可能扩展的任何可能的参数。

返回：: 将文本添加到向量存储中的ID列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
is_duplicate_texts (Optional[bool]) –
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_table(table_name: str, **kwargs: Any) → bool[source]¶

创建一个新表。

Parameters

table_name (str) –
kwargs (Any) –

Return type

bool

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

删除具有指定id的文档。

参数：: ids：嵌入向量的id。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True。否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, table_name: str = 'langchain_awadb', log_and_data_dir: Optional[str] = None, client: Optional[awadb.Client] = None, **kwargs: Any) → AwaDB[source]¶

从文档列表创建一个AwaDB向量存储。

如果指定了log_and_data_dir，则表将持久化在那里。

参数:: documents (List[Document]): 要添加到向量存储的文档列表。 embedding (Optional[Embeddings]): 嵌入函数。默认为None。 table_name (str): 要创建的表的名称。 log_and_data_dir (Optional[str]): 持久化表的目录。 client (Optional[awadb.Client]): AwaDB客户端。 Any: 未来可能出现的任何参数
返回:: AwaDB: AwaDB向量存储。

Parameters

documents (List[Document]) –
embedding (Optional[Embeddings]) –
table_name (str) –
log_and_data_dir (Optional[str]) –
client (Optional[awadb.Client]) –
kwargs (Any) –

Return type

AwaDB

classmethod from_texts(texts: List[str], embedding: Optional[Embeddings] = None, metadatas: Optional[List[dict]] = None, table_name: str = 'langchain_awadb', log_and_data_dir: Optional[str] = None, client: Optional[awadb.Client] = None, **kwargs: Any) → AwaDB[source]¶

从原始文档创建一个AwaDB向量存储。

参数:: texts (List[str]): 要添加到表中的文本列表。 embedding (Optional[Embeddings]): 嵌入函数。默认为None。 metadatas (Optional[List[dict]]): 元数据列表。默认为None。 table_name (str): 要创建的表的名称。 log_and_data_dir (Optional[str]): 日志和持久化目录。 client (Optional[awadb.Client]): AwaDB客户端
返回:: AwaDB: AwaDB向量存储。

Parameters

texts (List[str]) –
embedding (Optional[Embeddings]) –
metadatas (Optional[List[dict]]) –
table_name (str) –
log_and_data_dir (Optional[str]) –
client (Optional[awadb.Client]) –
kwargs (Any) –

Return type

AwaDB

get(ids: Optional[List[str]] = None, text_in_page_content: Optional[str] = None, meta_filter: Optional[dict] = None, not_include_fields: Optional[Set[str]] = None, limit: Optional[int] = None, **kwargs: Any) → Dict[str, Document][source]¶

根据ids返回文档。

参数：: ids：嵌入向量的ids。 text_in_page_content：按文档的page_content中的文本进行过滤。 meta_filter：按文档的任何元数据进行过滤。 not_include_fields：不打包每个文档的指定字段。 limit：要返回的文档数量。默认为5。可选。
返回：: 满足输入条件的文档。

Parameters

ids (Optional[List[str]]) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
not_include_fields (Optional[Set[str]]) –
limit (Optional[int]) –
kwargs (Any) –

Return type

Dict[str, Document]

get_current_table(**kwargs: Any) → str[source]¶

获取当前表格。

Parameters: kwargs (Any) –
Return type: str

list_tables(**kwargs: Any) → List[str][source]¶

列出客户端创建的所有表格。

Parameters: kwargs (Any) –
Return type: List[str]

load_local(table_name: str, **kwargs: Any) → bool[source]¶

加载本地指定的表格。

参数:: table_name: 表格名称 kwargs: 未来可能扩展的任何参数。
返回:: 加载本地指定表格的成功或失败。

Parameters

table_name (str) –
kwargs (Any) –

Return type

bool

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

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

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

参数：: query：要查找相似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。 text_in_page_content：按文档页面内容中的文本进行过滤。 meta_filter（可选[dict]）：按元数据进行过滤。默认为None。
返回：: 通过最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
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, text_in_page_content: Optional[str] = None, meta_filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数：: embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。 text_in_page_content：按文档的page_content中的文本进行过滤。 meta_filter（可选[dict]）：按元数据进行过滤。默认为None。
返回：: 通过最大边际相关性选择的文档列表。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
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, text_in_page_content: Optional[str] = None, meta_filter: Optional[dict] = None, **kwargs: Any) → List[Document][source]¶

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

参数：: query: 文本查询。 k: 要返回的文档的最大数量。 text_in_page_content: 按文档的page_content中的文本进行过滤。 meta_filter (Optional[dict]): 按元数据进行过滤。默认为None。例如 {“color” : “red”, “price”: 4.20}。可选。例如 {“max_price” : 15.66, “min_price”: 4.20} price`是元数据字段，表示范围过滤(4.20<’price’<15.66)。例如 `{“maxe_price” : 15.66, “mine_price”: 4.20} `price`是元数据字段，表示范围过滤(4.20<=’price’<=15.66)。 kwargs: 未来可能的任何扩展参数。
返回：: 返回与指定文本查询最相似的k个文档。

Parameters

query (str) –
k (int) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: Optional[List[float]] = None, k: int = 4, text_in_page_content: Optional[str] = None, meta_filter: Optional[dict] = None, not_include_fields_in_metadata: Optional[Set[str]] = None, **kwargs: Any) → List[Document][source]¶

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

参数:: embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 text_in_page_content: 按文档的page_content中的文本进行过滤。 meta_filter: 按元数据进行过滤。默认为None。 not_incude_fields_in_metadata: 不包括每个文档的元字段。
返回:: 与查询向量最相似的文档列表。

Parameters

embedding (Optional[List[float]]) –
k (int) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
not_include_fields_in_metadata (Optional[Set[str]]) –
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, text_in_page_content: Optional[str] = None, meta_filter: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

指定查询的最相似的 k 个文档及其得分。

参数：: query: 文本查询。 k: 与文本查询最相似的前 k 个文档。 text_in_page_content: 根据文档的 page_content 中的文本进行过滤。 meta_filter: 根据元数据进行过滤。默认为 None。 kwargs: 未来可能扩展的任何参数。
返回：: 指定文本查询的前 k 个最相似的文档。 0 表示不相似，1 表示最相似。

Parameters

query (str) –
k (int) –
text_in_page_content (Optional[str]) –
meta_filter (Optional[dict]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

更新具有指定ID的文档。

参数：: ids：要更新嵌入向量的ID列表。 texts：要更新文档的文本。 metadatas：要更新文档的元数据。
返回：: 更新文档的ID。

Parameters

ids (List[str]) –
texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

List[str]

use(table_name: str, **kwargs: Any) → bool[source]¶

使用指定的表。如果不知道表，请调用list_tables。

Parameters

table_name (str) –
kwargs (Any) –

Return type

bool

langchain_community.vectorstores.awadb.AwaDB¶

Examples using AwaDB¶

`langchain_community.vectorstores.awadb`.AwaDB¶