codemie-sdk-python 0.1.52__py3-none-any.whl → 0.1.258__py3-none-any.whl

codemie_sdk/__init__.py

@@ -18,6 +18,118 @@ Basic usage:
 """
 
 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.1.19"
-__all__ = ["CodeMieClient"]
+__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/auth/credentials.py

@@ -36,14 +36,15 @@ class KeycloakCredentials:
         self.password = password
         self.verify_ssl = verify_ssl
 
-        if not ((client_id and client_secret) or (username and password)):
+    def get_token(self) -> str:
+        """Get access token using either client credentials or password grant."""
+        if not (
+            (self.client_id and self.client_secret) or (self.username and self.password)
+        ):
             raise ValueError(
                 "Either client credentials (client_id, client_secret) or "
                 "user credentials (username, password) must be provided"
             )
-
-    def get_token(self) -> str:
-        """Get access token using either client credentials or password grant."""
         url = (
             f"{self.server_url}/realms/{self.realm_name}/protocol/openid-connect/token"
         )

codemie_sdk/client/client.py

@@ -4,12 +4,19 @@ from typing import Optional
 
 from ..auth.credentials import KeycloakCredentials
 from ..services.assistant import AssistantService
+from ..services.conversation import ConversationService
 from ..services.datasource import DatasourceService
 from ..services.llm import LLMService
 from ..services.integration import IntegrationService
 from ..services.task import TaskService
 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:
@@ -50,6 +57,7 @@ class CodeMieClient:
 
         self._token: Optional[str] = None
         self._api_domain = codemie_api_domain.rstrip("/")
+        self._is_localhost = self._is_localhost_domain(self._api_domain)
         self._verify_ssl = verify_ssl
         if not verify_ssl:
             import requests
@@ -57,8 +65,8 @@ class CodeMieClient:
 
             requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
 
-        # Initialize token first
-        self._token = self.auth.get_token()
+        # Initialize token
+        self._token = "" if self._is_localhost else self.auth.get_token()
 
         # Initialize services with verify_ssl parameter and token
         self.assistants = AssistantService(
@@ -76,17 +84,49 @@ class CodeMieClient:
         self.workflows = WorkflowService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
+        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
+        )
 
     @property
     def token(self) -> str:
         """Get current token or fetch new one if not available."""
-        if not self._token:
-            self._token = self.auth.get_token()
+        self._token = "" if self._is_localhost else self.auth.get_token()
         return self._token
 
+    @staticmethod
+    def _is_localhost_domain(domain: str) -> bool:
+        """Check if the domain is a localhost variant."""
+        domain_lower = domain.lower()
+        localhost_patterns = [
+            "localhost",
+            "127.0.0.1",
+            "0.0.0.0",
+            "192.168",
+        ]
+        return any(pattern in domain_lower for pattern in localhost_patterns)
+
     def refresh_token(self) -> str:
         """Force token refresh."""
-        self._token = self.auth.get_token()
+        self._token = "" if self._is_localhost else self.auth.get_token()
         # Update token in services
         self.assistants = AssistantService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
@@ -109,4 +149,25 @@ class CodeMieClient:
         self.workflows = WorkflowService(
             self._api_domain, self._token, verify_ssl=self._verify_ssl
         )
+        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/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
 
@@ -53,13 +53,58 @@ class Context(BaseModel):
     name: str
 
 
-class MCPServerConfig(BaseModel):
+class PromptVariable(BaseModel):
+    """Model for assistant prompt variables."""
+
     model_config = ConfigDict(extra="ignore")
 
-    command: str
-    args: Optional[list[str]]
-    env: Optional[dict[str, Any]] = None
-    auth_token: Optional[str] = None
+    key: str
+    description: Optional[str] = None
+    default_value: str
+
+
+class MCPServerConfig(BaseModel):
+    """
+    Configuration for an MCP server.
+
+    Defines how to start and connect to an MCP server instance, including
+    command, arguments, environment variables, and authentication parameters.
+
+    Attributes:
+        command (str): The command used to invoke the MCP server
+        args (Optional[list[str]]): List of arguments for the server command
+        env (Optional[dict[str, Any]]): Environment variables for the server process
+        auth_token (Optional[str]): Authentication token for MCP-Connect server
+    """
+
+    command: Optional[str] = Field(
+        None,
+        description="The command used to invoke the MCP server (e.g., 'npx', 'uvx') using a stdio transport",
+    )
+    url: Optional[str] = Field(
+        None,
+        description="The HTTP URL of a remote MCP server (use when connecting over HTTP/streamable-http).",
+    )
+    args: Optional[list[str]] = Field(
+        default_factory=list,
+        description="List of arguments to pass to the MCP server command",
+    )
+    headers: Optional[dict[str, str]] = Field(
+        default_factory=dict,
+        description="HTTP headers to include when connecting to an MCP server via `url`.",
+    )
+    env: Optional[dict[str, Any]] = Field(
+        default_factory=dict,
+        description="Environment variables to be set for the MCP server process",
+    )
+    type: Optional[str] = Field(
+        None,
+        description="Transport type. Set to 'streamable-http' to use a streamable HTTP transport; "
+        "leave null for stdio/sse command transports.",
+    )
+    auth_token: Optional[str] = Field(
+        None, description="Authentication token for the MCP-Connect server"
+    )
 
 
 class MCPServerDetails(BaseModel):
@@ -102,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."""
 
