deployments

Bases: BaseDeployments

Source code in airia/client/deployments/sync_deployments.py

def __init__(self, request_handler: RequestHandler):
    super().__init__(request_handler)

get_deployment(deployment_id, correlation_id=None, api_version=ApiVersion.V1.value)

Retrieve a single deployment by ID.

This method fetches a specific deployment from the Airia platform using its unique identifier. The response includes complete information about the deployment including associated pipelines, data sources, user prompts, and configuration settings.

Parameters:

Name	Type	Description	Default
deployment_id	str	The unique identifier of the deployment to retrieve	required
correlation_id	Optional[str]	Optional correlation ID for request tracing	None
api_version	str	API version to use (defaults to V1)	V1.value

Returns:

Name	Type	Description
GetDeploymentResponse	GetDeploymentResponse	Complete deployment information

Raises:

Type	Description
AiriaAPIError	If the API request fails or deployment is not found
ValueError	If an invalid API version is provided

Example

client = AiriaClient(api_key="your-api-key")
deployment = client.deployments.get_deployment("deployment-id-123")
print(f"Deployment: {deployment.deployment_name}")
print(f"Description: {deployment.description}")
print(f"Project: {deployment.project_id}")

Source code in airia/client/deployments/sync_deployments.py

def get_deployment(
    self,
    deployment_id: str,
    correlation_id: Optional[str] = None,
    api_version: str = ApiVersion.V1.value,
) -> GetDeploymentResponse:
    """
    Retrieve a single deployment by ID.

    This method fetches a specific deployment from the Airia platform using its
    unique identifier. The response includes complete information about the deployment
    including associated pipelines, data sources, user prompts, and configuration settings.

    Args:
        deployment_id: The unique identifier of the deployment to retrieve
        correlation_id: Optional correlation ID for request tracing
        api_version: API version to use (defaults to V1)

    Returns:
        GetDeploymentResponse: Complete deployment information

    Raises:
        AiriaAPIError: If the API request fails or deployment is not found
        ValueError: If an invalid API version is provided

    Example:
        ```python
        client = AiriaClient(api_key="your-api-key")
        deployment = client.deployments.get_deployment("deployment-id-123")
        print(f"Deployment: {deployment.deployment_name}")
        print(f"Description: {deployment.description}")
        print(f"Project: {deployment.project_id}")
        ```
    """
    request_data = self._pre_get_deployment(
        deployment_id=deployment_id,
        correlation_id=correlation_id,
        api_version=api_version,
    )

    response = self._request_handler.make_request("GET", request_data)

    return GetDeploymentResponse(**response)

get_deployments(tags=None, is_recommended=None, project_id=None, correlation_id=None, api_version=ApiVersion.V2.value)

Retrieve a paged list of deployments.

This method fetches deployments from the Airia platform with optional filtering by tags and recommendation status. The response includes detailed information about each deployment including associated pipelines, data sources, and user prompts.

Parameters:

Name	Type	Description	Default
tags	Optional[List[str]]	Optional list of tags to filter deployments by	None
is_recommended	Optional[bool]	Optional filter by recommended status	None
project_id	Optional[str]	Optional filter by project id	None
correlation_id	Optional[str]	Optional correlation ID for request tracing	None
api_version	str	API version to use (defaults to V2)	V2.value

Returns:

Name	Type	Description
GetDeploymentsResponse	GetDeploymentsResponse	Paged response containing deployment items and total count

Raises:

Type	Description
AiriaAPIError	If the API request fails
ValueError	If an invalid API version is provided

Example

client = AiriaClient(api_key="your-api-key")
deployments = client.deployments.get_deployments(
    tags=["production", "nlp"],
    is_recommended=True
)
print(f"Found {deployments.total_count} deployments")
for deployment in deployments.items:
    print(f"- {deployment.deployment_name}")

Source code in airia/client/deployments/sync_deployments.py

def get_deployments(
    self,
    tags: Optional[List[str]] = None,
    is_recommended: Optional[bool] = None,
    project_id: Optional[str] = None,
    correlation_id: Optional[str] = None,
    api_version: str = ApiVersion.V2.value,
) -> GetDeploymentsResponse:
    """
    Retrieve a paged list of deployments.

    This method fetches deployments from the Airia platform with optional filtering
    by tags and recommendation status. The response includes detailed information
    about each deployment including associated pipelines, data sources, and user prompts.

    Args:
        tags: Optional list of tags to filter deployments by
        is_recommended: Optional filter by recommended status
        project_id: Optional filter by project id
        correlation_id: Optional correlation ID for request tracing
        api_version: API version to use (defaults to V2)

    Returns:
        GetDeploymentsResponse: Paged response containing deployment items and total count

    Raises:
        AiriaAPIError: If the API request fails
        ValueError: If an invalid API version is provided

    Example:
        ```python
        client = AiriaClient(api_key="your-api-key")
        deployments = client.deployments.get_deployments(
            tags=["production", "nlp"],
            is_recommended=True
        )
        print(f"Found {deployments.total_count} deployments")
        for deployment in deployments.items:
            print(f"- {deployment.deployment_name}")
        ```
    """
    request_data = self._pre_get_deployments(
        tags=tags,
        is_recommended=is_recommended,
        correlation_id=correlation_id,
        api_version=api_version,
    )

    response = self._request_handler.make_request("GET", request_data)

    if project_id is not None:
        response["items"] = [
            item for item in response["items"] if item["projectId"] == project_id
        ]

    return GetDeploymentsResponse(**response)