codemie-sdk-python 0.1.226__py3-none-any.whl → 0.1.256__py3-none-any.whl

codemie_sdk/__init__.py

@@ -60,11 +60,25 @@ from .models.vendor_knowledgebase import (
     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.11"
+__version__ = "0.2.12"
 __all__ = [
     "CodeMieClient",
     "VendorType",
@@ -106,4 +120,16 @@ __all__ = [
     "VendorKnowledgeBaseInstallResponse",
     "VendorKnowledgeBaseUninstallResponse",
     "VendorKnowledgeBaseService",
+    "VendorGuardrailSetting",
+    "VendorGuardrailSettingsResponse",
+    "VendorGuardrail",
+    "VendorGuardrailStatus",
+    "VendorGuardrailsResponse",
+    "VendorGuardrailVersion",
+    "VendorGuardrailVersionsResponse",
+    "VendorGuardrailInstallRequest",
+    "VendorGuardrailInstallSummary",
+    "VendorGuardrailInstallResponse",
+    "VendorGuardrailUninstallResponse",
+    "VendorGuardrailService",
 ]

codemie_sdk/client/client.py

@@ -16,6 +16,7 @@ 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:
@@ -101,6 +102,9 @@ class CodeMieClient:
         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:
@@ -116,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)
 
@@ -147,6 +152,12 @@ 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
         )
@@ -156,4 +167,7 @@ class CodeMieClient:
         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/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")

codemie_sdk/models/datasource.py

@@ -25,6 +25,8 @@ class DataSourceType(str, Enum):
     CHUNK_SUMMARY = "chunk-summary"
     JSON = "knowledge_base_json"
     BEDROCK = "knowledge_base_bedrock"
+    PLATFORM = "platform_marketplace_assistant"
+    AZURE_DEVOPS_WIKI = "knowledge_base_azure_devops_wiki"
 
 
 class DataSourceStatus(str, Enum):
@@ -46,6 +48,15 @@ class DataSourceProcessingInfo(BaseModel):
     processed_documents_count: Optional[int] = Field(None, alias="documents_count_key")
 
 
