codemie-sdk-python 0.1.218__tar.gz → 0.1.249__tar.gz

{codemie_sdk_python-0.1.218 → codemie_sdk_python-0.1.249}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: codemie-sdk-python
-Version: 0.1.218
+Version: 0.1.249
 Summary: CodeMie SDK for Python
 Author: Vadym Vlasenko
 Author-email: vadym_vlasenko@epam.com
@@ -25,6 +25,7 @@ Python SDK for CodeMie services. This SDK provides a comprehensive interface to
   - [Assistant Service](#assistant-service)
     - [Core Methods](#core-methods)
     - [Advanced Features](#advanced-features)
+    - [Prompt Variables Support](#prompt-variables-support)
   - [Datasource Service](#datasource-service)
     - [Supported Datasource Types](#supported-datasource-types)
     - [Core Methods](#core-methods-1)
@@ -174,16 +175,41 @@ result = client.assistant.delete("assistant-id")
 
 #### Advanced Features
 
-6. **Chat with Assistant**
+6. **Chat with Assistant (with MCP header propagation)**
 ```python
 from codemie_sdk.models.assistant import AssistantChatRequest
 
 chat_request = AssistantChatRequest(
     text="Your message here",
     stream=False,  # Set to True for streaming response
-    # Additional parameters
+    propagate_headers=True,  # Enable propagation of X-* headers to MCP servers
+)
+# Pass X-* headers to forward to MCP servers
+response = client.assistant.chat(
+    "assistant-id",
+    chat_request,
+    headers={
+        "X-Tenant-ID": "tenant-abc-123",
+        "X-User-ID": "user-456",
+        "X-Request-ID": "req-123",
+    },
+)
+```
+
+6.a. **Chat with Assistant by slug (with MCP header propagation)**
+```python
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    propagate_headers=True,
+)
+response = client.assistants.chat_by_slug(
+    "assistant-slug",
+    chat_request,
+    headers={
+        "X-Environment": "production",
+        "X-Feature-Flag-Beta": "true",
+    },
 )
-response = client.assistant.chat("assistant-id", chat_request)
 ```
 
 7. **Utilize structured outputs with Assistant**
@@ -243,6 +269,42 @@ prebuilt_assistant = client.assistant.get_prebuilt_by_slug("assistant-slug")
 tools = client.assistant.get_tools()
 ```
 
+### Prompt Variables Support
+The SDK supports assistant-level prompt variables that the backend already exposes via the `prompt_variables` field.
+
+Create and update an assistant with prompt variables:
+```python
+from codemie_sdk.models.assistant import AssistantCreateRequest, AssistantUpdateRequest, PromptVariable
+
+# Create
+create_req = AssistantCreateRequest(
+    name="My Assistant",
+    description="Assistant description",
+    system_prompt="Instructions. Use {{project_name}} in responses.",
+    toolkits=[],
+    project="my_project",
+    llm_model_type="gpt-4o",
+    context=[],
+    conversation_starters=[],
+    mcp_servers=[],
+    assistant_ids=[],
+    prompt_variables=[
+        PromptVariable(key="project_name", default_value="Delta", description="Current project"),
+        PromptVariable(key="region", default_value="eu"),
+    ],
+)
+client.assistants.create(create_req)
+
+# Update
+update_req = AssistantUpdateRequest(
+    **create_req.model_dump(),
+    prompt_variables=[
+        PromptVariable(key="project_name", default_value="Delta-Updated"),
+        PromptVariable(key="region", default_value="us"),
+    ],
+)
+client.assistants.update("assistant-id", update_req)
+
 ### Datasource Service
 
 The Datasource service enables managing various types of data sources in CodeMie, including code repositories, Confluence spaces, Jira projects, files, and Google documents.
@@ -548,10 +610,18 @@ result = client.workflow.delete("workflow-id")
 
 The SDK provides comprehensive workflow execution management through the WorkflowExecutionService:
 
-1. **Run Workflow**
+1. **Run Workflow (with MCP header propagation)**
 ```python
-# Simple workflow execution
-execution = client.workflow.run("workflow-id", user_input="optional input")
+# Enable propagation in payload and pass X-* headers to forward to MCP servers
+execution = client.workflow.run(
+    "workflow-id",
+    user_input="optional input",
+    propagate_headers=True,
+    headers={
+        "X-Request-ID": "req-abc-123",
+        "X-Source-App": "analytics-ui",
+    },
+)
 
 # Get execution service for advanced operations
 execution_service = client.workflow.executions("workflow-id")
@@ -571,8 +641,14 @@ execution = execution_service.get("execution-id")
 # Abort running execution
 result = execution_service.abort("execution-id")
 
-# Resume interrupted execution
-result = execution_service.resume("execution-id")
+# Resume interrupted execution with header propagation (query param + headers)
+result = execution_service.resume(
+    "execution-id",
+    propagate_headers=True,
+    headers={
+        "X-Correlation-ID": "corr-456",
+    },
+)
 
 # Delete all executions
 result = execution_service.delete_all()
@@ -831,6 +907,50 @@ client = CodeMieClient(
 )
 ```
 
+### Assistant Versioning via SDK
+
+The Python SDK exposes full assistant versioning capabilities delivered in EPMCDME-8285.
+
+- List versions
+```python
+versions = client.assistants.list_versions("assistant-id", page=0, per_page=20)
+print([v.version_number for v in versions])
+```
+
+- Get specific version
+```python
+version = client.assistants.get_version("assistant-id", 2)
+print(version.system_prompt)
+```
+
+- Compare two versions
+```python
+from codemie_sdk.models.assistant import AssistantVersionDiff
+
+diff: AssistantVersionDiff = client.assistants.compare_versions("assistant-id", 1, 3)
+print(diff.summary)
+```
+
+- Rollback to a version
+```python
+resp = client.assistants.rollback_to_version("assistant-id", 2)
+print(resp)
+```
+
+- Chat with a specific version
+```python
+from codemie_sdk.models.assistant import AssistantChatRequest
+
+req = AssistantChatRequest(text="Hi", stream=False)
+resp = client.assistants.chat_with_version("assistant-id", 2, req)
+print(resp.generated)
+```
+
+Quick CLI example
+```bash
+python codemie-sdk/examples/assistant_versions.py <assistant_id> [version_number]
+```
+
 ## Support
 For providing credentials please contact AI/Run CodeMie Team: Vadym_Vlasenko@epam.com or Nikita_Levyankov@epam.com
 

{codemie_sdk_python-0.1.218 → codemie_sdk_python-0.1.249}/README.md

@@ -12,6 +12,7 @@ Python SDK for CodeMie services. This SDK provides a comprehensive interface to
   - [Assistant Service](#assistant-service)
     - [Core Methods](#core-methods)
     - [Advanced Features](#advanced-features)
+    - [Prompt Variables Support](#prompt-variables-support)
   - [Datasource Service](#datasource-service)
     - [Supported Datasource Types](#supported-datasource-types)
     - [Core Methods](#core-methods-1)
@@ -161,16 +162,41 @@ result = client.assistant.delete("assistant-id")
 
 #### Advanced Features
 
-6. **Chat with Assistant**
+6. **Chat with Assistant (with MCP header propagation)**
 ```python
 from codemie_sdk.models.assistant import AssistantChatRequest
 
 chat_request = AssistantChatRequest(
     text="Your message here",
     stream=False,  # Set to True for streaming response
-    # Additional parameters
+    propagate_headers=True,  # Enable propagation of X-* headers to MCP servers
+)
+# Pass X-* headers to forward to MCP servers
+response = client.assistant.chat(
+    "assistant-id",
+    chat_request,
+    headers={
+        "X-Tenant-ID": "tenant-abc-123",
+        "X-User-ID": "user-456",
+        "X-Request-ID": "req-123",
+    },
+)
+```
+
+6.a. **Chat with Assistant by slug (with MCP header propagation)**
+```python
+chat_request = AssistantChatRequest(
+    text="Your message here",
+    propagate_headers=True,
+)
+response = client.assistants.chat_by_slug(
+    "assistant-slug",
+    chat_request,
+    headers={
+        "X-Environment": "production",
+        "X-Feature-Flag-Beta": "true",
+    },
 )
-response = client.assistant.chat("assistant-id", chat_request)
 ```
 
 7. **Utilize structured outputs with Assistant**
@@ -230,6 +256,42 @@ prebuilt_assistant = client.assistant.get_prebuilt_by_slug("assistant-slug")
 tools = client.assistant.get_tools()
 ```
 
+### Prompt Variables Support
+The SDK supports assistant-level prompt variables that the backend already exposes via the `prompt_variables` field.
+
+Create and update an assistant with prompt variables:
+```python
+from codemie_sdk.models.assistant import AssistantCreateRequest, AssistantUpdateRequest, PromptVariable
+
+# Create
+create_req = AssistantCreateRequest(
+    name="My Assistant",
+    description="Assistant description",
+    system_prompt="Instructions. Use {{project_name}} in responses.",
+    toolkits=[],
+    project="my_project",
+    llm_model_type="gpt-4o",
+    context=[],
+    conversation_starters=[],
+    mcp_servers=[],
+    assistant_ids=[],
+    prompt_variables=[
+        PromptVariable(key="project_name", default_value="Delta", description="Current project"),
+        PromptVariable(key="region", default_value="eu"),
+    ],
+)
+client.assistants.create(create_req)
+
+# Update
+update_req = AssistantUpdateRequest(
+    **create_req.model_dump(),
+    prompt_variables=[
+        PromptVariable(key="project_name", default_value="Delta-Updated"),
+        PromptVariable(key="region", default_value="us"),
+    ],
+)
+client.assistants.update("assistant-id", update_req)
+
 ### Datasource Service
 
 The Datasource service enables managing various types of data sources in CodeMie, including code repositories, Confluence spaces, Jira projects, files, and Google documents.
@@ -535,10 +597,18 @@ result = client.workflow.delete("workflow-id")
 
 The SDK provides comprehensive workflow execution management through the WorkflowExecutionService:
 
-1. **Run Workflow**
+1. **Run Workflow (with MCP header propagation)**
 ```python
-# Simple workflow execution
-execution = client.workflow.run("workflow-id", user_input="optional input")
+# Enable propagation in payload and pass X-* headers to forward to MCP servers
+execution = client.workflow.run(
+    "workflow-id",
+    user_input="optional input",
+    propagate_headers=True,
+    headers={
+        "X-Request-ID": "req-abc-123",
+        "X-Source-App": "analytics-ui",
+    },
+)
 
 # Get execution service for advanced operations
 execution_service = client.workflow.executions("workflow-id")
@@ -558,8 +628,14 @@ execution = execution_service.get("execution-id")
 # Abort running execution
 result = execution_service.abort("execution-id")
 
-# Resume interrupted execution
-result = execution_service.resume("execution-id")
+# Resume interrupted execution with header propagation (query param + headers)
+result = execution_service.resume(
+    "execution-id",
+    propagate_headers=True,
+    headers={
+        "X-Correlation-ID": "corr-456",
+    },
+)
 
 # Delete all executions
 result = execution_service.delete_all()
@@ -818,6 +894,50 @@ client = CodeMieClient(
 )
 ```
 
+### Assistant Versioning via SDK
+
+The Python SDK exposes full assistant versioning capabilities delivered in EPMCDME-8285.
+
+- List versions
+```python
+versions = client.assistants.list_versions("assistant-id", page=0, per_page=20)
+print([v.version_number for v in versions])
+```
+
+- Get specific version
+```python
+version = client.assistants.get_version("assistant-id", 2)
+print(version.system_prompt)
+```
+
+- Compare two versions
+```python
+from codemie_sdk.models.assistant import AssistantVersionDiff
+
+diff: AssistantVersionDiff = client.assistants.compare_versions("assistant-id", 1, 3)
+print(diff.summary)
+```
+
+- Rollback to a version
+```python
+resp = client.assistants.rollback_to_version("assistant-id", 2)
+print(resp)
+```
+
+- Chat with a specific version
+```python
+from codemie_sdk.models.assistant import AssistantChatRequest
+
+req = AssistantChatRequest(text="Hi", stream=False)
+resp = client.assistants.chat_with_version("assistant-id", 2, req)
+print(resp.generated)
+```
+
+Quick CLI example
+```bash
+python codemie-sdk/examples/assistant_versions.py <assistant_id> [version_number]
+```
+
 ## Support
 For providing credentials please contact AI/Run CodeMie Team: Vadym_Vlasenko@epam.com or Nikita_Levyankov@epam.com
 

{codemie_sdk_python-0.1.218 → codemie_sdk_python-0.1.249}/pyproject.toml

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

codemie_sdk_python-0.1.249/src/codemie_sdk/__init__.py

@@ -0,0 +1,135 @@
+"""
+CodeMie SDK for Python
+~~~~~~~~~~~~~~~~~~~~~
+
+A Python SDK for interacting with CodeMie API.
+
+Basic usage:
+
+    >>> from codemie_sdk import CodeMieClient
+    >>> client = CodeMieClient(
+    ...     auth_server_url="https://auth.example.com",
+    ...     auth_client_id="client_id",
+    ...     auth_client_secret="secret",
+    ...     auth_realm_name="realm",
+    ...     codemie_api_domain="api.codemie.com"
+    ... )
+    >>> assistants = client.assistants.list()
+"""
+
+from .client.client import CodeMieClient
+from .models.vendor_assistant import (
+    VendorType,
+    VendorAssistantSetting,
+    VendorAssistantSettingsResponse,
+    VendorAssistant,
+    VendorAssistantVersion,
+    VendorAssistantStatus,
+    VendorAssistantsResponse,
+    VendorAssistantAlias,
+    VendorAssistantAliasesResponse,
+    VendorAssistantInstallRequest,
+    VendorAssistantInstallSummary,
+    VendorAssistantInstallResponse,
+    VendorAssistantUninstallResponse,
+    PaginationInfo,
+    TokenPagination,
+)
+from .models.vendor_workflow import (
+    VendorWorkflowSetting,
+    VendorWorkflowSettingsResponse,
+    VendorWorkflow,
+    VendorWorkflowStatus,
+    VendorWorkflowsResponse,
+    VendorWorkflowAlias,
+    VendorWorkflowAliasesResponse,
+    VendorWorkflowInstallRequest,
+    VendorWorkflowInstallSummary,
+    VendorWorkflowInstallResponse,
+    VendorWorkflowUninstallResponse,
+)
+from .models.vendor_knowledgebase import (
+    VendorKnowledgeBaseSetting,
+    VendorKnowledgeBaseSettingsResponse,
+    VendorKnowledgeBase,
+    VendorKnowledgeBaseStatus,
+    VendorKnowledgeBasesResponse,
+    VendorKnowledgeBaseDetail,
+    VendorKnowledgeBaseInstallRequest,
+    VendorKnowledgeBaseInstallSummary,
+    VendorKnowledgeBaseInstallResponse,
+    VendorKnowledgeBaseUninstallResponse,
+)
+from .models.vendor_guardrail import (
+    VendorGuardrailSetting,
+    VendorGuardrailSettingsResponse,
+    VendorGuardrail,
+    VendorGuardrailStatus,
+    VendorGuardrailsResponse,
+    VendorGuardrailVersion,
+    VendorGuardrailVersionsResponse,
+    VendorGuardrailInstallRequest,
+    VendorGuardrailInstallSummary,
+    VendorGuardrailInstallResponse,
+    VendorGuardrailUninstallResponse,
+)
+from .services.vendor_assistant import VendorAssistantService
+from .services.vendor_workflow import VendorWorkflowService
+from .services.vendor_knowledgebase import VendorKnowledgeBaseService
+from .services.vendor_guardrail import VendorGuardrailService
+
+__version__ = "0.2.12"
+__all__ = [
+    "CodeMieClient",
+    "VendorType",
+    "VendorAssistantSetting",
+    "VendorAssistantSettingsResponse",
+    "VendorAssistant",
+    "VendorAssistantVersion",
+    "VendorAssistantStatus",
+    "VendorAssistantsResponse",
+    "VendorAssistantAlias",
+    "VendorAssistantAliasesResponse",
+    "VendorAssistantInstallRequest",
+    "VendorAssistantInstallSummary",
+    "VendorAssistantInstallResponse",
+    "VendorAssistantUninstallResponse",
+    "PaginationInfo",
+    "TokenPagination",
+    "VendorAssistantService",
+    "VendorWorkflowSetting",
+    "VendorWorkflowSettingsResponse",
+    "VendorWorkflow",
+    "VendorWorkflowStatus",
+    "VendorWorkflowsResponse",
+    "VendorWorkflowAlias",
+    "VendorWorkflowAliasesResponse",
+    "VendorWorkflowInstallRequest",
+    "VendorWorkflowInstallSummary",
+    "VendorWorkflowInstallResponse",
+    "VendorWorkflowUninstallResponse",
+    "VendorWorkflowService",
+    "VendorKnowledgeBaseSetting",
+    "VendorKnowledgeBaseSettingsResponse",
+    "VendorKnowledgeBase",
+    "VendorKnowledgeBaseStatus",
+    "VendorKnowledgeBasesResponse",
+    "VendorKnowledgeBaseDetail",
+    "VendorKnowledgeBaseInstallRequest",
+    "VendorKnowledgeBaseInstallSummary",
+    "VendorKnowledgeBaseInstallResponse",
+    "VendorKnowledgeBaseUninstallResponse",
+    "VendorKnowledgeBaseService",
+    "VendorGuardrailSetting",
+    "VendorGuardrailSettingsResponse",
+    "VendorGuardrail",
+    "VendorGuardrailStatus",
+    "VendorGuardrailsResponse",
+    "VendorGuardrailVersion",
+    "VendorGuardrailVersionsResponse",
+    "VendorGuardrailInstallRequest",
+    "VendorGuardrailInstallSummary",
+    "VendorGuardrailInstallResponse",
+    "VendorGuardrailUninstallResponse",
+    "VendorGuardrailService",
+]

{codemie_sdk_python-0.1.218 → codemie_sdk_python-0.1.249}/src/codemie_sdk/client/client.py

@@ -13,6 +13,10 @@ from ..services.user import UserService
 from ..services.workflow import WorkflowService
 from ..services.files import FileOperationService
 from ..services.webhook import WebhookService
+from ..services.vendor_assistant import VendorAssistantService
+from ..services.vendor_workflow import VendorWorkflowService
+from ..services.vendor_knowledgebase import VendorKnowledgeBaseService
+from ..services.vendor_guardrail import VendorGuardrailService
 
 
 class CodeMieClient:
@@ -89,6 +93,18 @@ class CodeMieClient:
         self.webhook = WebhookService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
+        self.vendor_assistants = VendorAssistantService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_workflows = VendorWorkflowService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_knowledgebases = VendorKnowledgeBaseService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_guardrails = VendorGuardrailService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
 
     @property
     def token(self) -> str:
@@ -104,6 +120,7 @@ class CodeMieClient:
             "localhost",
             "127.0.0.1",
             "0.0.0.0",
+            "192.168",
         ]
         return any(pattern in domain_lower for pattern in localhost_patterns)
 
@@ -135,4 +152,22 @@ class CodeMieClient:
         self.conversations = ConversationService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
+        self.files = FileOperationService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.webhook = WebhookService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_assistants = VendorAssistantService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_workflows = VendorWorkflowService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_knowledgebases = VendorKnowledgeBaseService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
+        self.vendor_guardrails = VendorGuardrailService(
+            self._api_domain, self._token, verify_ssl=self._verify_ssl
+        )
         return self._token

{codemie_sdk_python-0.1.218 → codemie_sdk_python-0.1.249}/src/codemie_sdk/models/assistant.py

@@ -53,6 +53,16 @@ class Context(BaseModel):
     name: str
 
 
+class PromptVariable(BaseModel):
+    """Model for assistant prompt variables."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    key: str
+    description: Optional[str] = None
+    default_value: str
+
+
 class MCPServerConfig(BaseModel):
     """
     Configuration for an MCP server.
@@ -137,6 +147,17 @@ class AssistantBase(BaseModel):
     icon_url: Optional[str] = None
 
 
+class AssistantListResponse(BaseModel):
+    """Model for assistant list response."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str
+    name: str
+    slug: Optional[str] = None
+    created_by: Optional[User] = None
+
+
 class Assistant(AssistantBase):
     """Full assistant model with additional fields."""
 
@@ -164,6 +185,8 @@ class Assistant(AssistantBase):
     user_abilities: Optional[List[Any]] = None
     mcp_servers: List[MCPServerDetails] = Field(default_factory=list)
     assistant_ids: List[str] = Field(default_factory=list)
+    version_count: Optional[int] = None
+    prompt_variables: Optional[List[PromptVariable]] = Field(default=None)
 
 
 class AssistantRequestBase(AssistantBase):
@@ -191,6 +214,7 @@ class AssistantRequestBase(AssistantBase):
     top_p: Optional[float] = None
     mcp_servers: List[MCPServerDetails] = Field(default_factory=list)
     assistant_ids: List[str] = Field(default_factory=list)
+    prompt_variables: List[PromptVariable] = Field(default_factory=list)
 
 
 class AssistantCreateRequest(AssistantRequestBase):
@@ -205,6 +229,27 @@ class AssistantUpdateRequest(AssistantRequestBase):
     pass
 
 
+class AssistantVersion(BaseModel):
+    """Immutable snapshot of assistant configuration for a specific version."""
+
+    model_config = ConfigDict(extra="ignore", use_enum_values=True)
+
+    version_number: int
+    created_date: datetime
+    created_by: Optional[User] = None
+    change_notes: Optional[str] = None
+    description: Optional[str] = None
+    system_prompt: str
+    llm_model_type: Optional[str] = None
+    temperature: Optional[float] = None
+    top_p: Optional[float] = None
+    context: List[Context] = Field(default_factory=list)
+    toolkits: List[ToolKitDetails] = Field(default_factory=list)
+    mcp_servers: List[MCPServerDetails] = Field(default_factory=list)
+    assistant_ids: List[str] = Field(default_factory=list)
+    prompt_variables: List[PromptVariable] = Field(default_factory=list)
+
+
 class ChatRole(str, Enum):
     """Enum for chat message roles."""
 
@@ -263,6 +308,14 @@ class AssistantChatRequest(BaseModel):
         default=None, description="DataSource in conversation history"
     )
     stream: bool = Field(default=False, description="Enable streaming response")
+    propagate_headers: bool = Field(
+        default=False,
+        description="Enable propagation of X-* HTTP headers to MCP servers during tool execution",
+    )
+    custom_metadata: Optional[dict[str, Any]] = Field(
+        default=None,
+        description="Custom metadata for the AI Assistant",
+    )
     top_k: int = Field(default=10, description="Top K results to consider")
     system_prompt: str = Field(default="", description="Override system prompt")
     background_task: bool = Field(default=False, description="Run as background task")