airia 0.1.13__py3-none-any.whl → 0.1.15__py3-none-any.whl

airia/constants.py

@@ -17,4 +17,4 @@ DEFAULT_ANTHROPIC_GATEWAY_URL = "https://gateway.airia.ai/anthropic"
 
 # Default timeouts
 DEFAULT_TIMEOUT = 30.0
-"""Default timeout in seconds for API requests."""
+"""Default timeout in seconds for API requests."""

airia/exceptions.py

@@ -1,20 +1,20 @@
 class AiriaAPIError(Exception):
-    '''
+    """
     Custom exception for Airia API errors.
-    
+
     This exception is raised when an API request to the Airia service fails.
     It contains both the HTTP status code and error message to help with
     debugging and proper error handling.
-    
+
     Attributes:
         status_code (int): The HTTP status code returned by the API
         message (str): The error message describing what went wrong
-    '''
-    
+    """
+
     def __init__(self, status_code: int, message: str):
         """
         Initialize the exception with a status code and error message.
-        
+
         Args:
             status_code (int): The HTTP status code of the failed request
             message (str): A descriptive error message
@@ -22,11 +22,11 @@ class AiriaAPIError(Exception):
         super().__init__(f"{status_code}: {message}")
         self.status_code = status_code
         self.message = message
-    
+
     def __str__(self) -> str:
         """
         Return a string representation of the exception.
-        
+
         Returns:
             str: A formatted string containing the status code and message
         """

airia/logs.py

@@ -8,13 +8,13 @@ import loguru
 from loguru import logger
 
 # Create a context variable to store correlation ID
-correlation_id_context: ContextVar[str] = ContextVar('correlation_id', default='')
+correlation_id_context: ContextVar[str] = ContextVar("correlation_id", default="")
 
 
 def get_correlation_id() -> str:
     """
     Get the current correlation ID from context or return empty string if not set.
-    
+
     Returns:
         str: The current correlation ID
     """
@@ -24,10 +24,10 @@ def get_correlation_id() -> str:
 def set_correlation_id(correlation_id: Optional[str] = None) -> str:
     """
     Set a correlation ID in the current context.
-    
+
     Args:
         correlation_id (Optional[str]): The correlation ID to set. If None, a new UUID will be generated.
-        
+
     Returns:
         str: The correlation ID that was set
     """
@@ -39,7 +39,7 @@ def set_correlation_id(correlation_id: Optional[str] = None) -> str:
 
 def clear_correlation_id() -> None:
     """Clear the correlation ID from the current context."""
-    correlation_id_context.set('')
+    correlation_id_context.set("")
 
 
 # Define a function to be used as a filter to inject correlation_id
