codemie-sdk-python 0.1.79__tar.gz → 0.1.81__tar.gz

{codemie_sdk_python-0.1.79 → codemie_sdk_python-0.1.81}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codemie-sdk-python
-Version: 0.1.79
+Version: 0.1.81
 Summary: CodeMie SDK for Python
 Author: Vadym Vlasenko
 Author-email: vadym_vlasenko@epam.com
@@ -182,7 +182,50 @@ chat_request = AssistantChatRequest(
 response = client.assistant.chat("assistant-id", chat_request)
 ```
 
-7. **Work with Prebuilt Assistants**
+7. **Utilize structured outputs with Assistant**
+```python
+from pydantic import BaseModel
+
+class OutputSchema(BaseModel):
+    requirements: list[str]
+
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    stream=False, 
+    output_schema=OutputSchema
+    # Additional parameters
+)
+
+response = client.assistants.chat("id", chat_request)
+# response.generated is a Pydantic object
+```
+Or using JSON schema in dict format
+```python
+output_schema = {
+    "properties": {
+        "requirements": {
+            "items": {"type": "string"},
+            "title": "Requirements",
+            "type": "array",
+        }
+    },
+    "required": ["requirements"],
+    "title": "OutputSchema",
+    "type": "object",
+}
+
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    stream=False, 
+    output_schema=output_schema 
+    # Additional parameters
+)
+
+response = client.assistants.chat("id", chat_request)
+# response.generated is a dict corresponded with JSON schema
+```
+
+8. **Work with Prebuilt Assistants**
 ```python
 # List prebuilt assistants
 prebuilt = client.assistant.get_prebuilt()
@@ -191,7 +234,7 @@ prebuilt = client.assistant.get_prebuilt()
 prebuilt_assistant = client.assistant.get_prebuilt_by_slug("assistant-slug")
 ```
 
-8. **Get Available Tools**
+9. **Get Available Tools**
 ```python
 tools = client.assistant.get_tools()
 ```

{codemie_sdk_python-0.1.79 → codemie_sdk_python-0.1.81}/README.md

@@ -169,7 +169,50 @@ chat_request = AssistantChatRequest(
 response = client.assistant.chat("assistant-id", chat_request)
 ```
 
-7. **Work with Prebuilt Assistants**
+7. **Utilize structured outputs with Assistant**
+```python
+from pydantic import BaseModel
+
+class OutputSchema(BaseModel):
+    requirements: list[str]
+
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    stream=False, 
+    output_schema=OutputSchema
+    # Additional parameters
+)
+
+response = client.assistants.chat("id", chat_request)
+# response.generated is a Pydantic object
+```
+Or using JSON schema in dict format
+```python
+output_schema = {
+    "properties": {
+        "requirements": {
+            "items": {"type": "string"},
+            "title": "Requirements",
+            "type": "array",
+        }
+    },
+    "required": ["requirements"],
+    "title": "OutputSchema",
+    "type": "object",
+}
+
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    stream=False, 
+    output_schema=output_schema 
+    # Additional parameters
+)
+
+response = client.assistants.chat("id", chat_request)
+# response.generated is a dict corresponded with JSON schema
+```
+
+8. **Work with Prebuilt Assistants**
 ```python
 # List prebuilt assistants
 prebuilt = client.assistant.get_prebuilt()
@@ -178,7 +221,7 @@ prebuilt = client.assistant.get_prebuilt()
 prebuilt_assistant = client.assistant.get_prebuilt_by_slug("assistant-slug")
 ```
 
-8. **Get Available Tools**
+9. **Get Available Tools**
 ```python
 tools = client.assistant.get_tools()
 ```

{codemie_sdk_python-0.1.79 → codemie_sdk_python-0.1.81}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "codemie-sdk-python"
-version = "0.1.79"
+version = "0.1.81"
 description = "CodeMie SDK for Python"
 authors = [
     "Vadym Vlasenko <vadym_vlasenko@epam.com>",

{codemie_sdk_python-0.1.79 → codemie_sdk_python-0.1.81}/src/codemie_sdk/models/assistant.py

@@ -3,7 +3,7 @@
 import uuid
 from datetime import datetime
 from enum import Enum
-from typing import List, Optional, Any, Union, Dict
+from typing import List, Optional, Any, Union, Dict, Type
 
 from pydantic import BaseModel, Field, ConfigDict, model_validator
 
@@ -227,12 +227,19 @@ class AssistantChatRequest(BaseModel):
         default=None, description="Provide additional metadata"
     )
     tools_config: Optional[List[ToolConfig]] = None
+    output_schema: Optional[dict | Type[BaseModel]] = Field(
+        default=None,
+        description="Structured output schema for the agent. \
+            If specified, `generated` field in response will have the same type",
+    )
 
 
 class BaseModelResponse(BaseModel):
     """Model for chat response from assistant."""
 
-    generated: str = Field(description="Generated response error_message")
+    generated: str | dict | BaseModel = Field(
+        description="Generated response. If output_schema in request is specified, corresponds with its type"
+    )
     time_elapsed: Optional[float] = Field(
         default=None, alias="timeElapsed", description="Time taken for generation"
     )

{codemie_sdk_python-0.1.79 → codemie_sdk_python-0.1.81}/src/codemie_sdk/services/assistant.py

@@ -3,6 +3,8 @@
 import json
 from pathlib import Path
 from typing import List, Union, Optional, Dict, Any, Literal
+from pydantic import BaseModel
+from copy import deepcopy
 
 import requests
 
@@ -180,12 +182,23 @@ class AssistantService:
         Returns:
             Chat response or streaming response
         """
-        return self._api.post(
+        pydantic_schema = None
+        if issubclass(request.output_schema, BaseModel):
+            pydantic_schema = deepcopy(request.output_schema)
+            request.output_schema = request.output_schema.model_json_schema()
+
+        response = self._api.post(
             f"/v1/assistants/{assistant_id}/model",
             BaseModelResponse,
             json_data=request.model_dump(exclude_none=True, by_alias=True),
             stream=request.stream,
         )
+        if not request.stream and pydantic_schema:
+            # we do conversion to the BaseModel here because self._parse_response don't see actual request model,
+            # where reflected desired output format for structured output
+            response.generated = pydantic_schema.model_validate(response.generated)
+
+        return response
 
     def upload_file_to_chat(self, file_path: Path):
         """Upload a file to assistant chat and return the response containing file_url."""