aidial-client 0.11.0.dev6__tar.gz → 0.12.0.dev2__tar.gz

{aidial_client-0.11.0.dev6 → aidial_client-0.12.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.11.0.dev6
+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)
@@ -554,6 +556,16 @@ result = await async_client.files.download(
 )
 ```
 
+For large async downloads, use `stream_download()` to process bytes as they arrive without buffering the full response in memory:
+
+```python
+async with async_client.files.stream_download(
+    url=await async_client.my_files_home() / "relative_folder/my-file.txt"
+) as result:
+    async for bytes_chunk in result:
+        ...
+```
+
 As a result, you will receive an object of type `FileDownloadResponse`, that you can iterate by byte chunks:
 
 ```python
@@ -868,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.11.0.dev6 → 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)
@@ -532,6 +534,16 @@ result = await async_client.files.download(
 )
 ```
 
+For large async downloads, use `stream_download()` to process bytes as they arrive without buffering the full response in memory:
+
+```python
+async with async_client.files.stream_download(
+    url=await async_client.my_files_home() / "relative_folder/my-file.txt"
+) as result:
+    async for bytes_chunk in result:
+        ...
+```
+
 As a result, you will receive an object of type `FileDownloadResponse`, that you can iterate by byte chunks:
 
 ```python
@@ -846,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.11.0.dev6 → 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.11.0.dev6 → 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.11.0.dev6 → aidial_client-0.12.0.dev2}/aidial_client/_http_client/_async.py

@@ -1,5 +1,5 @@
 import asyncio
-from collections.abc import AsyncIterator, Callable, Mapping
+from collections.abc import AsyncIterator, Mapping
 from contextlib import asynccontextmanager, suppress
 from http import HTTPStatus
 from typing import Any
@@ -8,7 +8,7 @@ import httpx
 
 from aidial_client._auth import AsyncAuthValue, aget_combined_auth_headers
 from aidial_client._exception import DialException
-from aidial_client._http_client._base import BaseHTTPClient
+from aidial_client._http_client._base import BaseHTTPClient, ErrorHandler
 from aidial_client._internal_types._defaults import NOT_GIVEN, NotGiven
 from aidial_client._internal_types._generic import ResponseT
 from aidial_client._internal_types._http_request import FinalRequestOptions
@@ -51,8 +51,7 @@ class AsyncHTTPClient(BaseHTTPClient[httpx.AsyncClient, AsyncAuthValue]):
         options: FinalRequestOptions,
         cast_to: type[ResponseT],
         remaining_retries: int | None = None,
-        on_http_error: Callable[[httpx.HTTPStatusError], DialException | None]
-        | None = None,
+        on_http_error: ErrorHandler | None = None,
     ) -> ResponseT:
         retries = self._remaining_retries(remaining_retries, options)
         auth_headers = await self.auth_headers()
@@ -101,16 +100,37 @@ class AsyncHTTPClient(BaseHTTPClient[httpx.AsyncClient, AsyncAuthValue]):
                     cast_to=cast_to,
                     remaining_retries=retries,
                 )
-            # Try to get a custom error from response status_code/code/message
-            custom_error = on_http_error(err) if on_http_error else None
-            # or fallback to default processing
-            raised_error = custom_error or self._make_dial_error_from_response(
-                err.response
-            )
-            raise raised_error from err
+            self._raise_for_status(response, on_http_error)
 
         return process_block_response(cast_to=cast_to, response=response)
 
