Skip to content

Commit 9f6478d

Browse files
authored
Merge pull request #77 from pinecone-io/4d5bd6
Update Code
2 parents ee8518b + 915b79e commit 9f6478d

File tree

7 files changed

+59
-60
lines changed

7 files changed

+59
-60
lines changed

pinecone/core/client/api/vector_operations_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -409,15 +409,15 @@ def __fetch(
409409
):
410410
"""Fetch # noqa: E501
411411
412-
The `Fetch` operation looks up and returns vectors, by id, from a single namespace. The returned vectors include the vector data and/or metadata. # noqa: E501
412+
The `Fetch` operation looks up and returns vectors, by ID, from a single namespace. The returned vectors include the vector data and/or metadata. # noqa: E501
413413
This method makes a synchronous HTTP request by default. To make an
414414
asynchronous HTTP request, please pass async_req=True
415415
416416
>>> thread = api.fetch(ids, async_req=True)
417417
>>> result = thread.get()
418418
419419
Args:
420-
ids ([str]): The vector ids to fetch.
420+
ids ([str]): The vector IDs to fetch. Does not accept values containing spaces.
421421
422422
Keyword Args:
423423
namespace (str): [optional]

pinecone/core/client/model/create_request.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ def _from_openapi_data(cls, name, dimension, *args, **kwargs): # noqa: E501
168168
shards (int): The number of shards to be used in the index.. [optional] if omitted the server will use the default value of 1 # noqa: E501
169169
pod_type (str): The type of pod to use. One of 's1' or 'p1'.. [optional] if omitted the server will use the default value of "p1" # noqa: E501
170170
index_config (dict): [optional] # noqa: E501
171-
metadata_config ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Configuration for the behavior of Pinecone's internal metadata index. [optional] # noqa: E501
171+
metadata_config ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `metadata_config` is present, only specified metadata fields are indexed. To specify metadata fields to index, provide a JSON object of the following form: ``` {\"indexed\": [\"example_metadata_field\"] ``` . [optional] # noqa: E501
172172
"""
173173

174174
_check_type = kwargs.pop('_check_type', True)
@@ -263,7 +263,7 @@ def __init__(self, name, dimension, *args, **kwargs): # noqa: E501
263263
shards (int): The number of shards to be used in the index.. [optional] if omitted the server will use the default value of 1 # noqa: E501
264264
pod_type (str): The type of pod to use. One of 's1' or 'p1'.. [optional] if omitted the server will use the default value of "p1" # noqa: E501
265265
index_config (dict): [optional] # noqa: E501
266-
metadata_config ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Configuration for the behavior of Pinecone's internal metadata index. [optional] # noqa: E501
266+
metadata_config ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): Configuration for the behavior of Pinecone's internal metadata index. By default, all metadata is indexed; when `metadata_config` is present, only specified metadata fields are indexed. To specify metadata fields to index, provide a JSON object of the following form: ``` {\"indexed\": [\"example_metadata_field\"] ``` . [optional] # noqa: E501
267267
"""
268268

269269
_check_type = kwargs.pop('_check_type', True)

pinecone/core/client/model/delete_request.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
150150
ids ([str]): Vectors to delete.. [optional] # noqa: E501
151151
delete_all (bool): This indicates that all vectors in the index namespace should be deleted.. [optional] if omitted the server will use the default value of False # noqa: E501
152152
namespace (str): The namespace to delete vectors from, if applicable.. [optional] # noqa: E501
153-
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive with specifying ids to delete in the ids param or using delete_all=True. See https://www.pinecone.io/docs/metadata-filtering/`.. [optional] # noqa: E501
153+
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive with specifying ids to delete in the ids param or using delete_all=True. See https://www.pinecone.io/docs/metadata-filtering/.. [optional] # noqa: E501
154154
"""
155155