+class ElasticsearchStatsResponse(BaseModel):
+    """Response model for Elasticsearch index statistics."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    index_name: str = Field(..., description="Name of the index in Elasticsearch")
+    size_in_bytes: int = Field(..., ge=0, description="Size of the index in bytes")
+
+
 # Base request models
 class Confluence(BaseModel):
     """Model for Confluence-specific response fields"""
@@ -259,6 +270,40 @@ class UpdateFileDataSourceRequest(BaseUpdateDataSourceRequest):
         super().__init__(type=DataSourceType.FILE, **data)
 
 
+class CodeAnalysisDataSourceRequest(BaseModel):
+    """Model for provider-based datasource creation requests"""
+
+    model_config = ConfigDict(extra="ignore", populate_by_name=True)
+
+    name: str = Field(..., description="Datasource name")
+    description: Optional[str] = Field(None, description="Datasource description")
+    project_name: str = Field(..., description="Project name")
+    project_space_visible: bool = Field(False, alias="projectSpaceVisible")
+    branch: Optional[str] = Field(None, description="Git branch")
+    api_url: str = Field(..., description="Repository URL")
+    access_token: str = Field(..., description="Access token for repository")
+    analyzer: Optional[str] = Field(
+        None, description="Code analyzer type (e.g., Java, Python)"
+    )
+    datasource_root: str = Field("/", description="Root directory to analyze")
+
+
+class CodeExplorationDataSourceRequest(BaseModel):
+    """Model for CodeExplorationToolkit datasource creation requests"""
+
+    model_config = ConfigDict(extra="ignore", populate_by_name=True)
+
+    name: str = Field(..., description="Datasource name")
+    description: Optional[str] = Field(None, description="Datasource description")
+    project_name: str = Field(..., description="Project name")
+    project_space_visible: bool = Field(False, alias="projectSpaceVisible")
+    code_analysis_datasource_ids: List[str] = Field(
+        ...,
+        alias="code_analysis_datasource_ids",
+        description="List of CodeAnalysisToolkit datasource IDs",
+    )
+
+
 class DataSource(BaseModel):
     model_config = ConfigDict(
         extra="ignore",

codemie_sdk/models/integration.py

@@ -29,7 +29,7 @@ class CredentialTypes(str, Enum):
     SONAR = "Sonar"
     SQL = "SQL"
     TELEGRAM = "Telegram"
-    ZEPHYR_CLOUD = "ZephyrCloud"
+    ZEPHYR_SCALE = "ZephyrScale"
     ZEPHYR_SQUAD = "ZephyrSquad"
     SERVICE_NOW = "ServiceNow"
     DIAL = "DIAL"

codemie_sdk/models/vendor_guardrail.py

@@ -0,0 +1,152 @@
+"""Models for vendor guardrail settings."""
+
+from datetime import datetime
+from enum import Enum
+from typing import Optional, List
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from .vendor_assistant import PaginationInfo, TokenPagination
+
+
+class VendorGuardrailSetting(BaseModel):
+    """Model representing a vendor guardrail setting."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    setting_id: str = Field(..., description="Unique identifier for the setting")
+    setting_name: str = Field(..., description="Name of the setting")
+    project: str = Field(..., description="Project associated with the setting")
+    entities: List[str] = Field(
+        default_factory=list, description="List of entities associated with the setting"
+    )
+    invalid: Optional[bool] = Field(None, description="Whether the setting is invalid")
+    error: Optional[str] = Field(
+        None, description="Error message if the setting is invalid"
+    )
+
+
+class VendorGuardrailSettingsResponse(BaseModel):
+    """Response model for vendor guardrail settings list."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    data: List[VendorGuardrailSetting] = Field(
+        ..., description="List of vendor guardrail settings"
+    )
+    pagination: PaginationInfo = Field(..., description="Pagination information")
+
+
+class VendorGuardrailStatus(str, Enum):
+    """Status of vendor guardrail."""
+
+    PREPARED = "PREPARED"
+    NOT_PREPARED = "NOT_PREPARED"
+
+
+class VendorGuardrail(BaseModel):
+    """Model representing a vendor guardrail."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Unique identifier for the guardrail")
+    name: str = Field(..., description="Name of the guardrail")
+    status: VendorGuardrailStatus = Field(..., description="Status of the guardrail")
+    description: Optional[str] = Field(None, description="Description of the guardrail")
+    version: str = Field(..., description="Version of the guardrail")
+    createdAt: datetime = Field(
+        ..., description="Creation timestamp", alias="createdAt"
+    )
+    updatedAt: datetime = Field(
+        ..., description="Last update timestamp", alias="updatedAt"
+    )
+
+
+class VendorGuardrailsResponse(BaseModel):
+    """Response model for vendor guardrails list."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    data: List[VendorGuardrail] = Field(..., description="List of vendor guardrails")
+    pagination: TokenPagination = Field(
+        ..., description="Token-based pagination information"
+    )
+
+
+class VendorGuardrailVersion(BaseModel):
+    """Model representing a vendor guardrail version."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Unique identifier for the guardrail")
+    version: str = Field(..., description="Version of the guardrail")
+    name: str = Field(..., description="Name of the guardrail")
+    status: VendorGuardrailStatus = Field(..., description="Status of the version")
+    description: Optional[str] = Field(None, description="Description of the version")
+    blockedInputMessaging: Optional[str] = Field(
+        None,
+        description="Message to display when input is blocked by guardrail",
+        alias="blockedInputMessaging",
+    )
+    blockedOutputsMessaging: Optional[str] = Field(
+        None,
+        description="Message to display when output is blocked by guardrail",
+        alias="blockedOutputsMessaging",
+    )
+    createdAt: datetime = Field(
+        ..., description="Creation timestamp", alias="createdAt"
+    )
+    updatedAt: datetime = Field(
+        ..., description="Last update timestamp", alias="updatedAt"
+    )
+
+
+class VendorGuardrailVersionsResponse(BaseModel):
+    """Response model for vendor guardrail versions list."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    data: List[VendorGuardrailVersion] = Field(
+        ..., description="List of vendor guardrail versions"
+    )
+    pagination: TokenPagination = Field(
+        ..., description="Token-based pagination information"
+    )
+
+
+class VendorGuardrailInstallRequest(BaseModel):
+    """Model for a single guardrail installation request."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Guardrail ID to install")
+    version: str = Field(..., description="Version to use for the guardrail")
+    setting_id: str = Field(..., description="Vendor setting ID")
+
+
+class VendorGuardrailInstallSummary(BaseModel):
+    """Model for guardrail installation summary."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    guardrailId: str = Field(..., description="Installed guardrail ID")
+    version: str = Field(..., description="Version used for installation")
+    aiRunId: str = Field(..., description="AI run ID for the installation")
+
+
+class VendorGuardrailInstallResponse(BaseModel):
+    """Response model for guardrail installation."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    summary: List[VendorGuardrailInstallSummary] = Field(
+        ..., description="List of installation summaries"
+    )
+
+
+class VendorGuardrailUninstallResponse(BaseModel):
+    """Response model for guardrail uninstallation."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    success: bool = Field(..., description="Whether the uninstallation was successful")

codemie_sdk/models/workflow_execution_payload.py

@@ -15,3 +15,7 @@ class WorkflowExecutionCreateRequest(BaseModel):
     file_name: Optional[str] = Field(
         None, description="File name associated with the workflow execution"
     )
+    propagate_headers: bool = Field(
+        default=False,
+        description="Enable propagation of X-* HTTP headers to MCP servers during tool execution",
+    )

codemie_sdk/services/assistant.py

@@ -170,16 +170,153 @@ class AssistantService:
         """
         return self._api.get(f"/v1/assistants/prebuilt/{slug}", Assistant)
 