+    @asynccontextmanager
+    async def stream(
+        self,
+        *,
+        options: FinalRequestOptions,
+        on_http_error: ErrorHandler | None = None,
+    ) -> AsyncIterator[httpx.Response]:
+        auth_headers = await self.auth_headers()
+        request = self._build_request(options, auth_headers)
+        try:
+            response = await self._internal_http_client.send(
+                request, stream=True
+            )
+        except httpx.TimeoutException as err:
+            raise DialException(
+                message="Request timed out",
+                status_code=HTTPStatus.REQUEST_TIMEOUT,
+            ) from err
+        except httpx.HTTPError as err:
+            raise DialException(message=f"Request failed: {err}") from err
+
+        try:
+            self._raise_for_status(response, on_http_error)
+            yield response
+        finally:
+            await response.aclose()
+
     @asynccontextmanager
     async def stream_sse(
         self,

{aidial_client-0.11.0.dev6 → aidial_client-0.12.0.dev2}/aidial_client/_http_client/_base.py

@@ -1,4 +1,5 @@
 from abc import ABC, abstractmethod
+from collections.abc import Callable
 from http import HTTPStatus
 from random import uniform
 from typing import Generic, TypeVar
@@ -16,6 +17,8 @@ _HttpInternalClientT = TypeVar(
     "_HttpInternalClientT", bound=httpx.Client | httpx.AsyncClient
 )
 
+ErrorHandler = Callable[[httpx.HTTPStatusError], DialException | None]
+
 
 class BaseHTTPClient(ABC, Generic[_HttpInternalClientT, AuthValueT]):
     _internal_http_client: _HttpInternalClientT
@@ -106,6 +109,22 @@ class BaseHTTPClient(ABC, Generic[_HttpInternalClientT, AuthValueT]):
         timeout = sleep_seconds + uniform(-0.5, 0.5)  # noqa: S311
         return max(0, timeout)
 
+    def _raise_for_status(
+        self,
+        response: httpx.Response,
+        on_http_error: ErrorHandler | None,
+    ) -> None:
+        try:
+            response.raise_for_status()
+        except httpx.HTTPStatusError as err:
+            # Try to get a custom error from response status_code/code/message
+            custom_error = on_http_error(err) if on_http_error else None
+            # or fallback to default processing
+            raised_error = custom_error or self._make_dial_error_from_response(
+                err.response
+            )
+            raise raised_error from err
+
     def _make_dial_error_from_response(
         self,
         response: httpx.Response,

{aidial_client-0.11.0.dev6 → aidial_client-0.12.0.dev2}/aidial_client/_http_client/_sync.py

@@ -1,5 +1,5 @@
 import time
-from collections.abc import Callable, Iterator, Mapping
+from collections.abc import Iterator, Mapping
 from contextlib import contextmanager, suppress
 from http import HTTPStatus
 from typing import Any
@@ -8,7 +8,7 @@ import httpx
 
 from aidial_client._auth import SyncAuthValue, get_combined_auth_headers
 from aidial_client._exception import DialException
-from aidial_client._http_client._base import BaseHTTPClient
+from aidial_client._http_client._base import BaseHTTPClient, ErrorHandler
 from aidial_client._internal_types._defaults import NOT_GIVEN, NotGiven
 from aidial_client._internal_types._generic import ResponseT
 from aidial_client._internal_types._http_request import FinalRequestOptions
@@ -50,8 +50,7 @@ class SyncHTTPClient(BaseHTTPClient[httpx.Client, SyncAuthValue]):
         cast_to: type[ResponseT],
         options: FinalRequestOptions,
         remaining_retries: int | None = None,
-        on_http_error: Callable[[httpx.HTTPStatusError], DialException | None]
-        | None = None,
+        on_http_error: ErrorHandler | None = None,
     ) -> ResponseT:
         retries = self._remaining_retries(remaining_retries, options)
         auth_headers = self.auth_headers()
@@ -101,13 +100,7 @@ class SyncHTTPClient(BaseHTTPClient[httpx.Client, SyncAuthValue]):
                     cast_to=cast_to,
                     remaining_retries=retries,
                 )
-            # Try to get a custom error from response status_code/code/message
-            custom_error = on_http_error(err) if on_http_error else None
-            # or fallback to default processing
-            raised_error = custom_error or self._make_dial_error_from_response(
-                err.response
-            )
-            raise raised_error from err
+            self._raise_for_status(response, on_http_error)
 
         return process_block_response(cast_to=cast_to, response=response)
 

{aidial_client-0.11.0.dev6 → aidial_client-0.12.0.dev2}/aidial_client/helpers/storage_resource.py

@@ -5,6 +5,8 @@ from urllib.parse import urljoin, urlparse
 from aidial_client._compatibility.pydantic_v1 import BaseModel
 from aidial_client._constants import API_PREFIX
 from aidial_client._exception import InvalidDialURLError, NotDialURLError
