add doc

Author: yarden-slon

pinecone/core/client/model/describe_index_stats_response.py

@@ -151,9 +151,9 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional]  # noqa: E501
+            namespaces ({str: (NamespaceSummary,)}): [optional]  # noqa: E501
             dimension (int): The dimension of the indexed vectors.. [optional]  # noqa: E501
-            index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional]  # noqa: E501
+            index_fullness (float): The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.. [optional]  # noqa: E501
             total_vector_count (int): [optional]  # noqa: E501
         """
 
@@ -236,9 +236,9 @@ def __init__(self, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional]  # noqa: E501
+            namespaces ({str: (NamespaceSummary,)}): [optional]  # noqa: E501
             dimension (int): The dimension of the indexed vectors.. [optional]  # noqa: E501
-            index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional]  # noqa: E501
+            index_fullness (float): The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.. [optional]  # noqa: E501
             total_vector_count (int): [optional]  # noqa: E501
         """
 

pinecone/core/utils/error_handling.py

@@ -21,6 +21,8 @@ def inner_func(*args, **kwargs):
                     f'Failed to connect to {e.url}; did you specify the correct index name?') from e
             else:
                 raise
+        except ProtocolError as e:
+            raise PineconeProtocolError(f'Failed to connect; did you specify the correct index name?') from e
 
     # Override signature
     sig = inspect.signature(func)

specs/pinecone_api.json

@@ -678,7 +678,7 @@
             "additionalProperties": {
               "$ref": "#/components/schemas/NamespaceSummary"
             },
-            "description": "A mapping for each namespace in the index from namespace name to a summary of its contents."
+            "title": "A mapping for each namespace in the index from namespace name to a summary of its contents.\nIf a metadata filter expression is passed, the summary will reflect only vectors matching that expression"
           },
           "dimension": {
             "type": "integer",
@@ -690,13 +690,13 @@
             "type": "number",
             "format": "float",
             "example": 0.42,
-            "description": "The fullness of the index."
+            "description": "The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%."
           },
           "totalVectorCount": {
             "type": "integer",
             "format": "int64",
             "example": 80000,
-            "title": "The total number of vectors in the index"
+            "title": "The total number of vectors in the index, regardless of whether a metadata filter expression was passed"
           }
         },
         "description": "The response for the `DescribeIndexStats` operation."