|
5 | 5 |
|
6 | 6 | This file is @generated using OpenAPI.
|
7 | 7 |
|
8 |
| -The version of the OpenAPI document: 2025-01 |
| 8 | +The version of the OpenAPI document: 2025-04 |
9 | 9 | Contact: support@pinecone.io
|
10 | 10 | """
|
11 | 11 |
|
@@ -52,7 +52,7 @@ def __configure_index(
|
52 | 52 | ):
|
53 | 53 | """Configure an index # noqa: E501
|
54 | 54 |
|
55 |
| - This operation configures an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes). # noqa: E501 |
| 55 | + Configure an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes). # noqa: E501 |
56 | 56 | This method makes a synchronous HTTP request by default. To make an
|
57 | 57 | asynchronous HTTP request, please pass async_req=True
|
58 | 58 |
|
@@ -128,7 +128,7 @@ def __create_collection(
|
128 | 128 | ):
|
129 | 129 | """Create a collection # noqa: E501
|
130 | 130 |
|
131 |
| - This operation creates a Pinecone collection. Serverless indexes do not support collections. # noqa: E501 |
| 131 | + Create a Pinecone collection. Serverless indexes do not support collections. # noqa: E501 |
132 | 132 | This method makes a synchronous HTTP request by default. To make an
|
133 | 133 | asynchronous HTTP request, please pass async_req=True
|
134 | 134 |
|
@@ -197,7 +197,7 @@ def __create_collection(
|
197 | 197 | def __create_index(self, create_index_request, **kwargs: ExtraOpenApiKwargsTypedDict):
|
198 | 198 | """Create an index # noqa: E501
|
199 | 199 |
|
200 |
| - This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index). # noqa: E501 |
| 200 | + Create a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index). # noqa: E501 |
201 | 201 | This method makes a synchronous HTTP request by default. To make an
|
202 | 202 | asynchronous HTTP request, please pass async_req=True
|
203 | 203 |
|
@@ -266,9 +266,9 @@ def __create_index(self, create_index_request, **kwargs: ExtraOpenApiKwargsTyped
|
266 | 266 | def __create_index_for_model(
|
267 | 267 | self, create_index_for_model_request, **kwargs: ExtraOpenApiKwargsTypedDict
|
268 | 268 | ):
|
269 |
| - """Create an index for an embedding model # noqa: E501 |
| 269 | + """Create an index with integrated embedding # noqa: E501 |
270 | 270 |
|
271 |
| - This operation creates a serverless integrated inference index for a specific embedding model. Refer to the [model guide](https://docs.pinecone.io/guides/inference/understanding-inference#embedding-models) for available models and model details. # noqa: E501 |
| 271 | + Create an index with integrated embedding. With this type of index, you provide source text, and Pinecone uses a [hosted embedding model](https://docs.pinecone.io/guides/inference/understanding-inference#embedding-models) to convert the text automatically during [upsert](https://docs.pinecone.io/reference/api/2025-01/data-plane/upsert_records) and [search](https://docs.pinecone.io/reference/api/2025-01/data-plane/search_records). For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#integrated-embedding). # noqa: E501 |
272 | 272 | This method makes a synchronous HTTP request by default. To make an
|
273 | 273 | asynchronous HTTP request, please pass async_req=True
|
274 | 274 |
|
@@ -337,7 +337,7 @@ def __create_index_for_model(
|
337 | 337 | def __delete_collection(self, collection_name, **kwargs: ExtraOpenApiKwargsTypedDict):
|
338 | 338 | """Delete a collection # noqa: E501
|
339 | 339 |
|
340 |
| - This operation deletes an existing collection. Serverless indexes do not support collections. # noqa: E501 |
| 340 | + Delete an existing collection. Serverless indexes do not support collections. # noqa: E501 |
341 | 341 | This method makes a synchronous HTTP request by default. To make an
|
342 | 342 | asynchronous HTTP request, please pass async_req=True
|
343 | 343 |
|
@@ -406,7 +406,7 @@ def __delete_collection(self, collection_name, **kwargs: ExtraOpenApiKwargsTyped
|
406 | 406 | def __delete_index(self, index_name, **kwargs: ExtraOpenApiKwargsTypedDict):
|
407 | 407 | """Delete an index # noqa: E501
|
408 | 408 |
|
409 |
| - This operation deletes an existing index. # noqa: E501 |
| 409 | + Delete an existing index. # noqa: E501 |
410 | 410 | This method makes a synchronous HTTP request by default. To make an
|
411 | 411 | asynchronous HTTP request, please pass async_req=True
|
412 | 412 |
|
@@ -475,7 +475,7 @@ def __delete_index(self, index_name, **kwargs: ExtraOpenApiKwargsTypedDict):
|
475 | 475 | def __describe_collection(self, collection_name, **kwargs: ExtraOpenApiKwargsTypedDict):
|
476 | 476 | """Describe a collection # noqa: E501
|
477 | 477 |
|
478 |
| - This operation gets a description of a collection. Serverless indexes do not support collections. # noqa: E501 |
| 478 | + Get a description of a collection. Serverless indexes do not support collections. # noqa: E501 |
479 | 479 | This method makes a synchronous HTTP request by default. To make an
|
480 | 480 | asynchronous HTTP request, please pass async_req=True
|
481 | 481 |
|
@@ -613,7 +613,7 @@ def __describe_index(self, index_name, **kwargs: ExtraOpenApiKwargsTypedDict):
|
613 | 613 | def __list_collections(self, **kwargs: ExtraOpenApiKwargsTypedDict):
|
614 | 614 | """List collections # noqa: E501
|
615 | 615 |
|
616 |
| - This operation returns a list of all collections in a project. Serverless indexes do not support collections. # noqa: E501 |
| 616 | + List all collections in a project. Serverless indexes do not support collections. # noqa: E501 |
617 | 617 | This method makes a synchronous HTTP request by default. To make an
|
618 | 618 | asynchronous HTTP request, please pass async_req=True
|
619 | 619 |
|
@@ -673,7 +673,7 @@ def __list_collections(self, **kwargs: ExtraOpenApiKwargsTypedDict):
|
673 | 673 | def __list_indexes(self, **kwargs: ExtraOpenApiKwargsTypedDict):
|
674 | 674 | """List indexes # noqa: E501
|
675 | 675 |
|
676 |
| - This operation returns a list of all indexes in a project. # noqa: E501 |
| 676 | + List all indexes in a project. # noqa: E501 |
677 | 677 | This method makes a synchronous HTTP request by default. To make an
|
678 | 678 | asynchronous HTTP request, please pass async_req=True
|
679 | 679 |
|
@@ -745,7 +745,7 @@ def __init__(self, api_client=None) -> None:
|
745 | 745 | async def __configure_index(self, index_name, configure_index_request, **kwargs):
|
746 | 746 | """Configure an index # noqa: E501
|
747 | 747 |
|
748 |
| - This operation configures an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes). # noqa: E501 |
| 748 | + Configure an existing index. For serverless indexes, you can configure index deletion protection, tags, and integrated inference embedding settings for the index. For pod-based indexes, you can configure the pod size, number of replicas, tags, and index deletion protection. It is not possible to change the pod type of a pod-based index. However, you can create a collection from a pod-based index and then [create a new pod-based index with a different pod type](http://docs.pinecone.io/guides/indexes/pods/create-a-pod-based-index#create-a-pod-index-from-a-collection) from the collection. For guidance and examples, see [Configure an index](http://docs.pinecone.io/guides/indexes/pods/manage-pod-based-indexes). # noqa: E501 |
749 | 749 |
|
750 | 750 |
|
751 | 751 | Args:
|
@@ -812,7 +812,7 @@ async def __configure_index(self, index_name, configure_index_request, **kwargs)
|
812 | 812 | async def __create_collection(self, create_collection_request, **kwargs):
|
813 | 813 | """Create a collection # noqa: E501
|
814 | 814 |
|
815 |
| - This operation creates a Pinecone collection. Serverless indexes do not support collections. # noqa: E501 |
| 815 | + Create a Pinecone collection. Serverless indexes do not support collections. # noqa: E501 |
816 | 816 |
|
817 | 817 |
|
818 | 818 | Args:
|
@@ -874,7 +874,7 @@ async def __create_collection(self, create_collection_request, **kwargs):
|
874 | 874 | async def __create_index(self, create_index_request, **kwargs):
|
875 | 875 | """Create an index # noqa: E501
|
876 | 876 |
|
877 |
| - This operation deploys a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index). # noqa: E501 |
| 877 | + Create a Pinecone index. This is where you specify the measure of similarity, the dimension of vectors to be stored in the index, which cloud provider you would like to deploy with, and more. For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#create-a-serverless-index). # noqa: E501 |
878 | 878 |
|
879 | 879 |
|
880 | 880 | Args:
|
@@ -934,9 +934,9 @@ async def __create_index(self, create_index_request, **kwargs):
|
934 | 934 | )
|
935 | 935 |
|
936 | 936 | async def __create_index_for_model(self, create_index_for_model_request, **kwargs):
|
937 |
| - """Create an index for an embedding model # noqa: E501 |
| 937 | + """Create an index with integrated embedding # noqa: E501 |
938 | 938 |
|
939 |
| - This operation creates a serverless integrated inference index for a specific embedding model. Refer to the [model guide](https://docs.pinecone.io/guides/inference/understanding-inference#embedding-models) for available models and model details. # noqa: E501 |
| 939 | + Create an index with integrated embedding. With this type of index, you provide source text, and Pinecone uses a [hosted embedding model](https://docs.pinecone.io/guides/inference/understanding-inference#embedding-models) to convert the text automatically during [upsert](https://docs.pinecone.io/reference/api/2025-01/data-plane/upsert_records) and [search](https://docs.pinecone.io/reference/api/2025-01/data-plane/search_records). For guidance and examples, see [Create an index](https://docs.pinecone.io/guides/indexes/create-an-index#integrated-embedding). # noqa: E501 |
940 | 940 |
|
941 | 941 |
|
942 | 942 | Args:
|
@@ -998,7 +998,7 @@ async def __create_index_for_model(self, create_index_for_model_request, **kwarg
|
998 | 998 | async def __delete_collection(self, collection_name, **kwargs):
|
999 | 999 | """Delete a collection # noqa: E501
|
1000 | 1000 |
|
1001 |
| - This operation deletes an existing collection. Serverless indexes do not support collections. # noqa: E501 |
| 1001 | + Delete an existing collection. Serverless indexes do not support collections. # noqa: E501 |
1002 | 1002 |
|
1003 | 1003 |
|
1004 | 1004 | Args:
|
@@ -1060,7 +1060,7 @@ async def __delete_collection(self, collection_name, **kwargs):
|
1060 | 1060 | async def __delete_index(self, index_name, **kwargs):
|
1061 | 1061 | """Delete an index # noqa: E501
|
1062 | 1062 |
|
1063 |
| - This operation deletes an existing index. # noqa: E501 |
| 1063 | + Delete an existing index. # noqa: E501 |
1064 | 1064 |
|
1065 | 1065 |
|
1066 | 1066 | Args:
|
@@ -1122,7 +1122,7 @@ async def __delete_index(self, index_name, **kwargs):
|
1122 | 1122 | async def __describe_collection(self, collection_name, **kwargs):
|
1123 | 1123 | """Describe a collection # noqa: E501
|
1124 | 1124 |
|
1125 |
| - This operation gets a description of a collection. Serverless indexes do not support collections. # noqa: E501 |
| 1125 | + Get a description of a collection. Serverless indexes do not support collections. # noqa: E501 |
1126 | 1126 |
|
1127 | 1127 |
|
1128 | 1128 | Args:
|
@@ -1246,7 +1246,7 @@ async def __describe_index(self, index_name, **kwargs):
|
1246 | 1246 | async def __list_collections(self, **kwargs):
|
1247 | 1247 | """List collections # noqa: E501
|
1248 | 1248 |
|
1249 |
| - This operation returns a list of all collections in a project. Serverless indexes do not support collections. # noqa: E501 |
| 1249 | + List all collections in a project. Serverless indexes do not support collections. # noqa: E501 |
1250 | 1250 |
|
1251 | 1251 |
|
1252 | 1252 |
|
@@ -1299,7 +1299,7 @@ async def __list_collections(self, **kwargs):
|
1299 | 1299 | async def __list_indexes(self, **kwargs):
|
1300 | 1300 | """List indexes # noqa: E501
|
1301 | 1301 |
|
1302 |
| - This operation returns a list of all indexes in a project. # noqa: E501 |
| 1302 | + List all indexes in a project. # noqa: E501 |
1303 | 1303 |
|
1304 | 1304 |
|
1305 | 1305 |
|
|
0 commit comments