+from aidial_client._internal_types._http_request import FinalRequestOptions
+from aidial_client._utils._dict import remove_none
 from aidial_client.helpers._url import enforce_trailing_slash
 
 StorageResourceType = Literal["files", "conversations", "prompts"]
@@ -156,3 +158,25 @@ class DialStorageResourceMixin(BaseModel):
         Get the display name of the resource from the URL
         """
         return self.get_storage_resource(url).bucket_path
+
+    def _prepare_download_request(
+        self,
+        url: str | PurePosixPath,
+        etag_if_match: str | None,
+    ) -> tuple[FinalRequestOptions, str]:
+        storage_resource = self.get_storage_resource(str(url))
+
+        if storage_resource.filename is None:
+            raise InvalidDialURLError("URL points to a directory, not a file")
+
+        options = FinalRequestOptions(
+            method="GET",
+            url=urljoin(API_PREFIX, storage_resource.api_path),
+            headers=remove_none(
+                {
+                    "If-Match": etag_if_match,
+                }
+            ),
+        )
+
+        return options, storage_resource.filename

{aidial_client-0.11.0.dev6 → 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.11.0.dev6 → aidial_client-0.12.0.dev2}/aidial_client/resources/files.py

@@ -1,3 +1,5 @@
+from collections.abc import AsyncIterator
+from contextlib import asynccontextmanager
 from pathlib import PurePosixPath
 from typing import Literal
 from urllib.parse import urljoin
@@ -8,7 +10,6 @@ from aidial_client._constants import API_PREFIX
 from aidial_client._exception import (
     DialException,
     EtagMismatchError,
-    InvalidDialURLError,
     ResourceNotFoundError,
 )
 from aidial_client._internal_types._generic import NoneType
@@ -70,25 +71,13 @@ class Files(Resource, DialStorageResourceMixin):
         url: str | PurePosixPath,
         etag_if_match: str | None = None,
     ) -> FileDownloadResponse:
-        storage_resource = self.get_storage_resource(str(url))
-        if storage_resource.filename is None:
-            raise InvalidDialURLError("URL points to a directory, not a file")
+        options, filename = self._prepare_download_request(url, etag_if_match)
         response = self.http_client.request(
             cast_to=httpx.Response,
-            options=FinalRequestOptions(
-                method="GET",
-                url=urljoin(API_PREFIX, storage_resource.api_path),
-                headers=remove_none(
-                    {
-                        "If-Match": etag_if_match,
-                    }
-                ),
-            ),
+            options=options,
             on_http_error=_files_error_processor,
         )
-        return FileDownloadResponse(
-            response=response, filename=storage_resource.filename
-        )
+        return FileDownloadResponse(response=response, filename=filename)
 
     def delete(
         self,
@@ -188,25 +177,26 @@ class AsyncFiles(AsyncResource, DialStorageResourceMixin):
         url: str | PurePosixPath,
         etag_if_match: str | None = None,
     ) -> FileDownloadResponse:
-        storage_resource = self.get_storage_resource(str(url))
-        if storage_resource.filename is None:
-            raise InvalidDialURLError("URL points to a directory, not a file")
+        options, filename = self._prepare_download_request(url, etag_if_match)
         response = await self.http_client.request(
             cast_to=httpx.Response,
-            options=FinalRequestOptions(
-                method="GET",
-                url=urljoin(API_PREFIX, storage_resource.api_path),
-                headers=remove_none(
-                    {
-                        "If-Match": etag_if_match,
-                    }
-                ),
-            ),
+            options=options,
             on_http_error=_files_error_processor,
         )
-        return FileDownloadResponse(
-            response=response, filename=storage_resource.filename
-        )
+        return FileDownloadResponse(response=response, filename=filename)
+
+    @asynccontextmanager
+    async def stream_download(
+        self,
+        url: str | PurePosixPath,
+        etag_if_match: str | None = None,
+    ) -> AsyncIterator[FileDownloadResponse]:
+        options, filename = self._prepare_download_request(url, etag_if_match)
+        async with self.http_client.stream(
+            options=options,
+            on_http_error=_files_error_processor,
+        ) as response:
+            yield FileDownloadResponse(response=response, filename=filename)
 
     async def delete(
         self,

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.11.0.dev6 → aidial_client-0.12.0.dev2}/pyproject.toml

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