Skip to content

Commit 3539163

Browse files
committed
add doc
1 parent a2afec8 commit 3539163

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

pinecone/core/client/model/describe_index_stats_response.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -151,9 +151,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
151151
Animal class but this time we won't travel
152152
through its discriminator because we passed in
153153
_visited_composed_classes = (Animal,)
154-
namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional] # noqa: E501
154+
namespaces ({str: (NamespaceSummary,)}): [optional] # noqa: E501
155155
dimension (int): The dimension of the indexed vectors.. [optional] # noqa: E501
156-
index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional] # noqa: E501
156+
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
157157
total_vector_count (int): [optional] # noqa: E501
158158
"""
159159

@@ -236,9 +236,9 @@ def __init__(self, *args, **kwargs): # noqa: E501
236236
Animal class but this time we won't travel
237237
through its discriminator because we passed in
238238
_visited_composed_classes = (Animal,)
239-
namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional] # noqa: E501
239+
namespaces ({str: (NamespaceSummary,)}): [optional] # noqa: E501
240240
dimension (int): The dimension of the indexed vectors.. [optional] # noqa: E501
241-
index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional] # noqa: E501
241+
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
242242
total_vector_count (int): [optional] # noqa: E501
243243
"""
244244

pinecone/core/utils/error_handling.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ def inner_func(*args, **kwargs):
2121
f'Failed to connect to {e.url}; did you specify the correct index name?') from e
2222
else:
2323
raise
24+
except ProtocolError as e:
25+
raise PineconeProtocolError(f'Failed to connect; did you specify the correct index name?') from e
2426

2527
# Override signature
2628
sig = inspect.signature(func)

specs/pinecone_api.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@
678678
"additionalProperties": {
679679
"$ref": "#/components/schemas/NamespaceSummary"
680680
},
681-
"description": "A mapping for each namespace in the index from namespace name to a summary of its contents."
681+
"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"
682682
},
683683
"dimension": {
684684
"type": "integer",
@@ -690,13 +690,13 @@
690690
"type": "number",
691691
"format": "float",
692692
"example": 0.42,
693-
"description": "The fullness of the index."
693+
"description": "The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%."
694694
},
695695
"totalVectorCount": {
696696
"type": "integer",
697697
"format": "int64",
698698
"example": 80000,
699-
"title": "The total number of vectors in the index"
699+
"title": "The total number of vectors in the index, regardless of whether a metadata filter expression was passed"
700700
}
701701
},
702702
"description": "The response for the `DescribeIndexStats` operation."

0 commit comments

Comments
 (0)