aidial-client 0.12.0.dev1__tar.gz → 0.12.0.dev2__tar.gz

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.12.0.dev1
+Version: 0.12.0.dev2
 Summary: A Python client library for the AI DIAL API
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -61,6 +61,8 @@ Description-Content-Type: text/markdown
       - [Get Application by Id](#get-application-by-id)
   - [Models](#models)
       - [Get Model by Name](#get-model-by-name)
+  - [User](#user)
+      - [Get Authenticated User Info](#get-authenticated-user-info)
   - [Toolsets](#toolsets)
       - [Get Toolset by Id](#get-toolset-by-id)
   - [Resource Permissions](#resource-permissions)
@@ -878,6 +880,48 @@ ModelInfo(
 )
 ```
 
+### User
+
+#### Get Authenticated User Info
+
+To retrieve information about the currently authenticated user:
+
+```python
+# Sync
+user_info = client.user.info()
+
+# Async
+user_info = await async_client.user.info()
+```
+
+As a result, you will receive a `UserInfo` object. When authenticated with an
+API key:
+
+```python
+UserInfo(
+    roles=["default"],
+    project="PROJECT-NAME",
+    userClaims=None,
+)
+```
+
+When authenticated with an access token:
+
+```python
+UserInfo(
+    roles=["BA"],
+    project=None,
+    userClaims={
+        "email": ["user_email"],
+        "sub": ["user_sub"],
+    },
+)
+```
+
+`userClaims` is returned as an opaque `dict` because its contents depend on the
+identity provider. `UserInfo` also preserves any additional fields the DIAL
+deployment may return, so forward compatibility is retained.
+
 ### Toolsets
 
 #### Get Toolset by Id

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/README.md

@@ -39,6 +39,8 @@
       - [Get Application by Id](#get-application-by-id)
   - [Models](#models)
       - [Get Model by Name](#get-model-by-name)
+  - [User](#user)
+      - [Get Authenticated User Info](#get-authenticated-user-info)
   - [Toolsets](#toolsets)
       - [Get Toolset by Id](#get-toolset-by-id)
   - [Resource Permissions](#resource-permissions)
@@ -856,6 +858,48 @@ ModelInfo(
 )
 ```
 
+### User
+
+#### Get Authenticated User Info
+
+To retrieve information about the currently authenticated user:
+
+```python
+# Sync
+user_info = client.user.info()
+
+# Async
+user_info = await async_client.user.info()
+```
+
+As a result, you will receive a `UserInfo` object. When authenticated with an
+API key:
+
+```python
+UserInfo(
+    roles=["default"],
+    project="PROJECT-NAME",
+    userClaims=None,
+)
+```
+
+When authenticated with an access token:
+
+```python
+UserInfo(
+    roles=["BA"],
+    project=None,
+    userClaims={
+        "email": ["user_email"],
+        "sub": ["user_sub"],
+    },
+)
+```
+
+`userClaims` is returned as an opaque `dict` because its contents depend on the
+identity provider. `UserInfo` also preserves any additional fields the DIAL
+deployment may return, so forward compatibility is retained.
+
 ### Toolsets
 
 #### Get Toolset by Id

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/aidial_client/__init__.py

@@ -12,6 +12,7 @@ from aidial_client._exception import (
 from aidial_client.types.client_channel import SigninResult
 from aidial_client.types.model import ModelInfo, ModelLimits, ModelPricing
 from aidial_client.types.toolset import ToolsetInfo
+from aidial_client.types.user import UserInfo
 
 __all__ = [
     "Dial",
@@ -32,4 +33,5 @@ __all__ = [
     "ModelPricing",
     "ModelLimits",
     "SigninResult",
+    "UserInfo",
 ]

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/aidial_client/_client.py

@@ -120,6 +120,7 @@ class Dial(BaseDialClient[SyncHTTPClient, SyncAuthValue]):
         self.client_channel = resources.ClientChannel(
             http_client=self._http_client
         )
+        self.user = resources.User(http_client=self._http_client)
 
     def _create_http_client(self) -> SyncHTTPClient:
         return SyncHTTPClient(
@@ -224,6 +225,7 @@ class AsyncDial(BaseDialClient[AsyncHTTPClient, AsyncAuthValue]):
         self.client_channel = resources.AsyncClientChannel(
             http_client=self._http_client
         )
+        self.user = resources.AsyncUser(http_client=self._http_client)
 
     def _create_http_client(self) -> AsyncHTTPClient:
         return AsyncHTTPClient(

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/aidial_client/resources/__init__.py

@@ -10,6 +10,7 @@ from aidial_client.resources.resource_permissions import (
     ResourcePermissions,
 )
 from aidial_client.resources.toolset import AsyncToolset, Toolset
+from aidial_client.resources.user import AsyncUser, User
 
 from .application import Application, AsyncApplication
 from .bucket import AsyncBucket, Bucket
@@ -40,4 +41,6 @@ __all__ = [
     "AsyncResourcePermissions",
     "ClientChannel",
     "AsyncClientChannel",
+    "User",
+    "AsyncUser",
 ]

aidial_client-0.12.0.dev2/aidial_client/resources/user.py

@@ -0,0 +1,19 @@
+from aidial_client._internal_types._http_request import FinalRequestOptions
+from aidial_client.resources.base import AsyncResource, Resource
+from aidial_client.types.user import UserInfo
+
+
+class User(Resource):
+    def info(self) -> UserInfo:
+        return self.http_client.request(
+            cast_to=UserInfo,
+            options=FinalRequestOptions(method="GET", url="v1/user/info"),
+        )
+
+
+class AsyncUser(AsyncResource):
+    async def info(self) -> UserInfo:
+        return await self.http_client.request(
+            cast_to=UserInfo,
+            options=FinalRequestOptions(method="GET", url="v1/user/info"),
+        )

aidial_client-0.12.0.dev2/aidial_client/types/user.py

@@ -0,0 +1,11 @@
+from typing import Any
+
+from aidial_client._internal_types._model import ExtraAllowModel
+
+
+class UserInfo(ExtraAllowModel):
+    """Information about the authenticated user or API key."""
+
+    roles: list[str]
+    project: str | None = None
+    userClaims: dict[str, Any] | None = None  # depends on the IdP, so opaque

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev2}/pyproject.toml

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