aidial-client 0.18.0.dev3__tar.gz → 0.18.0.dev5__tar.gz

{aidial_client-0.18.0.dev3 → aidial_client-0.18.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.18.0.dev3
+Version: 0.18.0.dev5
 Summary: A Python client library for the AI DIAL API
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -42,6 +42,7 @@ Description-Content-Type: text/markdown
   - [Lifecycle Management](#lifecycle-management)
   - [Deployments](#deployments)
     - [List Deployments](#list-deployments)
+    - [List Deployment Names](#list-deployment-names)
     - [Get Deployment by Id](#get-deployment-by-id)
     - [Get Deployment Configuration](#get-deployment-configuration)
   - [Make Chat Completions Requests](#make-chat-completions-requests)
@@ -246,6 +247,29 @@ deployments = await async_client.deployments.list()
 ]
 ```
 
+#### List Deployment Names
+
+To get a lightweight list of the names and kinds of all deployments available to the caller (models, applications and toolsets), without loading their full definitions:
+
+```python
+# Sync
+names = client.deployments.list_names()
+# Async
+names = await async_client.deployments.list_names()
+
+# Only some kinds: "model", "application", "toolset"
+names = client.deployments.list_names(types=["model", "toolset"])
+```
+
+```pycon
+>>> client.deployments.list_names()
+[
+    DeploymentName(id='gpt-35-turbo', object='model'),
+    DeploymentName(id='my-app', object='application'),
+    DeploymentName(id='git', object='toolset'),
+]
+```
+
 #### Get Deployment by Id
 
 To fetch a single deployment by its identifier:

{aidial_client-0.18.0.dev3 → aidial_client-0.18.0.dev5}/README.md

@@ -20,6 +20,7 @@
   - [Lifecycle Management](#lifecycle-management)
   - [Deployments](#deployments)
     - [List Deployments](#list-deployments)
+    - [List Deployment Names](#list-deployment-names)
     - [Get Deployment by Id](#get-deployment-by-id)
     - [Get Deployment Configuration](#get-deployment-configuration)
   - [Make Chat Completions Requests](#make-chat-completions-requests)
@@ -224,6 +225,29 @@ deployments = await async_client.deployments.list()
 ]
 ```
 
+#### List Deployment Names
+
+To get a lightweight list of the names and kinds of all deployments available to the caller (models, applications and toolsets), without loading their full definitions:
+
+```python
+# Sync
+names = client.deployments.list_names()
+# Async
+names = await async_client.deployments.list_names()
+
+# Only some kinds: "model", "application", "toolset"
+names = client.deployments.list_names(types=["model", "toolset"])
+```
+
+```pycon
+>>> client.deployments.list_names()
+[
+    DeploymentName(id='gpt-35-turbo', object='model'),
+    DeploymentName(id='my-app', object='application'),
+    DeploymentName(id='git', object='toolset'),
+]
+```
+
 #### Get Deployment by Id
 
 To fetch a single deployment by its identifier:

{aidial_client-0.18.0.dev3 → aidial_client-0.18.0.dev5}/aidial_client/resources/deployments.py

@@ -1,8 +1,37 @@
+import builtins
+from collections.abc import Sequence
 from typing import Any
 
+import httpx
+
+from aidial_client._exception import ParsingDataError
 from aidial_client._internal_types._http_request import FinalRequestOptions
 from aidial_client.resources.base import AsyncResource, Resource
-from aidial_client.types.deployment import Deployment, DeploymentsResponse
+from aidial_client.types.deployment import (
+    Deployment,
+    DeploymentKind,
+    DeploymentName,
+    DeploymentsResponse,
+)
+
+
+def _names_options(
+    types: Sequence[DeploymentKind] | None,
+) -> FinalRequestOptions:
+    return FinalRequestOptions(
+        method="GET",
+        url="v1/deployment-names",
+        params={"type": ",".join(types)} if types else None,
+    )
+
+
+def _parse_names(response: httpx.Response) -> list[DeploymentName]:
+    try:
+        return [DeploymentName(**item) for item in response.json()]
+    except Exception as e:
+        raise ParsingDataError(
+            message=f"Error during parsing of response data: {str(e)}"
+        )
 
 
 class Deployments(Resource):
@@ -15,6 +44,14 @@ class Deployments(Resource):
     def list(self) -> list[Deployment]:
         return self._list_raw().data
 
+    def list_names(
+        self, types: Sequence[DeploymentKind] | None = None
+    ) -> builtins.list[DeploymentName]:
+        response = self.http_client.request(
+            cast_to=httpx.Response, options=_names_options(types)
+        )
+        return _parse_names(response)
+
     def get(self, deployment_id: str) -> Deployment:
         return self.http_client.request(
             cast_to=Deployment,
@@ -43,6 +80,14 @@ class AsyncDeployments(AsyncResource):
     async def list(self) -> list[Deployment]:
         return (await self._list_raw()).data
 
+    async def list_names(
+        self, types: Sequence[DeploymentKind] | None = None
+    ) -> builtins.list[DeploymentName]:
+        response = await self.http_client.request(
+            cast_to=httpx.Response, options=_names_options(types)
+        )
+        return _parse_names(response)
+
     async def get(self, deployment_id: str) -> Deployment:
         return await self.http_client.request(
             cast_to=Deployment,

{aidial_client-0.18.0.dev3 → aidial_client-0.18.0.dev5}/aidial_client/types/deployment.py

@@ -60,3 +60,11 @@ class Deployment(DeploymentBase):
 class DeploymentsResponse(ExtraAllowModel):
     data: list[Deployment]
     object: Literal["list"]
+
+
+DeploymentKind = Literal["model", "application", "toolset"]
+
+
+class DeploymentName(ExtraAllowModel):
+    id: str
+    object: str

{aidial_client-0.18.0.dev3 → aidial_client-0.18.0.dev5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aidial-client"
-version = "0.18.0.dev3"
+version = "0.18.0.dev5"
 description = "A Python client library for the AI DIAL API"
 readme = "README.md"
 license = "Apache-2.0"