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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aidial-client
-Version: 0.10.0.dev1
+Version: 0.10.0.dev3
 Summary: A Python client library for the AI DIAL API
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -613,6 +613,40 @@ FileMetadata(
 
 ### Prompts
 
+#### Save Prompt
+
+Use `save()` to create or update a prompt by its storage path:
+
+```python
+from aidial_client.types.prompt import Prompt
+
+prompt_url = "prompts/my-bucket/my-folder/my-prompt"
+prompt_payload = Prompt(
+    id=prompt_url,
+    name="my-prompt",
+    folder_id="my-folder",
+    content="You are a helpful assistant.",
+)
+
+# Sync
+saved_prompt = client.prompts.save(prompt_url, prompt=prompt_payload)
+# Async
+saved_prompt = await async_client.prompts.save(prompt_url, prompt=prompt_payload)
+```
+
+As a result, you will receive a `PromptMetadata` object:
+
+```python
+PromptMetadata(
+    name="my-prompt",
+    parent_path="my-folder",
+    bucket="my-bucket",
+    url="prompts/my-bucket/my-folder/my-prompt",
+    node_type="ITEM",
+    resource_type="PROMPT",
+)
+```
+
 #### Get Prompt
 
 Use `get()` to fetch a single prompt by its storage path:
@@ -662,6 +696,17 @@ PromptMetadata(
 )
 ```
 
+#### Delete Prompt
+
+Use `delete()` to remove a prompt by its storage path:
+
+```python
+# Sync
+client.prompts.delete("prompts/my-bucket/my-folder/my-prompt")
+# Async
+await async_client.prompts.delete("prompts/my-bucket/my-folder/my-prompt")
+```
+
 ### Applications
 
 #### List Applications

{aidial_client-0.10.0.dev1 → aidial_client-0.10.0.dev3}/README.md

@@ -591,6 +591,40 @@ FileMetadata(
 
 ### Prompts
 
+#### Save Prompt
+
+Use `save()` to create or update a prompt by its storage path:
+
+```python
+from aidial_client.types.prompt import Prompt
+
+prompt_url = "prompts/my-bucket/my-folder/my-prompt"
+prompt_payload = Prompt(
+    id=prompt_url,
+    name="my-prompt",
+    folder_id="my-folder",
+    content="You are a helpful assistant.",
+)
+
+# Sync
+saved_prompt = client.prompts.save(prompt_url, prompt=prompt_payload)
+# Async
+saved_prompt = await async_client.prompts.save(prompt_url, prompt=prompt_payload)
+```
+
+As a result, you will receive a `PromptMetadata` object:
+
+```python
+PromptMetadata(
+    name="my-prompt",
+    parent_path="my-folder",
+    bucket="my-bucket",
+    url="prompts/my-bucket/my-folder/my-prompt",
+    node_type="ITEM",
+    resource_type="PROMPT",
+)
+```
+
 #### Get Prompt
 
 Use `get()` to fetch a single prompt by its storage path:
@@ -640,6 +674,17 @@ PromptMetadata(
 )
 ```
 
+#### Delete Prompt
+
+Use `delete()` to remove a prompt by its storage path:
+
+```python
+# Sync
+client.prompts.delete("prompts/my-bucket/my-folder/my-prompt")
+# Async
+await async_client.prompts.delete("prompts/my-bucket/my-folder/my-prompt")
+```
+
 ### Applications
 
 #### List Applications

aidial_client-0.10.0.dev3/aidial_client/resources/prompts.py

@@ -0,0 +1,171 @@
+from pathlib import PurePosixPath
+from typing import Any, Dict, Literal, Optional, Union
+from urllib.parse import urljoin
+
+import httpx
+
+from aidial_client._compatibility.pydantic import PYDANTIC_V2
+from aidial_client._constants import API_PREFIX
+from aidial_client._exception import (
+    DialException,
+    EtagMismatchError,
+    ResourceNotFoundError,
+)
+from aidial_client._internal_types._generic import NoneType
+from aidial_client._internal_types._http_request import FinalRequestOptions
+from aidial_client._utils._dict import remove_none
+from aidial_client.helpers.storage_resource import DialStorageResourceMixin
+from aidial_client.resources.base import AsyncResource, Resource
+from aidial_client.resources.metadata import AsyncMetadata, Metadata
+from aidial_client.types.metadata import PromptMetadata
+from aidial_client.types.prompt import Prompt
+
+
+def _prompts_error_processor(
+    http_status_error: httpx.HTTPStatusError,
+) -> Optional[DialException]:
+    if http_status_error.response.status_code == 412:
+        return EtagMismatchError(
+            message=http_status_error.response.text,
+        )
+    elif http_status_error.response.status_code == 404:
+        return ResourceNotFoundError(
+            message=http_status_error.response.text,
+        )
+    return None
+
+
+def _prompt_to_json(prompt: Prompt) -> Dict[str, Any]:
+    if PYDANTIC_V2:
+        return prompt.model_dump(by_alias=True)  # type: ignore
+    return prompt.dict(by_alias=True)
+
+
+class Prompts(Resource, DialStorageResourceMixin):
+    metadata: Metadata
+    resource_type: str = "prompts"
+
+    def save(
+        self,
+        url: Union[str, PurePosixPath],
+        prompt: Prompt,
+        etag_if_match: Optional[str] = None,
+        etag_if_none_match: Optional[Literal["*"]] = None,
+    ) -> PromptMetadata:
+        return self.http_client.request(
+            cast_to=PromptMetadata,
+            options=FinalRequestOptions(
+                method="PUT",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+                json_data=_prompt_to_json(prompt),
+                headers=remove_none(
+                    {
+                        "If-Match": etag_if_match,
+                        "If-None-Match": etag_if_none_match,
+                    }
+                ),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    def get(self, url: Union[str, PurePosixPath]) -> Prompt:
+        """Fetch a single prompt by its storage path."""
+        return self.http_client.request(
+            cast_to=Prompt,
+            options=FinalRequestOptions(
+                method="GET",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    def delete(
+        self,
+        url: Union[str, PurePosixPath],
+        etag_if_match: Optional[str] = None,
+    ) -> None:
+        return self.http_client.request(
+            cast_to=NoneType,
+            options=FinalRequestOptions(
+                method="DELETE",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+                headers=remove_none(
+                    {
+                        "If-Match": etag_if_match,
+                    }
+                ),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    def get_metadata(self, url: Union[str, PurePosixPath]) -> PromptMetadata:
+        return self.metadata.get(
+            resource="prompts",
+            relative_url=self.get_api_path(str(url)),
+        )
+
+
+class AsyncPrompts(AsyncResource, DialStorageResourceMixin):
+    metadata: AsyncMetadata
+    resource_type: str = "prompts"
+
+    async def save(
+        self,
+        url: Union[str, PurePosixPath],
+        prompt: Prompt,
+        etag_if_match: Optional[str] = None,
+        etag_if_none_match: Optional[Literal["*"]] = None,
+    ) -> PromptMetadata:
+        return await self.http_client.request(
+            cast_to=PromptMetadata,
+            options=FinalRequestOptions(
+                method="PUT",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+                json_data=_prompt_to_json(prompt),
+                headers=remove_none(
+                    {
+                        "If-Match": etag_if_match,
+                        "If-None-Match": etag_if_none_match,
+                    }
+                ),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    async def get(self, url: Union[str, PurePosixPath]) -> Prompt:
+        """Fetch a single prompt by its storage path."""
+        return await self.http_client.request(
+            cast_to=Prompt,
+            options=FinalRequestOptions(
+                method="GET",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    async def delete(
+        self,
+        url: Union[str, PurePosixPath],
+        etag_if_match: Optional[str] = None,
+    ) -> None:
+        return await self.http_client.request(
+            cast_to=NoneType,
+            options=FinalRequestOptions(
+                method="DELETE",
+                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
+                headers=remove_none(
+                    {
+                        "If-Match": etag_if_match,
+                    }
+                ),
+            ),
+            on_http_error=_prompts_error_processor,
+        )
+
+    async def get_metadata(
+        self, url: Union[str, PurePosixPath]
+    ) -> PromptMetadata:
+        return await self.metadata.get(
+            resource="prompts",
+            relative_url=self.get_api_path(str(url)),
+        )

{aidial_client-0.10.0.dev1 → aidial_client-0.10.0.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aidial-client"
-version = "0.10.0.dev1"
+version = "0.10.0.dev3"
 description = "A Python client library for the AI DIAL API"
 readme = "README.md"
 license = "Apache-2.0"
@@ -63,6 +63,7 @@ exclude = [
 
 [tool.black]
 line-length = 80
+target-version = ["py310"]
 exclude = '''
 /(
     \.git

aidial_client-0.10.0.dev1/aidial_client/resources/prompts.py

@@ -1,70 +0,0 @@
-from pathlib import PurePosixPath
-from typing import Optional, Union
-from urllib.parse import urljoin
-
-import httpx
-
-from aidial_client._constants import API_PREFIX
-from aidial_client._exception import DialException, ResourceNotFoundError
-from aidial_client._internal_types._http_request import FinalRequestOptions
-from aidial_client.helpers.storage_resource import DialStorageResourceMixin
-from aidial_client.resources.base import AsyncResource, Resource
-from aidial_client.resources.metadata import AsyncMetadata, Metadata
-from aidial_client.types.metadata import PromptMetadata
-from aidial_client.types.prompt import Prompt
-
-
-def _prompts_error_processor(
-    http_status_error: httpx.HTTPStatusError,
-) -> Optional[DialException]:
-    if http_status_error.response.status_code == 404:
-        return ResourceNotFoundError(
-            message=http_status_error.response.text,
-        )
-    return None
-
-
-class Prompts(Resource, DialStorageResourceMixin):
-    metadata: Metadata
-    resource_type: str = "prompts"
-
-    def get(self, url: Union[str, PurePosixPath]) -> Prompt:
-        """Fetch a single prompt by its storage path."""
-        return self.http_client.request(
-            cast_to=Prompt,
-            options=FinalRequestOptions(
-                method="GET",
-                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
-            ),
-            on_http_error=_prompts_error_processor,
-        )
-
-    def get_metadata(self, url: Union[str, PurePosixPath]) -> PromptMetadata:
-        return self.metadata.get(
-            resource="prompts",
-            relative_url=self.get_api_path(str(url)),
-        )
-
-
-class AsyncPrompts(AsyncResource, DialStorageResourceMixin):
-    metadata: AsyncMetadata
-    resource_type: str = "prompts"
-
-    async def get(self, url: Union[str, PurePosixPath]) -> Prompt:
-        """Fetch a single prompt by its storage path."""
-        return await self.http_client.request(
-            cast_to=Prompt,
-            options=FinalRequestOptions(
-                method="GET",
-                url=urljoin(API_PREFIX, self.get_api_path(str(url))),
-            ),
-            on_http_error=_prompts_error_processor,
-        )
-
-    async def get_metadata(
-        self, url: Union[str, PurePosixPath]
-    ) -> PromptMetadata:
-        return await self.metadata.get(
-            resource="prompts",
-            relative_url=self.get_api_path(str(url)),
-        )