github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-06-27 17:08:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improvement[Doc] Improve api doc in of PineconeVectorStore (#25605)

Browse Source 
Complete missing arguments in api doc of `PineconeVectorStore`.
This commit is contained in:
ZhangShenao 2024-08-21 20:58:00 +08:00 committed by GitHub
parent e7d6b25653
commit 34d0417eb5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
libs/partners/pinecone/langchain_pinecone/vectorstores.py
View File

@ -249,6 +249,7 @@ class PineconeVectorStore(VectorStore):
namespace: Optional pinecone namespace to add the texts to. namespace: Optional pinecone namespace to add the texts to.
batch_size: Batch size to use when adding the texts to the vectorstore. batch_size: Batch size to use when adding the texts to the vectorstore.
embedding_chunk_size: Chunk size to use when embedding the texts. embedding_chunk_size: Chunk size to use when embedding the texts.
async_req: Whether runs asynchronously.
id_prefix: Optional string to use as an ID prefix when upserting vectors. id_prefix: Optional string to use as an ID prefix when upserting vectors.
Returns: Returns:
@ -427,6 +428,9 @@ class PineconeVectorStore(VectorStore):
of diversity among the results with 0 corresponding of diversity among the results with 0 corresponding
to maximum diversity and 1 to minimum diversity. to maximum diversity and 1 to minimum diversity.
Defaults to 0.5. Defaults to 0.5.
filter: Dictionary of argument(s) to filter on metadata
namespace: Namespace to search in. Default will search in '' namespace.
Returns: Returns:
List of Documents selected by maximal marginal relevance. List of Documents selected by maximal marginal relevance.
""" """
@ -475,6 +479,9 @@ class PineconeVectorStore(VectorStore):
of diversity among the results with 0 corresponding of diversity among the results with 0 corresponding
to maximum diversity and 1 to minimum diversity. to maximum diversity and 1 to minimum diversity.
Defaults to 0.5. Defaults to 0.5.
filter: Dictionary of argument(s) to filter on metadata
namespace: Namespace to search in. Default will search in '' namespace.
Returns: Returns:
List of Documents selected by maximal marginal relevance. List of Documents selected by maximal marginal relevance.
""" """
@ -496,6 +503,7 @@ class PineconeVectorStore(VectorStore):
Args: Args:
index_name: Name of the index to use. index_name: Name of the index to use.
pool_threads: Number of threads to use for index upsert. pool_threads: Number of threads to use for index upsert.
pinecone_api_key: The api_key of Pinecone.
Returns: Returns:
Pinecone Index instance.""" Pinecone Index instance."""
_pinecone_api_key = pinecone_api_key or os.environ.get("PINECONE_API_KEY") or "" _pinecone_api_key = pinecone_api_key or os.environ.get("PINECONE_API_KEY") or ""
@ -541,7 +549,7 @@ class PineconeVectorStore(VectorStore):
) -> PineconeVectorStore: ) -> PineconeVectorStore:
"""Construct Pinecone wrapper from raw documents. """Construct Pinecone wrapper from raw documents.
This is a user friendly interface that: This is a user-friendly interface that:
1. Embeds documents. 1. Embeds documents.
2. Adds the documents to a provided Pinecone index 2. Adds the documents to a provided Pinecone index
@ -606,7 +614,9 @@ class PineconeVectorStore(VectorStore):
"""Delete by vector IDs or filter. """Delete by vector IDs or filter.
Args: Args:
ids: List of ids to delete. ids: List of ids to delete.
delete_all: Whether delete all vectors in the index.
filter: Dictionary of conditions to filter vectors to delete. filter: Dictionary of conditions to filter vectors to delete.
namespace: Namespace to search in. Default will search in '' namespace.
""" """
if namespace is None: if namespace is None: