langchain_community.vectorstores.bigquery_vector_search.BigQueryVectorSearch

class langchain_community.vectorstores.bigquery_vector_search.BigQueryVectorSearch(embedding: Embeddings, project_id: str, dataset_name: str, table_name: str, location: str = 'US', content_field: str = 'content', metadata_field: str = 'metadata', text_embedding_field: str = 'text_embedding', doc_id_field: str = 'doc_id', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN_DISTANCE, credentials: Optional[Any] = None)[source]

[Deprecated] Google Cloud BigQuery向量存储。

要使用，需要安装以下软件包：

google-cloud-bigquery

Notes

Deprecated since version 0.0.33.

BigQueryVectorSearch的构造函数。

参数:

embedding (Embeddings): 要使用的文本嵌入模型。 project_id (str): GCP项目。 dataset_name (str): 用于存储文档和嵌入向量的BigQuery数据集。 table_name (str): BigQuery表名称。 location (str, optional): BigQuery区域。默认为`US`（多区域）。 content_field (str): 指定存储内容的列。默认为`content`。 metadata_field (str): 指定存储元数据的列。默认为`metadata`。 text_embedding_field (str): 指定存储嵌入向量的列。默认为`text_embedding`。 doc_id_field (str): 指定存储文档ID的列。默认为`doc_id`。 distance_strategy (DistanceStrategy, optional):

确定用于计算嵌入空间中向量之间距离的策略。 默认为EUCLIDEAN_DISTANCE。 可用选项为: - COSINE: 测量内积空间中两个向量之间的相似性。 - EUCLIDEAN_DISTANCE: 计算两个向量之间的欧氏距离。

此度量考虑向量空间中的几何距离，可能更适合依赖空间关系的嵌入。 这是默认行为。

credentials (Credentials, optional): 要使用的自定义Google Cloud凭据。

默认为None。

Attributes

embeddings

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

full_table_id

Methods

__init__(embedding, project_id, ...[, ...])

BigQueryVectorSearch的构造函数。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

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

add_texts_with_embeddings(texts, embs[, ...])

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

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

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

explore_job_stats(job_id)

返回单个作业执行的统计信息。

from_documents(documents, embedding, **kwargs)

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

from_texts(texts, embedding[, metadatas])

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

get_documents([ids, filter])

根据其id或元数据值搜索文档。

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

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

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

运行相似性搜索。

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(embedding)

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

  • embedding (Embeddings) –

  • project_id (str) –

  • dataset_name (str) –

  • table_name (str) –

  • location (str) –

  • content_field (str) –

  • metadata_field (str) –

  • text_embedding_field (str) –

  • doc_id_field (str) –

  • distance_strategy (DistanceStrategy) –

  • credentials (Optional[Any]) –

__init__(embedding: Embeddings, project_id: str, dataset_name: str, table_name: str, location: str = 'US', content_field: str = 'content', metadata_field: str = 'metadata', text_embedding_field: str = 'text_embedding', doc_id_field: str = 'doc_id', distance_strategy: DistanceStrategy = DistanceStrategy.EUCLIDEAN_DISTANCE, credentials: Optional[Any] = None)[source]

BigQueryVectorSearch的构造函数。

参数:

embedding (Embeddings): 要使用的文本嵌入模型。 project_id (str): GCP项目。 dataset_name (str): 用于存储文档和嵌入向量的BigQuery数据集。 table_name (str): BigQuery表名称。 location (str, optional): BigQuery区域。默认为`US`（多区域）。 content_field (str): 指定存储内容的列。默认为`content`。 metadata_field (str): 指定存储元数据的列。默认为`metadata`。 text_embedding_field (str): 指定存储嵌入向量的列。默认为`text_embedding`。 doc_id_field (str): 指定存储文档ID的列。默认为`doc_id`。 distance_strategy (DistanceStrategy, optional):

确定用于计算嵌入空间中向量之间距离的策略。 默认为EUCLIDEAN_DISTANCE。 可用选项为: - COSINE: 测量内积空间中两个向量之间的相似性。 - EUCLIDEAN_DISTANCE: 计算两个向量之间的欧氏距离。

此度量考虑向量空间中的几何距离，可能更适合依赖空间关系的嵌入。 这是默认行为。

credentials (Credentials, optional): 要使用的自定义Google Cloud凭据。

默认为None。

