airia 0.1.14__py3-none-any.whl → 0.1.16__py3-none-any.whl

airia/client/pipelines_config/sync_pipelines_config.py

@@ -1,7 +1,10 @@
-from typing import List, Optional
+from typing import Optional
 
 from ...types._api_version import ApiVersion
-from ...types.api.pipelines_config import GetPipelineConfigResponse
+from ...types.api.pipelines_config import (
+    PipelineConfigResponse,
+    ExportPipelineDefinitionResponse,
+)
 from .._request_handler import RequestHandler
 from .base_pipelines_config import BasePipelinesConfig
 
@@ -10,29 +13,28 @@ class PipelinesConfig(BasePipelinesConfig):
     def __init__(self, request_handler: RequestHandler):
         super().__init__(request_handler)
 
-    def get_active_pipelines_ids(
-        self, project_id: Optional[str] = None, correlation_id: Optional[str] = None
-    ) -> List[str]:
+    def get_pipeline_config(
+        self, pipeline_id: str, correlation_id: Optional[str] = None
+    ) -> PipelineConfigResponse:
         """
-        Retrieve a list of active pipeline IDs.
+        Retrieve configuration details for a specific pipeline.
 
-        This method fetches the IDs of all active pipelines, optionally filtered by project.
-        Active pipelines are those that are currently deployed and available for execution.
+        This method fetches comprehensive information about a pipeline including its
+        deployment details, execution statistics, version information, and metadata.
 
         Args:
-            project_id (str, optional): The unique identifier of the project to filter
-                pipelines by. If not provided, returns active pipelines from all projects
-                accessible to the authenticated user.
+            pipeline_id (str): The unique identifier of the pipeline to retrieve
+                configuration for.
             correlation_id (str, optional): A unique identifier for request tracing
                 and logging. If not provided, one will be automatically generated.
 
         Returns:
-            List[str]: A list of pipeline IDs that are currently active. Returns an
-                empty list if no active pipelines are found.
+            PipelineConfigResponse: A response object containing the pipeline
+                configuration.
 
         Raises:
             AiriaAPIError: If the API request fails, including cases where:
-                - The project_id doesn't exist (404)
+                - The pipeline_id doesn't exist (404)
                 - Authentication fails (401)
                 - Access is forbidden (403)
                 - Server errors (5xx)
@@ -43,53 +45,47 @@ class PipelinesConfig(BasePipelinesConfig):
 
             client = AiriaClient(api_key="your_api_key")
 
-            # Get all active pipeline IDs
-            pipeline_ids = client.pipelines_config.get_active_pipelines_ids()
-            print(f"Found {len(pipeline_ids)} active pipelines")
-
-            # Get active pipeline IDs for a specific project
-            project_pipelines = client.pipelines_config.get_active_pipelines_ids(
-                project_id="your_project_id"
+            # Get pipeline configuration
+            config = client.pipelines_config.get_pipeline_config(
+                pipeline_id="your_pipeline_id"
             )
-            print(f"Project has {len(project_pipelines)} active pipelines")
+
+            print(f"Pipeline: {config.agent.name}")
+            print(f"Description: {config.agent.agent_description}")
             ```
 
         Note:
-            Only pipelines with active versions are returned. Inactive or archived
-            pipelines are not included in the results.
+            This method only retrieves configuration information and does not
+            execute the pipeline. Use execute_pipeline() to run the pipeline.
         """
