Merge pull request #56 from pinecone-io/feature/metadata-index-config

Adds the ability to specifiy metadata index configuration

Author: mutayroei

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Added support of querying by a single vector.
   - This is a step in deprecating batch queries.
 - Added support of querying by vector id.
+- Adds support to specify what metadata fields should be indexed on index creation using the ```index_metadata_config``` option.
 
 ## [2.0.10](https://github.com/pinecone-io/pinecone-python-client/compare/v2.0.9...v2.0.10)
 ### Changed

pinecone/core/client/model/create_request.py

@@ -95,6 +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
         }
 
     @cached_property
@@ -112,6 +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
     }
 
     read_only_vars = {
@@ -166,6 +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
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -260,6 +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
         """
 
         _check_type = kwargs.pop('_check_type', True)

pinecone/core/client/model/index_meta_database_status.py

@@ -60,6 +60,13 @@ class IndexMetaDatabaseStatus(ModelNormal):
     """
 
     allowed_values = {
+        ('state',): {
+            'INITIALIZING': "Initializing",
+            'SCALINGUP': "ScalingUp",
+            'SCALINGDOWN': "ScalingDown",
+            'TERMINATING': "Terminating",
+            'READY': "Ready",
+        },
     }
 
     validations = {

pinecone/manage.py

@@ -30,6 +30,7 @@ class IndexDescription(NamedTuple):
     pod_type: str
     index_config: None
     status: None
+    metadata_index_config: None
 
 
 def _get_api_instance():
@@ -64,7 +65,8 @@ def create_index(
         shards: int = 1,
         pods: int = 1,
         pod_type: str = 'p1',
-        index_config: dict = None
+        index_config: dict = None,
+        metadata_index_config: dict = None
 ):
     """Creates a Pinecone index.
 
@@ -93,6 +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
     :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
     """
@@ -107,7 +111,8 @@ def create_index(
         shards=shards,
         pods=pods,
         pod_type=pod_type,
-        index_config=index_config or {}
+        index_config=index_config or {},
+        metadata_index_config=metadata_index_config
     ))
 
     def is_ready():
@@ -181,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})
+                            index_config=db['index_config'], status={'ready': ready, 'state': state}, metadata_index_config=db.get('metadata_index_config'))
 
 
 def scale_index(name: str, replicas: int):

specs/index_service.json

@@ -267,7 +267,7 @@
             "default": 1
           },
           "pod_type": {
-            "type" : "string",
+            "type": "string",
             "description": "The type of pod to use. One of 's1' or 'p1'.",
             "default": "p1"
           },
@@ -277,6 +277,11 @@
                 "$ref": "#/components/schemas/ApproximatedConfig"
               }
             ]
+          },
+          "metadata_index_config": {
+            "type": "object",
+            "description": "Configuration for the behavior of Pinecone's internal metadata index",
+            "nullable": true
           }
         }
       },
@@ -317,7 +322,7 @@
                   }
                 ]
               },
-              "status" : {
+              "status": {
                 "type": "object",
                 "properties": {
                   "ready": {
@@ -394,4 +399,4 @@
     "description": "More Pinecone.io API docs",
     "url": "https://www.pinecone.io/docs"
   }
-}
+}

specs/pinecone_api.json

@@ -1151,6 +1151,11 @@
                 "$ref": "#/components/schemas/ApproximatedConfig"
               }
             ]
+          },
+          "metadata_index_config": {
+            "type": "object",
+            "description": "Configuration for the behavior of Pinecone's internal metadata index",
+            "nullable": true
           }
         }
       },
@@ -1198,7 +1203,14 @@
                     "type": "boolean"
                   },
                   "state": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                      "Initializing",
+                      "ScalingUp",
+                      "ScalingDown",
+                      "Terminating",
+                      "Ready"
+                    ]
                   }
                 }
               }