Parameters

  • embedding (Embeddings) –

  • project_id (str) –

  • dataset_name (str) –

  • table_name (str) –

  • location (str) –

  • content_field (str) –

  • metadata_field (str) –

  • text_embedding_field (str) –

  • doc_id_field (str) –

  • distance_strategy (DistanceStrategy) –

  • credentials (Optional[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: List[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]

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

参数：

texts：要添加到向量存储的字符串列表。 metadatas：与文本相关联的元数据的可选列表。

返回：

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

Parameters

  • texts (List[str]) –

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

  • kwargs (Any) –

Return type

List[str]

add_texts_with_embeddings(texts: List[str], embs: List[List[float]], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]

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

参数：

texts：要添加到向量存储的字符串列表。 embs：包含文本嵌入的浮点数列表的列表。 metadatas：可选的与文本相关联的元数据列表。

返回：

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

Parameters

  • texts (List[str]) –

  • embs (List[List[float]]) –

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

  • kwargs (Any) –

Return type

List[str]

async adelete(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]

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

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

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

  • brute_force (bool) –

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

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[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[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]

explore_job_stats(job_id: str) → Dict[source]

返回单个作业执行的统计信息。

参数：

job_id：BigQuery作业的ID。

返回：

给定作业的作业统计信息字典。

Parameters

job_id (str) –

Return type

Dict

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) → BigQueryVectorSearch[source]

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

Parameters

  • texts (List[str]) –

  • embedding (Embeddings) –

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

  • kwargs (Any) –

Return type

BigQueryVectorSearch

get_documents(ids: Optional[List[str]] = None, filter: Optional[Dict[str, Any]] = None) → List[Document][source]

根据其id或元数据值搜索文档。

参数：

ids：要从向量存储中检索的文档的id列表。 filter：元数据属性的过滤器，例如

{

“str_property”: “foo”, “int_property”: 123

}

返回：

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

Parameters

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

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

Return type

List[Document]

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

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

参数：

query：搜索查询文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间的多样性程度，

其中0对应于最大多样性，1对应于最小多样性。 默认为0.5。

filter：根据元数据属性进行过滤，例如
{

“str_property”: “foo”, “int_property”: 123

}

brute_force：是否使用蛮力搜索。默认为False。 fraction_lists_to_search：要搜索的列表的可选百分比，

必须在0.0和1.0的范围内，不包括边界。 如果是Node，则使用服务的默认值，即0.05。

返回：

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

Parameters

  • query (str) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

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

  • brute_force (bool) –

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

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

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

参数：

embedding: 查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。 filter: 元数据属性的过滤器，例如

{

“str_property”: “foo”, “int_property”: 123

}

brute_force: 是否使用蛮力搜索。默认为False。 fraction_lists_to_search: 要搜索的列表的可选百分比，必须在0.0和1.0的范围内，不包括边界。

如果是Node，则使用服务的默认值，即0.05。

返回：

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

Parameters

  • embedding (List[float]) –

  • k (int) –

  • fetch_k (int) –

  • lambda_mult (float) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[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]

运行相似性搜索。

参数:

query: 搜索查询文本。 k: 返回的文档数量。默认为4。 filter: 元数据属性的过滤器，例如

{

“str_property”: “foo”, “int_property”: 123

}

brute_force: 是否使用蛮力搜索。默认为False。 fraction_lists_to_search: 要搜索的列表的可选百分比，必须在0.0和1.0之间，不包括0和1。

如果为Node，则使用服务的默认值，即0.05。

返回:

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

Parameters

  • query (str) –

  • k (int) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[float]) –

  • kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[Dict[str, Any]] = None, brute_force: bool = False, fraction_lists_to_search: Optional[float] = None, **kwargs: Any) → List[Document][source]

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

参数:

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 过滤元数据属性，例如

{

“str_property”: “foo”, “int_property”: 123

}

brute_force: 是否使用蛮力搜索。默认为False。 fraction_lists_to_search: 要搜索的列表的可选百分比，

必须在0.0和1.0之间，不包括边界。 如果是Node，则使用服务的默认值，即0.05。

返回:

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

Parameters

  • embedding (List[float]) –

  • k (int) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[float]) –

  • 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, brute_force: bool = False, fraction_lists_to_search: Optional[float] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

运行带有分数的相似性搜索。

参数:

query: 搜索查询文本。 k: 返回的文档数量。默认为4。 filter: 元数据属性的过滤器，例如

{

“str_property”: “foo”, “int_property”: 123

}

brute_force: 是否使用蛮力搜索。默认为False。 fraction_lists_to_search: 要搜索的列表的可选百分比，

必须在0.0和1.0之间，不包括0.0和1.0。 如果是Node，则使用服务的默认值，即0.05。

返回:

与查询向量最相似的文档列表，带有相似性分数。

Parameters

  • query (str) –

  • k (int) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[float]) –

  • 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, brute_force: bool = False, fraction_lists_to_search: Optional[float] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

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

参数:

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 过滤元数据属性，例如

{

“str_property”: “foo”, “int_property”: 123

}

brute_force: 是否使用蛮力搜索。默认为False。 fraction_lists_to_search: 要搜索的列表的可选百分比，

必须在0.0和1.0之间，不包括0.0和1.0。 如果是Node，则使用服务的默认值，即0.05。

返回:

与查询向量最相似的文档列表，带有距离。

Parameters

  • embedding (List[float]) –

  • k (int) –

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

  • brute_force (bool) –

  • fraction_lists_to_search (Optional[float]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using BigQueryVectorSearch