From b5eb91536afe17ea7e552c14c75dcb783657cd5c Mon Sep 17 00:00:00 2001
From: babbldev <babbldev.team@gmail.com>
Date: Thu, 12 Jan 2023 23:15:51 -0600
Subject: [PATCH] Added filter argument to pinecone queries, fixes #600 (#601)

Added filter argument to similarity_search() and
similarity_search_with_score()

Co-authored-by: Sam Cartford (MBP) <cartford@hey.com>
---
 langchain/vectorstores/pinecone.py | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/langchain/vectorstores/pinecone.py b/langchain/vectorstores/pinecone.py
index d395ceec866..cc160ca59ab 100644
--- a/langchain/vectorstores/pinecone.py
+++ b/langchain/vectorstores/pinecone.py
@@ -80,6 +80,7 @@ class Pinecone(VectorStore):
         self,
         query: str,
         k: int = 5,
+        filter: Optional[dict] = None,
         namespace: Optional[str] = None,
     ) -> List[Tuple[Document, float]]:
         """Return pinecone documents most similar to query, along with scores.
@@ -87,6 +88,7 @@ class Pinecone(VectorStore):
         Args:
             query: Text to look up documents similar to.
             k: Number of Documents to return. Defaults to 4.
+            filter: Dictionary of argument(s) to filter on metadata
             namespace: Namespace to search in. Default will search in '' namespace.
 
         Returns:
@@ -95,7 +97,11 @@ class Pinecone(VectorStore):
         query_obj = self._embedding_function(query)
         docs = []
         results = self._index.query(
-            [query_obj], top_k=k, include_metadata=True, namespace=namespace
+            [query_obj],
+            top_k=k,
+            include_metadata=True,
+            namespace=namespace,
+            filter=filter,
         )
         for res in results["matches"]:
             metadata = res["metadata"]
@@ -107,6 +113,7 @@ class Pinecone(VectorStore):
         self,
         query: str,
         k: int = 5,
+        filter: Optional[dict] = None,
         namespace: Optional[str] = None,
     ) -> List[Document]:
         """Return pinecone documents most similar to query.
@@ -114,6 +121,7 @@ class Pinecone(VectorStore):
         Args:
             query: Text to look up documents similar to.
             k: Number of Documents to return. Defaults to 4.
+            filter: Dictionary of argument(s) to filter on metadata
             namespace: Namespace to search in. Default will search in '' namespace.
 
         Returns:
@@ -122,7 +130,11 @@ class Pinecone(VectorStore):
         query_obj = self._embedding_function(query)
         docs = []
         results = self._index.query(
-            [query_obj], top_k=k, include_metadata=True, namespace=namespace
+            [query_obj],
+            top_k=k,
+            include_metadata=True,
+            namespace=namespace,
+            filter=filter,
         )
         for res in results["matches"]:
             metadata = res["metadata"]