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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.12.0.dev1
+Version: 0.12.0.dev3
 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)
@@ -643,14 +645,32 @@ Both methods return `None` on success. `source` and `destination` must point to
 
 #### Accessing Metadata
 
-Use `metadata()` to access metadata of a file:
+Use `get_metadata()` to access metadata of a file or folder:
 
 ```python
-metadata = await async_client.files.metadata(
+# Sync client
+metadata = sync_client.files.get_metadata(
+    url=sync_client.my_files_home() / "relative_folder/my-file.txt"
+)
+
+# Async client
+metadata = await async_client.files.get_metadata(
     url=await async_client.my_files_home() / "relative_folder/my-file.txt"
 )
 ```
 
+Folder metadata can be paginated with `limit` and `token`:
+
+```python
+metadata = await async_client.files.get_metadata(
+    url=await async_client.my_files_home() / "relative_folder/",
+    limit=100,
+    token=next_token,
+)
+next_token = metadata.next_token
+items = metadata.items
+```
+
 Example of metadata:
 
 ```python
@@ -663,6 +683,7 @@ FileMetadata(
     resource_type="FILE",
     content_length=12,
     content_type="application/octet-stream",
+    next_token=None,
     items=None,
     updatedAt=1724836248936,
     etag="9749fad13d6e7092a6337c4af9d83764",
@@ -878,6 +899,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.dev3}/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)
@@ -621,14 +623,32 @@ Both methods return `None` on success. `source` and `destination` must point to
 
 #### Accessing Metadata
 
-Use `metadata()` to access metadata of a file:
+Use `get_metadata()` to access metadata of a file or folder:
 
 ```python
-metadata = await async_client.files.metadata(
+# Sync client
+metadata = sync_client.files.get_metadata(
+    url=sync_client.my_files_home() / "relative_folder/my-file.txt"
+)
+
+# Async client
+metadata = await async_client.files.get_metadata(
     url=await async_client.my_files_home() / "relative_folder/my-file.txt"
 )
 ```
 
+Folder metadata can be paginated with `limit` and `token`:
+
+```python
+metadata = await async_client.files.get_metadata(
+    url=await async_client.my_files_home() / "relative_folder/",
+    limit=100,
+    token=next_token,
+)
+next_token = metadata.next_token
+items = metadata.items
+```
+
 Example of metadata:
 
 ```python
@@ -641,6 +661,7 @@ FileMetadata(
     resource_type="FILE",
     content_length=12,
     content_type="application/octet-stream",
+    next_token=None,
     items=None,
     updatedAt=1724836248936,
     etag="9749fad13d6e7092a6337c4af9d83764",
@@ -856,6 +877,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.dev3}/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.dev3}/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.dev3}/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.dev1 → aidial_client-0.12.0.dev3}/aidial_client/resources/files.py

@@ -138,10 +138,18 @@ class Files(Resource, DialStorageResourceMixin):
             on_http_error=_files_error_processor,
         )
 
-    def get_metadata(self, url: str | PurePosixPath) -> FileMetadata:
+    def get_metadata(
+        self,
+        url: str | PurePosixPath,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
+    ) -> FileMetadata:
         return self.metadata.get(
             resource="files",
             relative_url=self.get_api_path(str(url)),
+            limit=limit,
+            token=token,
         )
 
 
@@ -257,8 +265,16 @@ class AsyncFiles(AsyncResource, DialStorageResourceMixin):
             on_http_error=_files_error_processor,
         )
 
-    async def get_metadata(self, url: str | PurePosixPath) -> FileMetadata:
+    async def get_metadata(
+        self,
+        url: str | PurePosixPath,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
+    ) -> FileMetadata:
         return await self.metadata.get(
             resource="files",
             relative_url=self.get_api_path(str(url)),
+            limit=limit,
+            token=token,
         )

{aidial_client-0.12.0.dev1 → aidial_client-0.12.0.dev3}/aidial_client/resources/metadata.py

@@ -5,6 +5,7 @@ from typing_extensions import assert_never
 
 from aidial_client._constants import METADATA_PREFIX
 from aidial_client._internal_types._http_request import FinalRequestOptions
+from aidial_client._utils._dict import remove_none
 from aidial_client.helpers.storage_resource import StorageResourceType
 from aidial_client.resources.base import AsyncResource, Resource
 from aidial_client.types.metadata import (
@@ -30,29 +31,48 @@ def _get_cast_to(
 class Metadata(Resource):
     @overload
     def get(
-        self, resource: Literal["files"], relative_url: str
+        self,
+        resource: Literal["files"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> FileMetadata: ...
 
     @overload
     def get(
-        self, resource: Literal["conversations"], relative_url: str
+        self,
+        resource: Literal["conversations"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> ConversationMetadata: ...
 
     @overload
     def get(
-        self, resource: Literal["prompts"], relative_url: str
+        self,
+        resource: Literal["prompts"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> PromptMetadata: ...
 
     def get(
         self,
         resource: StorageResourceType,
         relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> FileMetadata | ConversationMetadata | PromptMetadata:
         return self.http_client.request(
             cast_to=_get_cast_to(resource),
             options=FinalRequestOptions(
                 method="GET",
                 url=urljoin(METADATA_PREFIX, relative_url),
+                params=remove_none({"limit": limit, "token": token}),
             ),
         )
 
@@ -60,28 +80,47 @@ class Metadata(Resource):
 class AsyncMetadata(AsyncResource):
     @overload
     async def get(
-        self, resource: Literal["files"], relative_url: str
+        self,
+        resource: Literal["files"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> FileMetadata: ...
 
     @overload
     async def get(
-        self, resource: Literal["conversations"], relative_url: str
+        self,
+        resource: Literal["conversations"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> ConversationMetadata: ...
 
     @overload
     async def get(
-        self, resource: Literal["prompts"], relative_url: str
+        self,
+        resource: Literal["prompts"],
+        relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> PromptMetadata: ...
 
     async def get(
         self,
         resource: StorageResourceType,
         relative_url: str,
+        *,
+        limit: int | None = None,
+        token: str | None = None,
     ) -> FileMetadata | ConversationMetadata | PromptMetadata:
         return await self.http_client.request(
             cast_to=_get_cast_to(resource),
             options=FinalRequestOptions(
                 method="GET",
                 url=urljoin(METADATA_PREFIX, relative_url),
+                params=remove_none({"limit": limit, "token": token}),
             ),
         )

aidial_client-0.12.0.dev3/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.dev1 → aidial_client-0.12.0.dev3}/aidial_client/types/metadata.py

@@ -37,6 +37,7 @@ class FileMetadata(BaseMetadata):
     resource_type: Literal["FILE"]
     content_length: int | None = None
     content_type: str | None = None
+    next_token: str | None = None
     items: list[FileItem] | None = None
     etag: str | None = None
 

aidial_client-0.12.0.dev3/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.dev3}/pyproject.toml

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