Merge pull request #68 from pinecone-io/ch8549

Setting user agent instead of headers in the client

Author: rajat08

pinecone/core/utils/__init__.py

@@ -6,6 +6,9 @@
 from pathlib import Path
 from typing import List
 
+import requests
+import urllib3
+
 try:
     from pinecone.core.grpc.protos import vector_column_service_pb2
     import numpy as np
@@ -57,3 +60,10 @@ def _generate_request_id() -> str:
 def fix_tuple_length(t, n):
     """Extend tuple t to length n by adding None items at the end of the tuple. Return the new tuple."""
     return t + ((None,) * (n - len(t))) if len(t) < n else t
+
+
+def get_user_agent():
+    client_id = f'python-client-{get_version()}'
+    user_agent_details = {'requests': requests.__version__, 'urllib3': urllib3.__version__}
+    user_agent = '{} ({})'.format(client_id, ', '.join([f'{k}:{v}' for k, v in user_agent_details.items()]))
+    return user_agent

pinecone/index.py

@@ -9,9 +9,8 @@
 from pinecone.core.utils.sentry import sentry_decorator as sentry
 from .core.client.models import FetchResponse, ProtobufAny, QueryRequest, QueryResponse, QueryVector, RpcStatus, \
     ScoredVector, SingleQueryResults, DescribeIndexStatsResponse, UpsertRequest, UpsertResponse, Vector
-from .core.utils.constants import CLIENT_VERSION_HEADER, CLIENT_ID
 from pinecone.core.client.api.vector_operations_api import VectorOperationsApi
-from pinecone.core.utils import fix_tuple_length
+from pinecone.core.utils import fix_tuple_length, get_user_agent
 
 __all__ = [
     "Index", "FetchResponse", "ProtobufAny", "QueryRequest", "QueryResponse", "QueryVector", "RpcStatus",
@@ -42,7 +41,7 @@ def __init__(self, index_name: str, pool_threads=1):
             **openapi_client_config.server_variables
         }
         super().__init__(configuration=openapi_client_config, pool_threads=pool_threads)
-        self.set_default_header(CLIENT_VERSION_HEADER, CLIENT_ID)
+        self.user_agent = get_user_agent()
         self._vector_api = VectorOperationsApi(self)
 
     @sentry

pinecone/manage.py

@@ -12,8 +12,8 @@
 from pinecone.core.client.configuration import Configuration
 from pinecone.core.client.model.create_request import CreateRequest
 from pinecone.core.client.model.patch_request import PatchRequest
-from pinecone.core.utils.constants import CLIENT_VERSION_HEADER, CLIENT_ID
 from pinecone.core.utils.sentry import sentry_decorator as sentry
+from pinecone.core.utils import get_user_agent
 
 __all__ = [
     "create_index", "delete_index", "describe_index", "list_indexes", "scale_index", "IndexDescription"
@@ -30,6 +30,7 @@ class IndexDescription(NamedTuple):
     index_config: None
     status: None
 
+
 def _get_api_instance():
     client_config = Config.OPENAPI_CONFIG
     client_config.api_key = client_config.api_key or {}
@@ -41,7 +42,7 @@ def _get_api_instance():
         **client_config.server_variables
     }
     api_client = ApiClient(configuration=client_config)
-    api_client.set_default_header(CLIENT_VERSION_HEADER, CLIENT_ID)
+    api_client.user_agent = get_user_agent()
     api_instance = IndexOperationsApi(api_client)
     return api_instance
 
@@ -158,7 +159,7 @@ def describe_index(name: str):
     ready = response['status']['ready']
     return IndexDescription(name=db['name'], index_type=db['index_type'], metric=db['metric'],
                             replicas=db['replicas'], dimension=db['dimension'], shards=db['shards'],
-                            index_config=db['index_config'],status={'ready':ready})
+                            index_config=db['index_config'], status={'ready': ready})
 
 
 @sentry