@@ -98,7 +98,7 @@ def configure_logging(
 
     # Add the new handler
     logger.add(sink, **kwargs)
-    
+
     return logger
 
 
@@ -107,15 +107,15 @@ if __name__ == "__main__":
     # Basic configuration (uses sys.stderr)
     log = configure_logging()
     log.info("Basic logging configured successfully")
-    
+
     # Set a correlation ID
     set_correlation_id("request-123")
     log.info("This log has a correlation ID")
-    
+
     # Change correlation ID
     set_correlation_id("request-456")
     log.info("This log has a different correlation ID")
-    
+
     # Use auto-generated correlation ID
     set_correlation_id()
     log.info("This log has an auto-generated correlation ID")

airia/types/_request_data.py

@@ -4,28 +4,35 @@ Internal data structures for HTTP request preparation.
 This module defines the data models used internally by the SDK clients
 to organize and pass request information between methods.
 """
-from typing import Any, Dict, Optional
 
-from pydantic import BaseModel
+from io import BufferedIOBase
+from typing import Any, Dict, Optional, Tuple
+
+from pydantic import BaseModel, ConfigDict
 
 
 class RequestData(BaseModel):
     """
     Structured container for HTTP request components.
-    
+
     This internal data structure organizes all the components needed to make
     an HTTP request, including the URL, headers, payload, query parameters,
     and correlation ID for tracing.
-    
+
     Attributes:
         url: The complete URL for the HTTP request
         payload: Optional JSON payload for the request body
         params: Optional query parameters to append to the URL
+        files: Optional file data to be uploaded in the request body
         headers: HTTP headers including authentication and content-type
         correlation_id: Unique identifier for request tracing and logging
     """
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
     url: str
     payload: Optional[Dict[str, Any]]
     params: Optional[Dict[str, Any]]
+    files: Optional[Dict[str, Tuple[str, BufferedIOBase, str]]]
     headers: Dict[str, Any]
     correlation_id: str

airia/types/api/__init__.py

@@ -1,27 +0,0 @@
-"""
-API response models for the Airia SDK.
-
-This package contains Pydantic models that define the structure of responses
-from various Airia API endpoints, including pipeline execution, project management,
-conversation handling, and configuration retrieval.
-"""
-from .get_projects import ProjectItem
-from .get_pipeline_config import GetPipelineConfigResponse
-from .pipeline_execution import (
-    PipelineExecutionDebugResponse,
-    PipelineExecutionResponse,
-    PipelineExecutionAsyncStreamedResponse,
-    PipelineExecutionStreamedResponse,
-)
-from .conversations import CreateConversationResponse, GetConversationResponse
-
-__all__ = [
-    "PipelineExecutionDebugResponse",
-    "PipelineExecutionResponse",
-    "PipelineExecutionStreamedResponse",
-    "PipelineExecutionAsyncStreamedResponse",
-    "GetPipelineConfigResponse",
-    "ProjectItem",
-    "CreateConversationResponse",
-    "GetConversationResponse",
-]

airia/types/api/conversations/__init__.py

@@ -0,0 +1,13 @@
+from ._conversations import (
+    ConversationMessage,
+    CreateConversationResponse,
+    GetConversationResponse,
+    PolicyRedaction,
+)
+
+__all__ = [
+    "CreateConversationResponse",
+    "GetConversationResponse",
+    "ConversationMessage",
+    "PolicyRedaction",
+]

airia/types/api/{conversations.py → conversations/_conversations.py}

@@ -4,6 +4,7 @@ Pydantic models for conversation management API responses.
 This module defines data structures for conversation operations including
 creation, retrieval, and message management within the Airia platform.
 """
+
 from typing import Optional, List, Dict
 from datetime import datetime
 
@@ -11,24 +12,37 @@ from pydantic import BaseModel, Field
 
 
 class PolicyRedaction(BaseModel):
-    """
-    Information about content that was redacted due to policy violations.
-    
+    """Information about content that was redacted due to policy violations.
+
     When content in a conversation violates platform policies, this model
     tracks what was redacted and where it occurred.
+
+    Attributes:
+        violating_text: The text content that violated platform policies
+        violating_message_index: Index of the message containing the violation
     """
+
     violating_text: str = Field(alias="violatingText")
     violating_message_index: int = Field(alias="violatingMessageIndex")
 
 
 class ConversationMessage(BaseModel):
-    """
-    Individual message within a conversation.
-    
+    """Individual message within a conversation.
+
     Represents a single message exchange in a conversation, which can be
     from a user, assistant, or system. Messages may include text content
     and optional image attachments.
+
+    Attributes:
+        id: Unique identifier for the message
+        conversation_id: ID of the conversation this message belongs to
+        message: Optional text content of the message
+        created_at: Timestamp when the message was created
+        updated_at: Timestamp when the message was last updated
+        role: Role of the message sender (user, assistant, system)
+        images: Optional list of image URLs or identifiers
     """
+
     id: str
     conversation_id: str = Field(alias="conversationId")
     message: Optional[str] = None
@@ -39,13 +53,26 @@ class ConversationMessage(BaseModel):
 
 
 class GetConversationResponse(BaseModel):
-    """
-    Complete conversation data including messages and metadata.
-    
+    """Complete conversation data including messages and metadata.
+
     This response contains all information about a conversation including
     its message history, associated files, execution status, and any
     content moderation actions that have been applied.
+
+    Attributes:
+        user_id: ID of the user who owns the conversation
+        conversation_id: Unique identifier for the conversation
+        messages: List of messages in the conversation
+        title: Optional title for the conversation
+        websocket_url: Optional WebSocket URL for real-time updates
+        deployment_id: Optional ID of the deployment handling the conversation
+        data_source_files: Dictionary mapping data sources to their files
+        is_bookmarked: Whether the conversation is bookmarked by the user
+        policy_redactions: Optional dictionary of policy violations and redactions
+        last_execution_status: Optional status of the last execution
+        last_execution_id: Optional ID of the last execution
     """
+
     user_id: str = Field(alias="userId")
     conversation_id: str = Field(alias="conversationId")
     messages: List[ConversationMessage]
@@ -62,12 +89,22 @@ class GetConversationResponse(BaseModel):
 
 
 class CreateConversationResponse(BaseModel):
-    """
-    Response data for newly created conversations.
-    
+    """Response data for newly created conversations.
+
     Contains the essential information needed to begin interacting with
     a new conversation, including connection details and visual metadata.
+
+    Attributes:
+        user_id: ID of the user who created the conversation
+        conversation_id: Unique identifier for the new conversation
+        websocket_url: WebSocket URL for real-time conversation updates
+        deployment_id: ID of the deployment handling the conversation
+        icon_id: Optional ID of the conversation icon
+        icon_url: Optional URL of the conversation icon
+        description: Optional description of the conversation
+        space_name: Optional name of the space containing the conversation
     """
+
     user_id: str = Field(alias="userId")
     conversation_id: str = Field(alias="conversationId")
     websocket_url: str = Field(alias="websocketUrl")

airia/types/api/deployments/__init__.py

@@ -0,0 +1,26 @@
+"""
+API types for deployment management.
+
+This module exports all deployment-related response models and types
+used by the deployments API endpoints.
+"""
+
+from .get_deployment import GetDeploymentResponse
+from .get_deployments import (
+    AboutDeploymentMetadata,
+    DataSource,
+    DeploymentItem,
+    GetDeploymentsResponse,
+    Project,
+    UserPrompt,
+)
+
+__all__ = [
+    "AboutDeploymentMetadata",
+    "DataSource",
+    "DeploymentItem",
+    "GetDeploymentResponse",
+    "GetDeploymentsResponse",
+    "Project",
+    "UserPrompt",
+]

airia/types/api/deployments/get_deployment.py

@@ -0,0 +1,106 @@
+"""
+Pydantic models for single deployment API responses.
+
+This module defines the data structures returned by the get_deployment endpoint,
+which retrieves a single deployment by ID.
+"""
+
+from typing import List, Optional
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+from .get_deployments import AboutDeploymentMetadata, DataSource, UserPrompt
+
+
+class GetDeploymentResponse(BaseModel):
+    """
+    Response model for retrieving a single deployment.
+
+    Represents a deployment DTO with complete information about the deployment,
+    including its configuration, associated resources, and metadata.
+
+    Attributes:
+        id: Unique deployment identifier
+        pipeline_id: Unique identifier of the pipeline powering this deployment
+        pipeline_name: Name of the pipeline associated with this deployment
+        project_id: Unique identifier of the project containing this deployment
+        deployment_name: Human-readable name of the deployment
+        deployment_icon_url: Optional URL to the deployment's icon image
+        deployment_icon_id: Optional unique identifier for the deployment icon
+        description: Detailed description of what the deployment does
+        tags: List of tags for categorizing and filtering deployments
+        is_recommended: Whether this deployment is marked as recommended
+        user_prompts: List of user prompts associated with this deployment
+        deployment_prompt: Optional hardcoded prompt type for the deployment
+        user_ids: List of user IDs that have access to this deployment
+        group_ids: List of group IDs that have access to this deployment
+        conversation_type: Type of conversation this deployment supports
+        data_sources: List of data sources that the deployment can access
+        pipeline_user_id: ID of the user who created the underlying pipeline
+        about: Optional metadata for the About tab
+    """
+
+    id: UUID = Field(description="Gets the deployment ID.")
+    pipeline_id: UUID = Field(
+        alias="pipelineId",
+        description="Gets the pipeline ID associated with this deployment.",
+    )
+    pipeline_name: Optional[str] = Field(
+        None,
+        alias="pipelineName",
+        description="Gets the pipeline name associated with this deployment.",
+    )
+    project_id: UUID = Field(
+        alias="projectId",
+        description="Gets the project ID associated with this deployment.",
+    )
+    deployment_name: str = Field(
+        alias="deploymentName", description="Gets the deployment name."
+    )
+    deployment_icon_url: Optional[str] = Field(
+        None, alias="deploymentIconUrl", description="Gets the Deployment Icon URL."
+    )
+    deployment_icon_id: Optional[UUID] = Field(
+        None, alias="deploymentIconId", description="Gets the Deployment Icon Id."
+    )
+    description: str = Field(description="Gets the deployment description.")
+    tags: List[str] = Field(description="Gets the Tags.")
+    is_recommended: bool = Field(
+        alias="isRecommended",
+        description="Gets a value indicating whether the deployment is recommended.",
+    )
+    user_prompts: List[UserPrompt] = Field(
+        alias="userPrompts",
+        description="Gets the user prompts associated with this deployment.",
+    )
+    deployment_prompt: Optional[str] = Field(
+        None,
+        alias="deploymentPrompt",
+        description="Gets or sets the optional deployment prompt type.",
+    )
+    user_ids: Optional[List[UUID]] = Field(
+        alias="userIds",
+        description="Gets or sets the user IDs associated with this deployment.",
+    )
+    group_ids: Optional[List[UUID]] = Field(
+        alias="groupIds",
+        description="Gets or sets the group IDs associated with this deployment.",
+    )
+    conversation_type: str = Field(
+        alias="conversationType",
+        description="Gets or sets the conversation start type for this deployment.",
+    )
+    data_sources: List[DataSource] = Field(
+        alias="dataSources",
+        description="Gets the data sources associated with this deployment.",
+    )
+    pipeline_user_id: Optional[UUID] = Field(
+        None,
+        alias="pipelineUserId",
+        description="Gets the ID of the user who created deployed agent.",
+    )
+    about: Optional[AboutDeploymentMetadata] = Field(
+        None,
+        description="Gets the deployment metadata for the 'About' section.",
+    )

airia/types/api/deployments/get_deployments.py

@@ -0,0 +1,224 @@
+"""
+Pydantic models for deployment API responses.
+
+This module defines the data structures returned by deployment-related endpoints,
+including deployment listings with metadata, user prompts, and data sources.
+"""
+
+from datetime import datetime
+from typing import List, Optional
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+
+class Project(BaseModel):
+    """
+    The base project model.
+
+    Represents basic project information within deployment contexts.
+
+    Attributes:
+        id: Unique project identifier
+        name: Human-readable project name
+    """
+
+    id: UUID = Field(description="Gets or sets the project identifier.")
+    name: str = Field(description="Gets or sets the project name.")
+
+
+class DataSource(BaseModel):
+    """
+    Condensed version of the datasource DTO.
+
+    Represents basic data source information associated with deployments.
+
+    Attributes:
+        id: Optional unique identifier for the data source
+        name: Optional human-readable name of the data source
+    """
+
+    id: Optional[UUID] = Field(
+        None, description="Gets or Sets the datasource identifier."
+    )
+    name: Optional[str] = Field(None, description="Gets or Sets the datasource name.")
+
+
+class UserPrompt(BaseModel):
+    """
+    Represents a user prompt entity in the system.
+
+    User prompts are reusable text templates that can be associated with deployments
+    to provide consistent interaction patterns.
+
+    Attributes:
+        user_prompt_id: Unique identifier for the user prompt
+        name: Human-readable name of the user prompt
+        message: The actual prompt message content
+        description: Detailed description of what the prompt does
+        updated_at: Timestamp of when the prompt was last modified
+        active_deployments: Number of active deployments using this prompt
+        project_id: Unique identifier of the project containing this prompt
+        project_name: Name of the project containing this prompt
+        project: Complete project information associated with this prompt
+    """
+
+    user_prompt_id: UUID = Field(
+        alias="userPromptId",
+        description="Gets or sets the unique identifier for the user prompt.",
+    )
+    name: str = Field(description="Gets or sets the name of the UserPrompt.")
+    message: str = Field(description="Gets or sets the UserPrompt Message.")
+    description: str = Field(description="Gets or sets the UserPrompt Description.")
+    updated_at: datetime = Field(
+        alias="updatedAt",
+        description="Gets or sets the last modified date of the UserPrompt.",
+    )
+    active_deployments: int = Field(
+        alias="activeDeployments",
+        description="Gets or sets the number of active deployments for the UserPrompt.",
+    )
+    project_id: UUID = Field(
+        alias="projectId",
+        description="Gets or sets the unique identifier of the project that the prompt belongs to.",
+    )
+    project_name: Optional[str] = Field(
+        None,
+        alias="projectName",
+        description="Gets or sets the name of the project that the prompt belongs to.",
+    )
+    project: Optional[Project] = Field(None, description="Gets or sets the project.")
+
+
+class AboutDeploymentMetadata(BaseModel):
+    """
+    Represents metadata about a deployment for the About tab.
+
+    Contains additional information displayed in the deployment's About section,
+    including documentation and multimedia resources.
+
+    Attributes:
+        version: Version of the About Deployment metadata format
+        video_url: URL to an explanatory video for the deployment
+    """
+
+    version: int = Field(
+        description="Gets or sets the version of the About Deployment metadata."
+    )
+    video_url: str = Field(alias="videoUrl", description="Gets or sets the video url.")
+
+
+class DeploymentItem(BaseModel):
+    """
+    Represents a deployment DTO.
+
+    A deployment is a configured and published AI agent that can be used for conversations.
+    It contains all the necessary information including the underlying pipeline,
+    associated data sources, user prompts, and configuration settings.
+
+    Attributes:
+        deployment_id: Unique identifier for the deployment
+        pipeline_id: Unique identifier of the pipeline powering this deployment
+        deployment_name: Human-readable name of the deployment
+        deployment_icon_url: Optional URL to the deployment's icon image
+        description: Detailed description of what the deployment does
+        project_id: Unique identifier of the project containing this deployment
+        project_name: Name of the project containing this deployment
+        user_prompts: List of user prompts associated with this deployment
+        data_sources: List of data sources that the deployment can access
+        is_recommended: Whether this deployment is marked as recommended
+        tags: List of tags for categorizing and filtering deployments
+        is_pinned: Whether this deployment is pinned for the current user
+        deployment_type: Type of deployment (Chat, AddinChat, etc.)
+        conversation_type: Type of conversation this deployment supports
+        created_at: Timestamp when the deployment was created
+        pipeline_user_id: ID of the user who created the underlying pipeline
+        pipeline_name: Name of the underlying pipeline/agent
+        deployment_prompt: Optional hardcoded prompt type for the deployment
+        about_deployment_metadata: Optional metadata for the About tab
+    """
+
+    deployment_id: UUID = Field(
+        alias="deploymentId", description="Gets the deployment ID."
+    )
+    pipeline_id: UUID = Field(
+        alias="pipelineId",
+        description="Gets the pipeline ID associated with this deployment.",
+    )
+    deployment_name: str = Field(
+        alias="deploymentName", description="Gets the deployment name."
+    )
+    deployment_icon_url: Optional[str] = Field(
+        None, alias="deploymentIconUrl", description="Gets the Deployment Icon URL."
+    )
+    description: str = Field(description="Gets the deployment description.")
+    project_id: UUID = Field(
+        alias="projectId",
+        description="Gets the projectId associated with this deployment.",
+    )
+    project_name: Optional[str] = Field(
+        None,
+        alias="projectName",
+        description="Gets the project name associated with this deployment.",
+    )
+    user_prompts: List[UserPrompt] = Field(
+        alias="userPrompts",
+        description="Gets the user prompts associated with this deployment.",
+    )
+    data_sources: List[DataSource] = Field(
+        alias="dataSources",
+        description="Gets the data sources associated with this deployment.",
+    )
+    is_recommended: bool = Field(
+        alias="isRecommended",
+        description="Gets a value indicating whether the deployment is recommended.",
+    )
+    tags: List[str] = Field(description="Gets the Tags.")
+    is_pinned: bool = Field(
+        alias="isPinned",
+        description="Gets a value indicating whether the deployment is pinned for this user.",
+    )
+    deployment_type: str = Field(
+        alias="deploymentType", description="Gets the deployment type."
+    )
+    conversation_type: str = Field(
+        alias="conversationType",
+        description="Gets or sets the conversation start type for this deployment.",
+    )
+    created_at: Optional[datetime] = Field(
+        None, alias="createdAt", description="Gets when the deployment was created."
+    )
+    pipeline_user_id: Optional[UUID] = Field(
+        None,
+        alias="pipelineUserId",
+        description="Gets the ID of the user who created deployed agent.",
+    )
+    pipeline_name: Optional[str] = Field(
+        None, alias="pipelineName", description="Gets the name of the agent."
+    )
+    deployment_prompt: Optional[str] = Field(
+        None, alias="deploymentPrompt", description="Gets the deployment prompt."
+    )
+    about_deployment_metadata: Optional[AboutDeploymentMetadata] = Field(
+        None,
+        alias="aboutDeploymentMetadata",
+        description="Gets the metadata about the deployment, such as the video link.",
+    )
+
+
+class GetDeploymentsResponse(BaseModel):
+    """
+    Paged results for deployment entities.
+
+    Contains a paginated list of deployments along with the total count,
+    allowing for efficient retrieval of large deployment collections.
+
+    Attributes:
+        items: List of deployment items in the current page
+        total_count: Total number of deployments matching the query
+    """
+
+    items: List[DeploymentItem] = Field(description="Gets or sets a list of items.")
+    total_count: int = Field(
+        alias="totalCount", description="Gets or sets the total count of items."
+    )

airia/types/api/pipeline_execution/__init__.py

@@ -0,0 +1,13 @@
+from ._pipeline_execution import (
+    PipelineExecutionAsyncStreamedResponse,
+    PipelineExecutionDebugResponse,
+    PipelineExecutionResponse,
+    PipelineExecutionStreamedResponse,
+)
+
+__all__ = [
+    "PipelineExecutionDebugResponse",
+    "PipelineExecutionResponse",
+    "PipelineExecutionStreamedResponse",
+    "PipelineExecutionAsyncStreamedResponse",
+]