Deployments

API types for deployment management.

This module exports all deployment-related response models and types used by the deployments API endpoints.

`AboutDeploymentMetadata`

Bases: 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:

Name	Type	Description
`version`	`int`	Version of the About Deployment metadata format
`video_url`	`str`	URL to an explanatory video for the deployment

`DataSource`

Bases: BaseModel

Condensed version of the datasource DTO.

Represents basic data source information associated with deployments.

Attributes:

Name	Type	Description
`id`	`Optional[UUID]`	Optional unique identifier for the data source
`name`	`Optional[str]`	Optional human-readable name of the data source

`DeploymentItem`

Bases: 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:

Name	Type	Description
`deployment_id`	`UUID`	Unique identifier for the deployment
`pipeline_id`	`UUID`	Unique identifier of the pipeline powering this deployment
`deployment_name`	`str`	Human-readable name of the deployment
`deployment_icon_url`	`Optional[str]`	Optional URL to the deployment's icon image
`description`	`str`	Detailed description of what the deployment does
`project_id`	`UUID`	Unique identifier of the project containing this deployment
`project_name`	`Optional[str]`	Name of the project containing this deployment
`user_prompts`	`List[UserPrompt]`	List of user prompts associated with this deployment
`data_sources`	`List[DataSource]`	List of data sources that the deployment can access
`is_recommended`	`bool`	Whether this deployment is marked as recommended
`tags`	`List[str]`	List of tags for categorizing and filtering deployments
`is_pinned`	`bool`	Whether this deployment is pinned for the current user
`deployment_type`	`str`	Type of deployment (Chat, AddinChat, etc.)
`conversation_type`	`str`	Type of conversation this deployment supports
`created_at`	`Optional[datetime]`	Timestamp when the deployment was created
`pipeline_user_id`	`Optional[UUID]`	ID of the user who created the underlying pipeline
`pipeline_name`	`Optional[str]`	Name of the underlying pipeline/agent
`deployment_prompt`	`Optional[str]`	Optional hardcoded prompt type for the deployment
`about_deployment_metadata`	`Optional[AboutDeploymentMetadata]`	Optional metadata for the About tab

`GetDeploymentResponse`

Bases: 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:

Name	Type	Description
`id`	`UUID`	Unique deployment identifier
`pipeline_id`	`UUID`	Unique identifier of the pipeline powering this deployment
`pipeline_name`	`Optional[str]`	Name of the pipeline associated with this deployment
`project_id`	`UUID`	Unique identifier of the project containing this deployment
`deployment_name`	`str`	Human-readable name of the deployment
`deployment_icon_url`	`Optional[str]`	Optional URL to the deployment's icon image
`deployment_icon_id`	`Optional[UUID]`	Optional unique identifier for the deployment icon
`description`	`str`	Detailed description of what the deployment does
`tags`	`List[str]`	List of tags for categorizing and filtering deployments
`is_recommended`	`bool`	Whether this deployment is marked as recommended
`user_prompts`	`List[UserPrompt]`	List of user prompts associated with this deployment
`deployment_prompt`	`Optional[str]`	Optional hardcoded prompt type for the deployment
`user_ids`	`Optional[List[UUID]]`	List of user IDs that have access to this deployment
`group_ids`	`Optional[List[UUID]]`	List of group IDs that have access to this deployment
`conversation_type`	`str`	Type of conversation this deployment supports
`data_sources`	`List[DataSource]`	List of data sources that the deployment can access
`pipeline_user_id`	`Optional[UUID]`	ID of the user who created the underlying pipeline
`about`	`Optional[AboutDeploymentMetadata]`	Optional metadata for the About tab

`GetDeploymentsResponse`

Bases: 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:

Name	Type	Description
`items`	`List[DeploymentItem]`	List of deployment items in the current page
`total_count`	`int`	Total number of deployments matching the query

`Project`

Bases: BaseModel

The base project model.

Represents basic project information within deployment contexts.

Attributes:

Name	Type	Description
`id`	`UUID`	Unique project identifier
`name`	`str`	Human-readable project name

`UserPrompt`

Bases: 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:

Name	Type	Description
`user_prompt_id`	`UUID`	Unique identifier for the user prompt
`name`	`str`	Human-readable name of the user prompt
`message`	`str`	The actual prompt message content
`description`	`str`	Detailed description of what the prompt does
`updated_at`	`datetime`	Timestamp of when the prompt was last modified
`active_deployments`	`int`	Number of active deployments using this prompt
`project_id`	`UUID`	Unique identifier of the project containing this prompt
`project_name`	`Optional[str]`	Name of the project containing this prompt
`project`	`Optional[Project]`	Complete project information associated with this prompt