nucliadb-utils 5.0.1.post1147__py3-none-any.whl → 5.0.1.post1161__py3-none-any.whl

nucliadb_utils/aiopynecone/client.py

@@ -32,11 +32,13 @@ from nucliadb_telemetry.metrics import INF, Histogram, Observer
 from nucliadb_utils.aiopynecone.exceptions import (
     PineconeAPIError,
     PineconeRateLimitError,
+    RetriablePineconeAPIError,
     raise_for_status,
 )
 from nucliadb_utils.aiopynecone.models import (
     CreateIndexRequest,
     CreateIndexResponse,
+    IndexDescription,
     IndexStats,
     ListResponse,
     QueryResponse,
@@ -93,9 +95,11 @@ MAX_LIST_PAGE_SIZE = 100
 
 RETRIABLE_EXCEPTIONS = (
     PineconeRateLimitError,
+    RetriablePineconeAPIError,
     httpx.ConnectError,
     httpx.NetworkError,
     httpx.WriteTimeout,
+    httpx.ReadTimeout,
 )
 
 
@@ -156,6 +160,18 @@ class ControlPlane:
             return
         raise_for_status("delete_index", response)
 
+    @pinecone_observer.wrap({"type": "describe_index"})
+    async def describe_index(self, name: str) -> IndexDescription:
+        """
+        Describe an index in Pinecone.
+        Params:
+        - `name`: The name of the index to describe.
+        """
+        headers = {"Api-Key": self.api_key}
+        response = await self.http_session.get(f"/indexes/{name}", headers=headers)
+        raise_for_status("describe_index", response)
+        return IndexDescription.model_validate(response.json())
+
 
 class DataPlane:
     """

nucliadb_utils/aiopynecone/exceptions.py

@@ -24,7 +24,7 @@ import httpx
 
 from nucliadb_telemetry.metrics import Counter
 
-pinecone_errors_counter = Counter("pinecone_errors", labels={"type": ""})
+pinecone_errors_counter = Counter("pinecone_errors", labels={"type": "", "status_code": ""})
 
 
 class PineconeAPIError(Exception):
@@ -52,7 +52,15 @@ class PineconeAPIError(Exception):
         super().__init__(exc_message)
 
 
-class PineconeRateLimitError(PineconeAPIError):
+class RetriablePineconeAPIError(PineconeAPIError):
+    """
+    Raised when the client can retry the operation.
+    """
+
+    pass
+
+
+class PineconeRateLimitError(RetriablePineconeAPIError):
     """
     Raised when the client has exceeded the rate limit to be able to backoff and retry.
     """
@@ -80,7 +88,7 @@ def raise_for_status(operation: str, response: httpx.Response):
     try:
         response.raise_for_status()
     except httpx.HTTPStatusError:
-        pinecone_errors_counter.inc(labels={"type": operation})
+        pinecone_errors_counter.inc(labels={"type": operation, "status_code": str(response.status_code)})
         code = None
         message = None
         details = None
@@ -106,6 +114,15 @@ def raise_for_status(operation: str, response: httpx.Response):
                 message=message,
                 details=details,
             )
+
+        if str(response.status_code).startswith("5"):
+            raise RetriablePineconeAPIError(
+                http_status_code=response.status_code,
+                code=code,
+                message=message,
+                details=details,
+            )
+
         raise PineconeAPIError(
             http_status_code=response.status_code,
             code=code,

nucliadb_utils/aiopynecone/models.py

@@ -29,6 +29,7 @@ from nucliadb_utils.aiopynecone.exceptions import MetadataTooLargeError
 KILO_BYTE = 1024
 MAX_METADATA_SIZE = 40 * KILO_BYTE
 MAX_INDEX_NAME_LENGTH = 45
+MAX_VECTOR_ID_LENGTH = 512
 
 
 # Requests
@@ -64,7 +65,7 @@ class CreateIndexRequest(BaseModel):
 
 
 class Vector(BaseModel):
-    id: str = Field(min_length=1, max_length=512)
+    id: str = Field(min_length=1, max_length=MAX_VECTOR_ID_LENGTH)
     values: list[float]
     metadata: dict[str, Any] = {}
 
@@ -122,3 +123,17 @@ class IndexStats(BaseModel):
     dimension: int
     namespaces: dict[str, IndexNamespaceStats] = {}
     totalVectorCount: int
+
+
+class IndexStatus(BaseModel):
+    ready: bool
+    state: str
+
+
+class IndexDescription(BaseModel):
+    dimension: int
+    host: str
+    metric: str
+    name: str
+    spec: dict[str, Any]
+    status: IndexStatus

{nucliadb_utils-5.0.1.post1147.dist-info → nucliadb_utils-5.0.1.post1161.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nucliadb_utils
-Version: 5.0.1.post1147
+Version: 5.0.1.post1161
 Home-page: https://nuclia.com
 License: BSD
 Classifier: Development Status :: 4 - Beta
@@ -24,8 +24,8 @@ Requires-Dist: PyNaCl
 Requires-Dist: pyjwt>=2.4.0
 Requires-Dist: memorylru>=1.1.2
 Requires-Dist: mrflagly>=0.2.9
-Requires-Dist: nucliadb-protos>=5.0.1.post1147
-Requires-Dist: nucliadb-telemetry>=5.0.1.post1147
+Requires-Dist: nucliadb-protos>=5.0.1.post1161
+Requires-Dist: nucliadb-telemetry>=5.0.1.post1161
 Provides-Extra: cache
 Requires-Dist: redis>=4.3.4; extra == "cache"
 Requires-Dist: orjson>=3.6.7; extra == "cache"

{nucliadb_utils-5.0.1.post1147.dist-info → nucliadb_utils-5.0.1.post1161.dist-info}/RECORD

@@ -18,9 +18,9 @@ nucliadb_utils/store.py,sha256=kQ35HemE0v4_Qg6xVqNIJi8vSFAYQtwI3rDtMsNy62Y,890
 nucliadb_utils/transaction.py,sha256=mwcI3aIHAvU5KOGqd_Uz_d1XQzXhk_-NWY8NqU1lfb0,7307
 nucliadb_utils/utilities.py,sha256=idajCm_4Sojh7b3HTkP0fTfG2Mb6PIB9xtMmcfB7Nl0,15758
 nucliadb_utils/aiopynecone/__init__.py,sha256=cp15ZcFnHvpcu_5-aK2A4uUyvuZVV_MJn4bIXMa20ks,835
-nucliadb_utils/aiopynecone/client.py,sha256=3DGJuHXO9Vm83atMLD4fd2FTz8SAr8RvPCGU_bXH9Ho,22333
-nucliadb_utils/aiopynecone/exceptions.py,sha256=yfUXIADRuhPb2rNynoFRlpQ6QINm1EkmvT_BbZ7dv8I,3536
-nucliadb_utils/aiopynecone/models.py,sha256=ketK2IYLWiwFZ76rnJmwfcuopFJrCAtCUszdTSurm_Q,3236
+nucliadb_utils/aiopynecone/client.py,sha256=MPyHnDXwhukJr7U3CJh7BpsekfSuOkyM4g5b9LLtzc8,22941
+nucliadb_utils/aiopynecone/exceptions.py,sha256=fUErx3ceKQK1MUbOnYcZhIzpNe8UVAptZE9JIRDLXDE,4000
+nucliadb_utils/aiopynecone/models.py,sha256=XkNIZx4bxdbVo9zYVn8IRp70q4DWUMWN79ybGloFj2Q,3492
 nucliadb_utils/audit/__init__.py,sha256=cp15ZcFnHvpcu_5-aK2A4uUyvuZVV_MJn4bIXMa20ks,835
 nucliadb_utils/audit/audit.py,sha256=0RoJxK_SesKD9cbNMqCtpT4ylznFxEcHsetyh1eRlEk,3023
 nucliadb_utils/audit/basic.py,sha256=g-790vVvua6OrUkHGBjvgz2TaZt21dWoZw3XiYptt_E,3634
@@ -64,8 +64,8 @@ nucliadb_utils/tests/indexing.py,sha256=YW2QhkhO9Q_8A4kKWJaWSvXvyQ_AiAwY1VylcfVQ
 nucliadb_utils/tests/local.py,sha256=7nuP8EFUAiA8ZH50R1iPV9EUXBySQxOanVm3Zht_e0g,1835
 nucliadb_utils/tests/nats.py,sha256=xqpww4jZjTKY9oPGlJdDJG67L3FIBQsa9qDHxILR8r8,7687
 nucliadb_utils/tests/s3.py,sha256=IdMxK_cNdSHLvO1u8BwsKFzD87Hk1MVPDZ57zx6h-rA,3656
-nucliadb_utils-5.0.1.post1147.dist-info/METADATA,sha256=-siJoEePC1p-18v24n5PZIMexzE9-mmkYG8i5G3yG0A,2071
-nucliadb_utils-5.0.1.post1147.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
-nucliadb_utils-5.0.1.post1147.dist-info/top_level.txt,sha256=fE3vJtALTfgh7bcAWcNhcfXkNPp_eVVpbKK-2IYua3E,15
-nucliadb_utils-5.0.1.post1147.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-nucliadb_utils-5.0.1.post1147.dist-info/RECORD,,
+nucliadb_utils-5.0.1.post1161.dist-info/METADATA,sha256=mXTMDPpBvfKcHYY4DAKKsiPsP0slBW3JuwSulGzGDww,2071
+nucliadb_utils-5.0.1.post1161.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+nucliadb_utils-5.0.1.post1161.dist-info/top_level.txt,sha256=fE3vJtALTfgh7bcAWcNhcfXkNPp_eVVpbKK-2IYua3E,15
+nucliadb_utils-5.0.1.post1161.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+nucliadb_utils-5.0.1.post1161.dist-info/RECORD,,