+    def list_versions(
+        self, assistant_id: str, page: int = 0, per_page: Optional[int] = None
+    ):
+        """List assistant versions.
+
+        Args:
+            assistant_id: Assistant identifier
+            page: Page number for pagination
+            per_page: Items per page (optional). If not provided, backend defaults are used.
+
+        Returns:
+            List of AssistantVersion objects
+        """
+
+        params: Dict[str, Any] = {"page": page}
+        if per_page is not None:
+            params["per_page"] = per_page
+        from ..models.assistant import AssistantVersion
+
+        raw = self._api.get(
+            f"/v1/assistants/{assistant_id}/versions",
+            dict,
+            params=params,
+            wrap_response=False,
+        )
+        items = []
+        if isinstance(raw, list):
+            items = raw
+        elif isinstance(raw, dict):
+            items = raw.get("data") or raw.get("versions") or []
+        else:
+            items = []
+        return [AssistantVersion.model_validate(it) for it in items]
+
+    def get_version(self, assistant_id: str, version_number: int):
+        """Get a specific assistant version by number.
+
+        Args:
+            assistant_id: Assistant identifier
+            version_number: Version number to retrieve
+
+        Returns:
+            AssistantVersion object
+        """
+        from ..models.assistant import AssistantVersion
+
+        raw = self._api.get(
+            f"/v1/assistants/{assistant_id}/versions/{version_number}", AssistantVersion
+        )
+        if isinstance(raw, dict):
+            return AssistantVersion.model_validate(raw)
+        return raw
+
+    def compare_versions(self, assistant_id: str, v1: int, v2: int) -> Dict[str, Any]:
+        """Compare two assistant versions and return diff summary.
+
+        Args:
+            assistant_id: Assistant identifier
+            v1: First version number
+            v2: Second version number
+
+        Returns:
+            Generic dictionary with comparison result (diff, summary, etc.)
+        """
+        return self._api.get(
+            f"/v1/assistants/{assistant_id}/versions/{v1}/compare/{v2}",
+            dict,
+        )
+
+    def rollback_to_version(
+        self, assistant_id: str, version_number: int, change_notes: Optional[str] = None
+    ) -> dict:
+        """Rollback assistant to a specific version. Creates a new version mirroring target.
+
+        Args:
+            assistant_id: Assistant identifier
+            version_number: Target version to rollback to
+            change_notes: Optional description of why rollback is performed
+
+        Returns:
+            Backend response (dict)
+        """
+        payload: Dict[str, Any] = {}
+        if change_notes:
+            payload["change_notes"] = change_notes
+        try:
+            return self._api.post(
+                f"/v1/assistants/{assistant_id}/versions/{version_number}/rollback",
+                dict,
+                json_data=payload,
+            )
+        except requests.HTTPError as err:
+            try:
+                assistant = self.get(assistant_id)
+                version = self.get_version(assistant_id, version_number)
+
+                update_req = AssistantUpdateRequest(
+                    name=assistant.name,
+                    description=assistant.description or "",
+                    system_prompt=version.system_prompt,
+                    project=assistant.project,
+                    llm_model_type=version.llm_model_type or assistant.llm_model_type,
+                    temperature=version.temperature
+                    if hasattr(version, "temperature")
+                    else assistant.temperature,
+                    top_p=version.top_p
+                    if hasattr(version, "top_p")
+                    else assistant.top_p,
+                    context=version.context
+                    if hasattr(version, "context")
+                    else assistant.context,
+                    toolkits=version.toolkits
+                    if hasattr(version, "toolkits")
+                    else assistant.toolkits,
+                    user_prompts=assistant.user_prompts,
+                    shared=assistant.shared,
+                    is_react=assistant.is_react,
+                    is_global=assistant.is_global,
+                    slug=assistant.slug,
+                    mcp_servers=version.mcp_servers
+                    if hasattr(version, "mcp_servers")
+                    else assistant.mcp_servers,
+                    assistant_ids=version.assistant_ids
+                    if hasattr(version, "assistant_ids")
+                    else assistant.assistant_ids,
+                )
+                resp = self.update(assistant_id, update_req)
+                resp["_rollback_fallback"] = True
+                resp["_target_version"] = version_number
+                if change_notes:
+                    resp["change_notes"] = change_notes
+                return resp
+            except Exception:
+                raise err
+
     def chat(
         self,
         assistant_id: str,
         request: AssistantChatRequest,
+        headers: Optional[Dict[str, str]] = None,
     ) -> Union[requests.Response, BaseModelResponse]:
         """Send a chat request to an assistant.
 
         Args:
             assistant_id: ID of the assistant to chat with
             request: Chat request details
+            headers: Optional additional HTTP headers (e.g., X-* for MCP propagation)
 
         Returns:
             Chat response or streaming response
@@ -198,6 +335,7 @@ class AssistantService:
             BaseModelResponse,
             json_data=request.model_dump(exclude_none=True, by_alias=True),
             stream=request.stream,
+            extra_headers=headers,
         )
         if not request.stream and pydantic_schema:
             # we do conversion to the BaseModel here because self._parse_response don't see actual request model,
@@ -206,6 +344,82 @@ class AssistantService:
 
         return response
 
+    def chat_with_version(
+        self,
+        assistant_id: str,
+        version_number: int,
+        request: AssistantChatRequest,
+    ) -> Union[requests.Response, BaseModelResponse]:
+        """Send a chat request to a specific assistant version.
+
+        Uses the stable chat endpoint with an explicit `version` parameter to
+        ensure compatibility with environments that don't expose
+        /versions/{version}/model.
+
+        Args:
+            assistant_id: ID of the assistant to chat with
+            version_number: version to pin chat to
+            request: Chat request details
+
+        Returns:
+            Chat response or streaming response
+        """
+        pydantic_schema = None
+        if issubclass(request.output_schema, BaseModel):
+            pydantic_schema = deepcopy(request.output_schema)
+            request.output_schema = request.output_schema.model_json_schema()
+
+        payload = request.model_dump(exclude_none=True, by_alias=True)
+        payload["version"] = version_number
+
+        response = self._api.post(
+            f"/v1/assistants/{assistant_id}/model",
+            BaseModelResponse,
+            json_data=payload,
+            stream=request.stream,
+        )
+        if not request.stream and pydantic_schema:
+            response.generated = pydantic_schema.model_validate(response.generated)
+
+        return response
+
+    def chat_by_slug(
+        self,
+        assistant_slug: str,
+        request: AssistantChatRequest,
+        headers: Optional[Dict[str, str]] = None,
+    ) -> Union[requests.Response, BaseModelResponse]:
+        """Send a chat request to an assistant by slug.
+
+        Args:
+            assistant_slug: Slug of the assistant to chat with
+            request: Chat request details
+            headers: Optional additional HTTP headers (e.g., X-* for MCP propagation)
+
+        Returns:
+            Chat response or streaming response
+        """
+        pydantic_schema = None
+        if (
+            request.output_schema is not None
+            and inspect.isclass(request.output_schema)
+            and 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/slug/{assistant_slug}/model",
+            BaseModelResponse,
+            json_data=request.model_dump(exclude_none=True, by_alias=True),
+            stream=request.stream,
+            extra_headers=headers,
+        )
+        if not request.stream and pydantic_schema:
+            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."""