`langchain_community.vectorstores.pinecone`.Pinecone¶

class langchain_community.vectorstores.pinecone.Pinecone(index: Any, embedding: Union[Embeddings, Callable], text_key: str, namespace: Optional[str] = None, distance_strategy: Optional[DistanceStrategy] = DistanceStrategy.COSINE)[source]¶

Deprecated since version 0.0.18: 使用 langchain_pinecone.Pinecone 代替，自 0.0.18 版本起已弃用。

Pinecone 向量存储。

要使用，您应该安装 pinecone-client python 包。

此版本的 Pinecone 已弃用。请使用 langchain_pinecone.Pinecone 代替。

使用 Pinecone 客户端初始化。

属性

embeddings

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

方法

`__init__`(index, embedding, text_key[, ...])	使用 Pinecone 客户端初始化。
`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。
`aget_by_ids`(ids, /)	异步通过 ID 获取文档。
`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)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **kwargs)
`delete`([ids, delete_all, namespace, filter])	通过向量 ID 或过滤器删除。
`from_documents`(documents, embedding, **kwargs)	从文档和嵌入初始化并返回 VectorStore。
`from_existing_index`(index_name, embedding[, ...])	从索引名称加载 pinecone 向量存储。
`from_texts`(texts, embedding[, metadatas, ...])	已弃用：请使用 langchain_pinecone.PineconeVectorStore.from_texts 代替：从原始文档构建 Pinecone 包装器。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`get_pinecone_index`(index_name[, pool_threads])	返回 Pinecone Index 实例。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回与查询最相似的文档，使用指定的搜索类型。
`similarity_search`(query[, k, filter, namespace])	返回与查询最相似的 pinecone 文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_by_vector_with_score`(...)	返回与嵌入最相似的 pinecone 文档，以及评分。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性评分，范围为 [0, 1]。
`similarity_search_with_score`(query[, k, ...])	返回与查询最相似的 pinecone 文档，以及评分。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

index (Any) –
embedding (Union[Embeddings, Callable]) –
text_key (str) –
namespace (Optional[str]) –
distance_strategy (Optional[DistanceStrategy]) –

__init__(index: Any, embedding: Union[Embeddings, Callable], text_key: str, namespace: Optional[str] = None, distance_strategy: Optional[DistanceStrategy] = DistanceStrategy.COSINE)[source]¶

使用 Pinecone 客户端初始化。

参数

index (Any) –
embedding (Union[Embeddings, Callable]) –
text_key (str) –
namespace (Optional[str]) –
distance_strategy (Optional[DistanceStrategy]) –

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加关键字参数。

返回值

添加文本的 ID 列表。

Raises

ValueError – 如果 ID 的数量与文档的数量不匹配。

Return type

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回值

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

Raises

ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果 id 的数量与文本的数量不匹配。

Return type

List[str]

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

在向量存储中添加或更新文档。

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加关键字参数。如果 kwargs 包含 ids 并且 documents 包含 ids，则 kwargs 中的 ids 将优先。

返回值

添加文本的 ID 列表。

Raises

ValueError – 如果 id 的数量与文档的数量不匹配。

Return type

List[str]

add_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, namespace: Optional[str] = None, batch_size: int = 32, embedding_chunk_size: int = 1000, **kwargs: Any) → List[str][source]¶

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

通过分块嵌入并进行 upsert 优化来完成 Upsert 优化。这样做是为了避免内存问题并优化使用基于 HTTP 的嵌入。对于 OpenAI 嵌入，当构造 pinecone.Index 时，使用 pool_threads>4，embedding_chunk_size>1000 和 batch_size~64 可获得最佳性能。 :param texts: 要添加到向量存储的字符串的可迭代对象。 :param metadatas: 与文本关联的可选元数据列表。 :param ids: 与文本关联的可选 id 列表。 :param namespace: 要将文本添加到的可选 pinecone 命名空间。 :param batch_size: 将文本添加到向量存储时要使用的批处理大小。 :param embedding_chunk_size: 嵌入文本时要使用的块大小。

返回值

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

参数

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
namespace (Optional[str]) –
batch_size (int) –
embedding_chunk_size (int) –
kwargs (Any) –

Return type

List[str]

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

异步通过向量 ID 或其他标准删除。

参数

ids (Optional[List[str]]) – 要删除的 id 列表。如果为 None，则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回值

如果删除成功，则为 True，否则为 False，如果未实现，则为 None。

Return type

Optional[bool]

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

异步从文档和嵌入初始化并返回 VectorStore。

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回值

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

Return type

VectorStore

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

异步从文本和嵌入初始化并返回 VectorStore。

参数

texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加关键字参数。

返回值

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

Return type

VectorStore

async aget_by_ids(ids: Sequence[str], /) → List[Document]¶

异步通过 ID 获取文档。

返回的文档应设置 ID 字段为向量存储中文档的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的文档数。

用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 没有找到文档，此方法不应引发异常。

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回值: 文档列表。
Return type: List[Document]

0.2.11 版本新增。

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

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
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]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回由此 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

传递给搜索函数的关键字参数。可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。

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

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。可以包括如下内容：

search function. Can include things like

k: 要返回的文档数量 (默认: 4) score_threshold: 相似度分数阈值的最小相关性阈值

for similarity_score_threshold

fetch_k: 要传递给 MMR 算法的文档数量 (默认: 20): (Default: 20)
lambda_mult: MMR 返回结果的多样性；1 表示最小多样性，0 表示最大多样性。(默认: 0.5): 1 for minimum diversity and 0 for maximum. (Default: 0.5)

filter: 按文档元数据过滤

返回值

VectorStore 的检索器类。

Return type

VectorStoreRetriever

示例

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

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

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

参数

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

Raises

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

Return type

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似度搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集

返回值

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

Return type

List[Tuple[Document, float]]

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

异步运行带距离的相似性搜索。

参数

*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

（文档，相似度分数）元组的列表。

Return type

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta 版本

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时，重试策略等）kwargs 不应包含 ID，以避免语义不明确。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含成功添加或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

AsyncIterator[UpsertResponse]

0.2.11 版本新增。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta 版本

在 0.2.11 版本中添加。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回值

响应对象，其中包含成功添加或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增。

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

按向量 ID 或过滤器删除。 :param ids: 要删除的 ID 列表。 :param filter: 用于过滤要删除向量的条件字典。

参数

ids (Optional[List[str]]) –
delete_all (Optional[bool]) –
namespace (Optional[str]) –
filter (Optional[dict]) –
kwargs (Any) –

Return type

None

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回值

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

Return type

VectorStore

classmethod from_existing_index(index_name: str, embedding: Embeddings, text_key: str = 'text', namespace: Optional[str] = None, pool_threads: int = 4) → Pinecone[source]¶

从索引名称加载 pinecone 向量存储。

参数

index_name (str) –
embedding (Embeddings) –
text_key (str) –
namespace (Optional[str]) –
pool_threads (int) –

Return type

Pinecone

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, batch_size: int = 32, text_key: str = 'text', namespace: Optional[str] = None, index_name: Optional[str] = None, upsert_kwargs: Optional[dict] = None, pool_threads: int = 4, embeddings_chunk_size: int = 1000, **kwargs: Any) → Pinecone[source]¶

已弃用：请使用 langchain_pinecone.PineconeVectorStore.from_texts 代替：从原始文档构建 Pinecone 包装器。

这是一个用户友好的界面，用于

嵌入文档。
将文档添加到提供的 Pinecone 索引

这旨在成为快速入门的方法。

pool_threads 影响 upsert 操作的速度。

示例

from langchain_pinecone import PineconeVectorStore
from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
index_name = "my-index"
namespace = "my-namespace"
vectorstore = Pinecone(
    index_name=index_name,
    embedding=embedding,
    namespace=namespace,
)

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
batch_size (int) –
text_key (str) –
namespace (Optional[str]) –
index_name (Optional[str]) –
upsert_kwargs (Optional[dict]) –
pool_threads (int) –
embeddings_chunk_size (int) –
kwargs (Any) –

Return type

Pinecone

get_by_ids(ids: Sequence[str], /) → List[Document]¶

通过 ID 获取文档。

返回的文档应设置 ID 字段为向量存储中文档的 ID。

如果某些 ID 未找到或存在重复 ID，则返回的文档可能少于请求的文档数。

用户不应假定返回文档的顺序与输入 ID 的顺序匹配。相反，用户应依赖返回文档的 ID 字段。

如果某些 ID 没有找到文档，此方法不应引发异常。

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回值: 文档列表。
Return type: List[Document]

0.2.11 版本新增。

classmethod get_pinecone_index(index_name: Optional[str], pool_threads: int = 4) → Index[source]¶

返回 Pinecone Index 实例。

参数

index_name (Optional[str]) – 要使用的索引名称。
pool_threads (int) – 用于索引 upsert 的线程数。

返回值

Pinecone 索引实例。

Return type

Index

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

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 获取用于传递给 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[dict]) –
namespace (Optional[str]) –
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] = None, namespace: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 获取用于传递给 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[dict]) –
namespace (Optional[str]) –
kwargs (Any) –

返回值

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

Return type

List[Document]

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

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

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

Raises

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type

List[Document]

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[dict]) – 用于基于元数据进行过滤的参数字典。
namespace (Optional[str]) – 要搜索的命名空间。默认将在 ‘’ 命名空间中搜索。
kwargs (Any) –

返回值

与查询最相似的文档列表以及每个文档的分数

Return type

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回值

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

Return type

List[Document]

similarity_search_by_vector_with_score(embedding: List[float], *, k: int = 4, filter: Optional[dict] = None, namespace: Optional[str] = None) → List[Tuple[Document, float]][source]¶

返回与嵌入最相似的 pinecone 文档，以及评分。

参数

embedding (List[float]) –
k (int) –
filter (Optional[dict]) –
namespace (Optional[str]) –

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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似度搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集。

返回值

（文档，相似度分数）元组的列表。

Return type

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Optional[dict] = None, namespace: Optional[str] = None) → List[Tuple[Document, float]][source]¶

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
filter (Optional[dict]) – 用于基于元数据进行过滤的参数字典。
namespace (Optional[str]) – 要搜索的命名空间。默认将在 ‘’ 命名空间中搜索。

返回值

与查询最相似的文档列表以及每个文档的分数

Return type

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta 版本

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新插入文档。

参数

items (Iterable[Document]) – 要添加到向量数据库的文档的可迭代对象。
batch_size (int) – 每次批量更新的大小。
kwargs (Any) – 额外的关键字参数。 kwargs 应该只包含所有文档通用的参数。（例如，索引超时，重试策略等）kwargs 不应包含 ids 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含成功添加或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

Iterator[UpsertResponse]

0.2.11 版本新增。

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta 版本

在 0.2.11 版本中添加。API 可能会发生变化。

在向量存储中添加或更新文档。

如果提供了 Document 对象的 ID 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，upsert 方法应使用新数据更新文档。如果文档不存在，则 upsert 方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加关键字参数。

返回值

响应对象，其中包含成功添加或更新到向量存储中的 ID 列表，以及未能添加或更新的 ID 列表。

Return type

UpsertResponse

0.2.11 版本新增。

langchain_community.vectorstores.pinecone.Pinecone¶

`langchain_community.vectorstores.pinecone`.Pinecone¶