-        request_data = self._pre_get_active_pipelines_ids(
-            project_id=project_id,
+        request_data = self._pre_get_pipeline_config(
+            pipeline_id=pipeline_id,
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )
         resp = self._request_handler.make_request("GET", request_data)
 
-        if "items" not in resp or len(resp["items"]) == 0:
-            return []
-
-        pipeline_ids = [r["activeVersion"]["pipelineId"] for r in resp["items"]]
+        return PipelineConfigResponse(**resp)
 
-        return pipeline_ids
-
-    def get_pipeline_config(
+    def export_pipeline_definition(
         self, pipeline_id: str, correlation_id: Optional[str] = None
-    ) -> GetPipelineConfigResponse:
+    ) -> ExportPipelineDefinitionResponse:
         """
-        Retrieve configuration details for a specific pipeline.
+        Export the complete definition of a pipeline including all its components.
 
-        This method fetches comprehensive information about a pipeline including its
-        deployment details, execution statistics, version information, and metadata.
+        This method retrieves a comprehensive export of a pipeline definition including
+        metadata, agent configuration, data sources, prompts, tools, models, memories,
+        Python code blocks, routers, and deployment information.
 
         Args:
-            pipeline_id (str): The unique identifier of the pipeline to retrieve
-                configuration for.
+            pipeline_id (str): The unique identifier of the pipeline to export
+                definition for.
             correlation_id (str, optional): A unique identifier for request tracing
                 and logging. If not provided, one will be automatically generated.
 
         Returns:
-            GetPipelineConfigResponse: A response object containing the pipeline
-                configuration.
+            ExportPipelineDefinitionResponse: A response object containing the complete
+                pipeline definition export.
 
         Raises:
             AiriaAPIError: If the API request fails, including cases where:
@@ -104,24 +100,26 @@ class PipelinesConfig(BasePipelinesConfig):
 
             client = AiriaClient(api_key="your_api_key")
 
-            # Get pipeline configuration
-            config = client.pipelines_config.get_pipeline_config(
+            # Export pipeline definition
+            export = client.pipelines_config.export_pipeline_definition(
                 pipeline_id="your_pipeline_id"
             )
 
-            print(f"Pipeline: {config.agent.name}")
-            print(f"Description: {config.agent.agent_description}")
+            print(f"Pipeline: {export.agent.name}")
+            print(f"Export version: {export.metadata.export_version}")
+            print(f"Data sources: {len(export.data_sources or [])}")
+            print(f"Tools: {len(export.tools or [])}")
             ```
 
         Note:
-            This method only retrieves configuration information and does not
-            execute the pipeline. Use execute_pipeline() to run the pipeline.
+            This method exports the complete pipeline definition which can be used
+            for backup, version control, or importing into other environments.
         """
-        request_data = self._pre_get_pipeline_config(
+        request_data = self._pre_export_pipeline_definition(
             pipeline_id=pipeline_id,
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )
         resp = self._request_handler.make_request("GET", request_data)
 
-        return GetPipelineConfigResponse(**resp)
+        return ExportPipelineDefinitionResponse(**resp)

airia/client/sync_client.py

@@ -11,6 +11,7 @@ from ..constants import (
 from ._request_handler import RequestHandler
 from .base_client import AiriaBaseClient
 from .conversations import Conversations
+from .deployments import Deployments
 from .pipeline_execution import PipelineExecution
 from .pipelines_config import PipelinesConfig
 from .project import Project
@@ -62,6 +63,7 @@ class AiriaClient(AiriaBaseClient):
         self.project = Project(self._request_handler)
         self.conversations = Conversations(self._request_handler)
         self.store = Store(self._request_handler)
+        self.deployments = Deployments(self._request_handler)
 
     @classmethod
     def with_openai_gateway(

airia/types/api/conversations/__init__.py

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

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/pipelines_config/__init__.py

@@ -1,3 +1,87 @@
-from .get_pipeline_config import GetPipelineConfigResponse
+"""Pipeline configuration API response types."""
 
-__all__ = ["GetPipelineConfigResponse"]
+from .get_pipeline_config import (
+    AboutDeploymentMetadata,
+    AgentDetailsEntry,
+    AgentTrigger,
+    Deployment,
+    DeploymentAssignment,
+    DeploymentUserPrompt,
+    Pipeline,
+    PipelineConfigResponse,
+    PipelineExecutionStats,
+    PipelineStep,
+    PipelineStepDependency,
+    PipelineStepHandle,
+    PipelineStepPosition,
+    PipelineVersion,
+)
+from .export_pipeline_definition import (
+    AgentDetailItemDefinition,
+    ExportPipelineDefinitionResponse,
+    ExportChunkingConfig,
+    ExportCredentialDataList,
+    ExportCredentials,
+    ExportDataSource,
+    ExportDataSourceFile,
+    ExportDependency,
+    ExportDeployment,
+    ExportHandle,
+    ExportMemory,
+    ExportMetadata,
+    ExportModel,
+    ExportPipeline,
+    ExportPipelineStep,
+    ExportPosition,
+    ExportPrompt,
+    ExportPromptMessageList,
+    ExportPythonCodeBlock,
+    ExportRouter,
+    ExportRouterConfig,
+    ExportTool,
+    ExportToolHeaders,
+    ExportToolParameters,
+    ExportUserPrompt,
+)
+
+__all__ = [
+    "AboutDeploymentMetadata",
+    "AgentDetailsEntry",
+    "AgentTrigger",
+    "Deployment",
+    "DeploymentAssignment",
+    "DeploymentUserPrompt",
+    "ExportPipelineDefinitionResponse",
+    "Pipeline",
+    "PipelineConfigResponse",
+    "PipelineExecutionStats",
+    "PipelineStep",
+    "PipelineStepDependency",
+    "PipelineStepHandle",
+    "PipelineStepPosition",
+    "PipelineVersion",
+    "AgentDetailItemDefinition",
+    "ExportChunkingConfig",
+    "ExportCredentialDataList",
+    "ExportCredentials",
+    "ExportDataSource",
+    "ExportDataSourceFile",
+    "ExportDependency",
+    "ExportDeployment",
+    "ExportHandle",
+    "ExportMemory",
+    "ExportMetadata",
+    "ExportModel",
+    "ExportPipeline",
+    "ExportPipelineStep",
+    "ExportPosition",
+    "ExportPrompt",
+    "ExportPromptMessageList",
+    "ExportPythonCodeBlock",
+    "ExportRouter",
+    "ExportRouterConfig",
+    "ExportTool",
+    "ExportToolHeaders",
+    "ExportToolParameters",
+    "ExportUserPrompt",
+]