Merge pull request #64 from pinecone-io/sc-15047/refine-metadata-config-structure

rename metadata_index_config to metadata_config

Author: yarden-slon

pinecone/core/client/model/create_request.py

@@ -95,7 +95,7 @@ def openapi_types():
             'shards': (int,),  # noqa: E501
             'pod_type': (str,),  # noqa: E501
             'index_config': (dict,),  # noqa: E501
-            'metadata_index_config': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,),  # noqa: E501
+            'metadata_config': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -113,7 +113,7 @@ def discriminator():
         'shards': 'shards',  # noqa: E501
         'pod_type': 'pod_type',  # noqa: E501
         'index_config': 'index_config',  # noqa: E501
-        'metadata_index_config': 'metadata_index_config',  # noqa: E501
+        'metadata_config': 'metadata_config',  # noqa: E501
     }
 
     read_only_vars = {
@@ -168,7 +168,7 @@ def _from_openapi_data(cls, name, dimension, *args, **kwargs):  # noqa: E501
             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
             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
             index_config (dict): [optional]  # noqa: E501
-            metadata_index_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
+            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
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -263,7 +263,7 @@ def __init__(self, name, dimension, *args, **kwargs):  # noqa: E501
             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
             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
             index_config (dict): [optional]  # noqa: E501
-            metadata_index_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
+            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
         """
 
         _check_type = kwargs.pop('_check_type', True)

pinecone/manage.py

@@ -30,7 +30,7 @@ class IndexDescription(NamedTuple):
     pod_type: str
     index_config: None
     status: None
-    metadata_index_config: None
+    metadata_config: None
 
 
 def _get_api_instance():
@@ -66,7 +66,7 @@ def create_index(
         pods: int = 1,
         pod_type: str = 'p1',
         index_config: dict = None,
-        metadata_index_config: dict = None
+        metadata_config: dict = None
 ):
     """Creates a Pinecone index.
 
@@ -95,8 +95,8 @@ def create_index(
     :param pod_type: the pod type to be used for the index. can be one of p1 or s1.
     :type pod_type: str,optional
     :param index_config: Advanced configuration options for the index
-    :param metadata_index_config: Configuration related to the metadata index
-    :type metadata_index_config: dict, optional
+    :param metadata_config: Configuration related to the metadata index
+    :type metadata_config: dict, optional
     :type timeout: int, optional
     :param timeout: Timeout for wait until index gets ready. If None, wait indefinitely; if >=0, time out after this many seconds; if -1, return immediately and do not wait. Default: None
     """
@@ -112,7 +112,7 @@ def create_index(
         pods=pods,
         pod_type=pod_type,
         index_config=index_config or {},
-        metadata_index_config=metadata_index_config
+        metadata_config=metadata_config
     ))
 
     def is_ready():
@@ -186,7 +186,7 @@ def describe_index(name: str):
     return IndexDescription(name=db['name'], index_type=db['index_type'], metric=db['metric'],
                             replicas=db['replicas'], dimension=db['dimension'], shards=db['shards'],
                             pods=db.get('pods', db['shards']*db['replicas']), pod_type=db.get('pod_type', 'p1'),
-                            index_config=db['index_config'], status={'ready': ready, 'state': state}, metadata_index_config=db.get('metadata_index_config'))
+                            index_config=db['index_config'], status={'ready': ready, 'state': state}, metadata_config=db.get('metadata_config'))
 
 
 def scale_index(name: str, replicas: int):

specs/index_service.json

@@ -278,7 +278,7 @@
               }
             ]
           },
-          "metadata_index_config": {
+          "metadata_config": {
             "type": "object",
             "description": "Configuration for the behavior of Pinecone's internal metadata index",
             "nullable": true

specs/pinecone_api.json

@@ -1152,7 +1152,7 @@
               }
             ]
           },
-          "metadata_index_config": {
+          "metadata_config": {
             "type": "object",
             "description": "Configuration for the behavior of Pinecone's internal metadata index",
             "nullable": true