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

codemie_sdk/__init__.py

@@ -35,9 +35,50 @@ from .models.vendor_assistant import (
     PaginationInfo,
     TokenPagination,
 )
-from .services.vendor import VendorService
+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.9"
+__version__ = "0.2.12"
 __all__ = [
     "CodeMieClient",
     "VendorType",
@@ -55,5 +96,40 @@ __all__ = [
     "VendorAssistantUninstallResponse",
     "PaginationInfo",
     "TokenPagination",
-    "VendorService",
+    "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/client/client.py

@@ -13,7 +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 import VendorService
+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:
@@ -90,7 +93,16 @@ class CodeMieClient:
         self.webhook = WebhookService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
-        self.vendors = VendorService(
+        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
         )
 
@@ -108,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)
 
@@ -139,7 +152,22 @@ class CodeMieClient:
         self.conversations = ConversationService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
-        self.vendors = VendorService(
+        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/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/vendor_knowledgebase.py

@@ -0,0 +1,151 @@
+"""Models for vendor knowledge base 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 VendorKnowledgeBaseSetting(BaseModel):
+    """Model representing a vendor knowledge base 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 VendorKnowledgeBaseSettingsResponse(BaseModel):
+    """Response model for vendor knowledge base settings list."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    data: List[VendorKnowledgeBaseSetting] = Field(
+        ..., description="List of vendor knowledge base settings"
+    )
+    pagination: PaginationInfo = Field(..., description="Pagination information")
+
+
+class VendorKnowledgeBaseStatus(str, Enum):
+    """Status of vendor knowledge base."""
+
+    PREPARED = "PREPARED"
+    NOT_PREPARED = "NOT_PREPARED"
+
+
+class VendorKnowledgeBase(BaseModel):
+    """Model representing a vendor knowledge base."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Unique identifier for the knowledge base")
+    name: str = Field(..., description="Name of the knowledge base")
+    status: VendorKnowledgeBaseStatus = Field(
+        ..., description="Status of the knowledge base"
+    )
+    description: Optional[str] = Field(
+        None, description="Description of the knowledge base"
+    )
+    updatedAt: datetime = Field(
+        ..., description="Last update timestamp", alias="updatedAt"
+    )
+    aiRunId: Optional[str] = Field(
+        None,
+        description="AI run ID if the knowledge base is installed",
+        alias="aiRunId",
+    )
+
+
+class VendorKnowledgeBasesResponse(BaseModel):
+    """Response model for vendor knowledge bases list."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    data: List[VendorKnowledgeBase] = Field(
+        ..., description="List of vendor knowledge bases"
+    )
+    pagination: TokenPagination = Field(
+        ..., description="Token-based pagination information"
+    )
+
+
+class VendorKnowledgeBaseDetail(BaseModel):
+    """Model representing detailed information about a vendor knowledge base."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Unique identifier for the knowledge base")
+    name: str = Field(..., description="Name of the knowledge base")
+    description: Optional[str] = Field(
+        None, description="Description of the knowledge base"
+    )
+    type: str = Field(..., description="Type of knowledge base (e.g., VECTOR)")
+    status: VendorKnowledgeBaseStatus = Field(
+        ..., description="Status of the knowledge base"
+    )
+    embeddingModel: str = Field(
+        ...,
+        description="Embedding model used by the knowledge base",
+        alias="embeddingModel",
+    )
+    kendraIndexArn: Optional[str] = Field(
+        None, description="Kendra index ARN if applicable", alias="kendraIndexArn"
+    )
+    createdAt: datetime = Field(
+        ..., description="Creation timestamp", alias="createdAt"
+    )
+    updatedAt: datetime = Field(
+        ..., description="Last update timestamp", alias="updatedAt"
+    )
+    aiRunId: Optional[str] = Field(
+        None,
+        description="AI run ID if the knowledge base is installed",
+        alias="aiRunId",
+    )
+
+
+class VendorKnowledgeBaseInstallRequest(BaseModel):
+    """Model for a single knowledge base installation request."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    id: str = Field(..., description="Knowledge base ID to install")
+    setting_id: str = Field(..., description="Vendor setting ID")
+
+
+class VendorKnowledgeBaseInstallSummary(BaseModel):
+    """Model for knowledge base installation summary."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    knowledgeBaseId: str = Field(..., description="Installed knowledge base ID")
+    aiRunId: str = Field(..., description="AI run ID for the installation")
+
+
+class VendorKnowledgeBaseInstallResponse(BaseModel):
+    """Response model for knowledge base installation."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    summary: List[VendorKnowledgeBaseInstallSummary] = Field(
+        ..., description="List of installation summaries"
+    )
+
+
+class VendorKnowledgeBaseUninstallResponse(BaseModel):
+    """Response model for knowledge base uninstallation."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    success: bool = Field(..., description="Whether the uninstallation was successful")