@@ -112,7 +168,10 @@ class Assistant(AssistantBase):
     project: str
     llm_model_type: Optional[str] = None
     toolkits: List[ToolKitDetails] = Field(default_factory=list)
-    user_prompts: List[str] = Field(default_factory=list)
+    conversation_starters: List[str] = Field(
+        default_factory=list,
+        description="List of suggested conversation starter prompts",
+    )
     shared: bool = False
     is_react: bool = False
     is_global: bool = False
@@ -126,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):
@@ -141,7 +202,10 @@ class AssistantRequestBase(AssistantBase):
     context: List[Context] = Field(default_factory=list)
     llm_model_type: str
     toolkits: List[ToolKitDetails] = Field(default_factory=list)
-    user_prompts: List[str] = Field(default_factory=list)
+    conversation_starters: List[str] = Field(
+        default_factory=list,
+        description="List of suggested conversation starter prompts",
+    )
     shared: bool = False
     is_react: bool = False
     is_global: Optional[bool] = False
@@ -150,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):
@@ -164,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."""
 
@@ -204,11 +290,13 @@ class AssistantChatRequest(BaseModel):
     """Model for chat request to assistant."""
 
     conversation_id: Optional[str] = Field(
-        default=str(uuid.uuid4()), description="Conversation identifier"
+        default_factory=lambda: str(uuid.uuid4()), description="Conversation identifier"
     )
     text: str = Field(description="User's input")
     content_raw: Optional[str] = Field(default="", description="Raw content input")
-    file_name: Optional[str] = Field(default=None, description="Associated file name")
+    file_names: List[str] = Field(
+        default_factory=list, description="List of file names"
+    )
     llm_model: Optional[str] = Field(
         default=None, description="Specific LLM model to use"
     )
@@ -217,9 +305,17 @@ class AssistantChatRequest(BaseModel):
         description="Conversation history as list of messages or string",
     )
     history_index: int = Field(
-        default=0, description="DataSource in conversation history"
+        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")
@@ -227,12 +323,26 @@ 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",
+    )
+    mcp_server_single_usage: Optional[bool] = Field(
+        default=None,
+        description="Override conversation-level MCP server lifecycle setting for this request. \
+            When true, MCP servers are created fresh and destroyed after use. \
+            When false, MCP servers are cached and reused. \
+            If not specified, uses conversation's default setting.",
+    )
 
 
 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"
     )
@@ -263,3 +373,18 @@ class EnvVars(BaseModel):
 
 class ExportAssistantPayload(BaseModel):
     env_vars: Optional[EnvVars] = None
+
+
+class AssistantEvaluationRequest(BaseModel):
+    """Model for assistant evaluation request."""
+
+    model_config = ConfigDict(extra="ignore")
+
+    dataset_id: str = Field(description="ID of the dataset to use for evaluation")
+    experiment_name: str = Field(description="Name of the evaluation experiment")
+    system_prompt: Optional[str] = Field(
+        default=None, description="System prompt to use for evaluation"
+    )
+    llm_model: Optional[str] = Field(
+        default=None, description="LLM model to use for evaluation"
+    )

codemie_sdk/models/conversation.py

@@ -0,0 +1,169 @@
+"""Models for conversation-related data structures."""
+
+from datetime import datetime
+from typing import List, Optional, Union
+
+from pydantic import BaseModel, Field
+
+from codemie_sdk.models.assistant import ContextType
+
+
+class Conversation(BaseModel):
+    """
+    Model for conversation summary data as returned from the list endpoint.
+    """
+
+    id: str
+    name: str
+    folder: Optional[str]
+    pinned: bool
+    date: str
+    assistant_ids: List[str]
+    initial_assistant_id: Optional[str]
+
+
+class Mark(BaseModel):
+    """Model for conversation review/mark data."""
+
+    mark: str
+    rating: int
+    comments: str
+    date: datetime
+    operator: Optional["Operator"] = None
+
+
+class Operator(BaseModel):
+    """Represents an operator involved in marking a conversation."""
+
+    user_id: str
+    name: str
+
+
+class Thought(BaseModel):
+    """Model for reasoning or tool-invocation within a message's history."""
+
+    id: str
+    parent_id: Optional[str]
+    metadata: dict
+    in_progress: bool
+    input_text: Optional[str]
+    message: Optional[str]
+    author_type: str
+    author_name: str
+    output_format: str
+    error: Optional[bool]
+    children: List[str]
+
+
+class HistoryMark(BaseModel):
+    """Model for conversation history review/mark data."""
+
+    mark: str
+    rating: int
+    comments: Optional[str]
+    date: datetime
+
+
+class HistoryItem(BaseModel):
+    """Represents an individual message within a conversation's history."""
+
+    role: str
+    message: str
+    historyIndex: int
+    date: datetime
+    responseTime: Optional[float]
+    inputTokens: Optional[int]
+    outputTokens: Optional[int]
+    moneySpent: Optional[float]
+    userMark: Optional[HistoryMark]
+    operatorMark: Optional[HistoryMark]
+    messageRaw: Optional[str]
+    fileNames: List[str]
+    assistantId: Optional[str]
+    thoughts: Optional[List[Thought]] = Field(default_factory=list)
+
+
+class ContextItem(BaseModel):
+    """Represents contextual settings for conversation."""
+
+    context_type: Optional[ContextType]
+    name: str
+
+
+class ToolItem(BaseModel):
+    """Represents a tool used by an assistant, including configuration and description."""
+
+    name: str
+    label: Optional[str]
+    settings_config: Optional[bool]
+    user_description: Optional[str]
+
+
+class AssistantDataItem(BaseModel):
+    """Model represents details for an assistant included in a conversation."""
+
+    assistant_id: str
+    assistant_name: str
+    assistant_icon: Optional[str]
+    assistant_type: str
+    context: List[Union[ContextItem, str]]
+    tools: List[ToolItem]
+    conversation_starters: List[str]
+
+
+class ConversationDetailsData(BaseModel):
+    """Extended details about a conversation's configuration and context."""
+
+    llm_model: Optional[str]
+    context: List[ContextItem]
+    app_name: Optional[str]
+    repo_name: Optional[str]
+    index_type: Optional[str]
+
+
+class AssistantDetailsData(BaseModel):
+    """Extended details about an assistant included in a conversation."""
+
+    assistant_id: str
+    assistant_name: str
+    assistant_icon: str
+    assistant_type: str
+    context: List[Union[ContextItem, str]]
+    tools: List[ToolItem]
+    conversation_starters: List[str]
+
+
+class ConversationCreateRequest(BaseModel):
+    """Model for creating a new conversation."""
+
+    initial_assistant_id: Optional[str] = None
+    folder: Optional[str] = None
+    mcp_server_single_usage: Optional[bool] = False
+
+
+class ConversationDetails(BaseModel):
+    """Summary information for a user conversation as returned from list endpoints."""
+
+    id: str
+    date: datetime
+    update_date: datetime
+    conversation_id: str
+    conversation_name: str
+    llm_model: Optional[str]
+    folder: Optional[str]
+    pinned: bool
+    history: List[HistoryItem]
+    user_id: str
+    user_name: str
+    assistant_ids: List[str]
+    assistant_data: List[AssistantDataItem]
+    initial_assistant_id: str
+    final_user_mark: Optional[Mark]
+    final_operator_mark: Optional[Mark]
+    project: str
+    conversation_details: Optional[ConversationDetailsData]
+    assistant_details: Optional[AssistantDetailsData]
+    user_abilities: Optional[List[str]]
+    is_folder_migrated: bool
+    category: Optional[str]
+    mcp_server_single_usage: Optional[bool] = False