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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.12.0.dev2
+Version: 0.12.0.dev3
 Summary: A Python client library for the AI DIAL API
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -645,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
@@ -665,6 +683,7 @@ FileMetadata(
     resource_type="FILE",
     content_length=12,
     content_type="application/octet-stream",
+    next_token=None,
     items=None,
     updatedAt=1724836248936,
     etag="9749fad13d6e7092a6337c4af9d83764",

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

@@ -623,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
@@ -643,6 +661,7 @@ FileMetadata(
     resource_type="FILE",
     content_length=12,
     content_type="application/octet-stream",
+    next_token=None,
     items=None,
     updatedAt=1724836248936,
     etag="9749fad13d6e7092a6337c4af9d83764",

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

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