chore: exposing PineconeDocumentStore show_progress bar parameter and disabling it for tests (#2799)

* exposing show_progress bar parameter and disabling it for tests

* fixing unit test

Author: davidsbatista

integrations/pinecone/src/haystack_integrations/document_stores/pinecone/document_store.py

@@ -43,6 +43,7 @@ def __init__(
         dimension: int = 768,
         spec: dict[str, Any] | None = None,
         metric: Literal["cosine", "euclidean", "dotproduct"] = "cosine",
+        show_progress: bool = True,
     ):
         """
         Creates a new PineconeDocumentStore instance.
@@ -62,6 +63,8 @@ def __init__(
             If not provided, a default spec with serverless deployment in the `us-east-1` region will be used
             (compatible with the free tier).
         :param metric: The metric to use for similarity search. This parameter is only used when creating a new index.
+        :param show_progress: Whether to show a progress bar when upserting documents. Set to False to disable
+            (e.g. in tests or scripts where quiet output is preferred).
 
         """
         self.api_key = api_key
@@ -72,6 +75,7 @@ def __init__(
         self.spec = spec
         self.dimension = dimension
         self.index_name = index
+        self.show_progress = show_progress
 
         self._index: _Index | None = None
         self._async_index: _IndexAsyncio | None = None
@@ -199,6 +203,7 @@ def to_dict(self) -> dict[str, Any]:
             namespace=self.namespace,
             batch_size=self.batch_size,
             metric=self.metric,
+            show_progress=self.show_progress,
         )
 
     def count_documents(self) -> int:
@@ -244,7 +249,10 @@ def write_documents(self, documents: list[Document], policy: DuplicatePolicy = D
         documents_for_pinecone = self._prepare_documents_for_writing(documents, policy)
 
         result = self._index.upsert(
-            vectors=documents_for_pinecone, namespace=self.namespace, batch_size=self.batch_size
+            vectors=documents_for_pinecone,
+            namespace=self.namespace,
+            batch_size=self.batch_size,
+            show_progress=self.show_progress,
         )
 
         # if the operation is successful, result will have the upserted_count attribute
@@ -268,7 +276,10 @@ async def write_documents_async(
         documents_for_pinecone = self._prepare_documents_for_writing(documents, policy)
 
         result = await self._async_index.upsert(
-            vectors=documents_for_pinecone, namespace=self.namespace, batch_size=self.batch_size
+            vectors=documents_for_pinecone,
+            namespace=self.namespace,
+            batch_size=self.batch_size,
+            show_progress=self.show_progress,
         )
 
         # if the operation is successful, result will have the upserted_count attribute

integrations/pinecone/tests/conftest.py

@@ -34,6 +34,7 @@ def document_store(request):
         index=index,
         namespace=namespace,
         dimension=dimension,
+        show_progress=False,
     )
 
     # Override some methods to wait for the documents to be available
@@ -75,6 +76,7 @@ async def document_store_async(request):
         index=index,
         namespace=namespace,
         dimension=dimension,
+        show_progress=False,
     )
 
     # Override some methods to wait for the documents to be available

integrations/pinecone/tests/test_document_store.py

@@ -99,6 +99,7 @@ def test_to_from_dict(mock_pinecone, monkeypatch):
             "batch_size": 50,
             "metric": "euclidean",
             "spec": {"serverless": {"region": "us-east-1", "cloud": "aws"}},
+            "show_progress": True,
         },
     }
     assert document_store.to_dict() == dict_output
@@ -111,6 +112,7 @@ def test_to_from_dict(mock_pinecone, monkeypatch):
     assert document_store.dimension == 60
     assert document_store.metric == "euclidean"
     assert document_store.spec == {"serverless": {"region": "us-east-1", "cloud": "aws"}}
+    assert document_store.show_progress is True
 
 
 def test_init_fails_wo_api_key(monkeypatch):
@@ -238,6 +240,7 @@ def test_serverless_index_creation_from_scratch(delete_sleep_time):
         dimension=30,
         metric="euclidean",
         spec={"serverless": {"region": "us-east-1", "cloud": "aws"}},
+        show_progress=False,
     )
     # Trigger the connection
     _ = ds._initialize_index()

integrations/pinecone/tests/test_embedding_retriever.py

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: 2023-present deepset GmbH <info@deepset.ai>
 #
 # SPDX-License-Identifier: Apache-2.0
+
 from unittest.mock import Mock, patch
 
 import pytest
@@ -36,6 +37,7 @@ def test_to_dict(mock_pinecone, monkeypatch):
         namespace="test-namespace",
         batch_size=50,
         dimension=512,
+        show_progress=False,
     )
     retriever = PineconeEmbeddingRetriever(document_store=document_store)
     res = retriever.to_dict()
@@ -53,6 +55,7 @@ def test_to_dict(mock_pinecone, monkeypatch):
                     },
                     "index": "default",
                     "namespace": "test-namespace",
+                    "show_progress": False,
                     "batch_size": 50,
                     "dimension": 512,
                     "spec": {"serverless": {"region": "us-east-1", "cloud": "aws"}},