156156
_check_type = kwargs.pop('_check_type', True)
@@ -235,7 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
235235
ids ([str]): Vectors to delete.. [optional] # noqa: E501
236236
delete_all (bool): This indicates that all vectors in the index namespace should be deleted.. [optional] if omitted the server will use the default value of False # noqa: E501
237237
namespace (str): The namespace to delete vectors from, if applicable.. [optional] # noqa: E501
238-
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive with specifying ids to delete in the ids param or using delete_all=True. See https://www.pinecone.io/docs/metadata-filtering/`.. [optional] # noqa: E501
238+
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive with specifying ids to delete in the ids param or using delete_all=True. See https://www.pinecone.io/docs/metadata-filtering/.. [optional] # noqa: E501
239239
"""
240240

241241
_check_type = kwargs.pop('_check_type', True)

pinecone/core/client/model/describe_index_stats_response.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
151151
_visited_composed_classes = (Animal,)
152152
namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional] # noqa: E501
153153
dimension (int): The dimension of the indexed vectors.. [optional] # noqa: E501
154-
index_fullness (float): The fullness of the index.. [optional] # noqa: E501
154+
index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional] # noqa: E501
155155
"""
156156

157157
_check_type = kwargs.pop('_check_type', True)
@@ -235,7 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
235235
_visited_composed_classes = (Animal,)
236236
namespaces ({str: (NamespaceSummary,)}): A mapping for each namespace in the index from namespace name to a summary of its contents.. [optional] # noqa: E501
237237
dimension (int): The dimension of the indexed vectors.. [optional] # noqa: E501
238-
index_fullness (float): The fullness of the index.. [optional] # noqa: E501
238+
index_fullness (float): The fullness of the index. The granularity of this metric is 10%.. [optional] # noqa: E501
239239
"""
240240

241241
_check_type = kwargs.pop('_check_type', True)

pinecone/core/client/model/query_request.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -177,9 +177,9 @@ def _from_openapi_data(cls, top_k, *args, **kwargs): # noqa: E501
177177
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.. [optional] # noqa: E501
178178
include_values (bool): Indicates whether vector values are included in the response.. [optional] if omitted the server will use the default value of False # noqa: E501
179179
include_metadata (bool): Indicates whether metadata is included in the response as well as the ids.. [optional] if omitted the server will use the default value of False # noqa: E501
180-
queries ([QueryVector]): DEPRECATED. The query vectors.. [optional] # noqa: E501
181-
vector ([float]): The query vector. This should be the same length as the dimension of the index being queried.. [optional] # noqa: E501
182-
id (str): The vector's unique id.. [optional] # noqa: E501
180+
queries ([QueryVector]): DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or `id`.. [optional] # noqa: E501
181+
vector ([float]): The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.. [optional] # noqa: E501
182+
id (str): The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or `id`.. [optional] # noqa: E501
183183
"""
184184

185185
_check_type = kwargs.pop('_check_type', True)
@@ -269,9 +269,9 @@ def __init__(self, top_k, *args, **kwargs): # noqa: E501
269269
filter ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): The filter to apply. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/.. [optional] # noqa: E501
270270
include_values (bool): Indicates whether vector values are included in the response.. [optional] if omitted the server will use the default value of False # noqa: E501
271271
include_metadata (bool): Indicates whether metadata is included in the response as well as the ids.. [optional] if omitted the server will use the default value of False # noqa: E501
272-
queries ([QueryVector]): DEPRECATED. The query vectors.. [optional] # noqa: E501
273-
vector ([float]): The query vector. This should be the same length as the dimension of the index being queried.. [optional] # noqa: E501
274-
id (str): The vector's unique id.. [optional] # noqa: E501
272+
queries ([QueryVector]): DEPRECATED. The query vectors. Each `query()` request can contain only one of the parameters `queries`, `vector`, or `id`.. [optional] # noqa: E501
273+
vector ([float]): The query vector. This should be the same length as the dimension of the index being queried. Each `query()` request can contain only one of the parameters `id` or `vector`.. [optional] # noqa: E501
274+
id (str): The unique ID of the vector to be used as a query vector. Each `query()` request can contain only one of the parameters `queries`, `vector`, or `id`.. [optional] # noqa: E501
275275
"""
276276

277277
_check_type = kwargs.pop('_check_type', True)

0 commit comments

Comments
 (0)