airia 0.1.30__py3-none-any.whl → 0.1.32__py3-none-any.whl

airia/client/pipelines_config/base_pipelines_config.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import Literal, Optional, Union
 from urllib.parse import urljoin
 
 from ...types._api_version import ApiVersion
@@ -79,7 +79,13 @@ class BasePipelinesConfig:
 
     def _pre_get_pipelines_config(
         self,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_direction: Optional[Literal["ASC", "DESC"]] = None,
+        filter: Optional[str] = None,
         project_id: Optional[str] = None,
+        model_credential_source_type: Optional[Literal["UserProvided", "Library"]] = None,
         correlation_id: Optional[str] = None,
         api_version: str = ApiVersion.V1.value,
     ):
@@ -87,7 +93,13 @@ class BasePipelinesConfig:
         Prepare request data for getting pipelines configuration endpoint.
 
         Args:
+            page_number: The page number to be fetched
+            page_size: The number of items per page
+            sort_by: Property to sort by
+            sort_direction: The direction of the sort, either "ASC" for ascending or "DESC" for descending
+            filter: The search filter
             project_id: Optional project ID filter
+            model_credential_source_type: Optional filter to return only pipelines using models with specified source type ("UserProvided" or "Library")
             correlation_id: Optional correlation ID for tracing
             api_version: API version to use for the request
 
@@ -106,8 +118,20 @@ class BasePipelinesConfig:
             f"{api_version}/PipelinesConfig",
         )
         params = {}
+        if page_number is not None:
+            params["PageNumber"] = page_number
+        if page_size is not None:
+            params["PageSize"] = page_size
+        if sort_by is not None:
+            params["SortBy"] = sort_by
+        if sort_direction is not None:
+            params["SortDirection"] = sort_direction
+        if filter is not None:
+            params["Filter"] = filter
         if project_id is not None:
             params["projectId"] = project_id
+        if model_credential_source_type is not None:
+            params["modelCredentialSourceType"] = model_credential_source_type
 
         request_data = self._request_handler.prepare_request(
             url, params=params, correlation_id=correlation_id

airia/client/pipelines_config/sync_pipelines_config.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Literal, Optional
 
 from ...types._api_version import ApiVersion
 from ...types.api.pipelines_config import (
@@ -126,20 +126,34 @@ class PipelinesConfig(BasePipelinesConfig):
         return ExportPipelineDefinitionResponse(**resp)
 
     def get_pipelines_config(
-        self, project_id: Optional[str] = None, correlation_id: Optional[str] = None
+        self,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_direction: Optional[Literal["ASC", "DESC"]] = None,
+        filter: Optional[str] = None,
+        project_id: Optional[str] = None,
+        model_credential_source_type: Optional[Literal["UserProvided", "Library"]] = None,
+        correlation_id: Optional[str] = None,
     ) -> GetPipelinesConfigResponse:
         """
-        Retrieve a list of pipeline configurations, optionally filtered by project ID.
+        Retrieve a list of pipeline configurations with optional filtering, pagination, and sorting.
 
         This method fetches a list of pipeline configurations including their
         deployment details, execution statistics, version information, and metadata.
-        The results can be filtered by project ID to retrieve only pipelines
-        belonging to a specific project.
+        The results can be filtered, paginated, and sorted using various parameters.
 
         Args:
+            page_number (int, optional): The page number to be fetched.
+            page_size (int, optional): The number of items per page.
+            sort_by (str, optional): Property to sort by.
+            sort_direction (str, optional): The direction of the sort, either "ASC" for ascending or "DESC" for descending.
+            filter (str, optional): The search filter.
             project_id (str, optional): The unique identifier of the project to filter
                 pipelines by. If not provided, pipelines from all accessible projects
                 will be returned.
+            model_credential_source_type (str, optional): Optional filter to return only pipelines
+                using models with specified source type ("UserProvided" or "Library").
             correlation_id (str, optional): A unique identifier for request tracing
                 and logging. If not provided, one will be automatically generated.
 
@@ -168,9 +182,19 @@ class PipelinesConfig(BasePipelinesConfig):
                 if pipeline.execution_stats:
                     print(f"Success count: {pipeline.execution_stats.success_count}")
 
-            # Get pipelines for a specific project
+            # Get pipelines with pagination and sorting
+            pipelines = client.pipelines_config.get_pipelines_config(
+                page_number=1,
+                page_size=20,
+                sort_by="name",
+                sort_direction="ASC",
+                filter="classification"
+            )
+
+            # Get pipelines for a specific project with model source type filter
             project_pipelines = client.pipelines_config.get_pipelines_config(
-                project_id="your_project_id"
+                project_id="your_project_id",
+                model_credential_source_type="UserProvided"
             )
             print(f"Project pipelines: {project_pipelines.total_count}")
             ```
@@ -181,7 +205,13 @@ class PipelinesConfig(BasePipelinesConfig):
             pipeline identifier.
         """
         request_data = self._pre_get_pipelines_config(
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_direction=sort_direction,
+            filter=filter,
             project_id=project_id,
+            model_credential_source_type=model_credential_source_type,
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )

airia/client/project/async_project.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List, Literal, Optional
 
 from ...types._api_version import ApiVersion
 from ...types.api.project import ProjectItem
@@ -11,16 +11,27 @@ class AsyncProject(BaseProject):
         super().__init__(request_handler)
 
     async def get_projects(
-        self, correlation_id: Optional[str] = None
+        self,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_direction: Optional[Literal["ASC", "DESC"]] = None,
+        filter: Optional[str] = None,
+        correlation_id: Optional[str] = None,
     ) -> List[ProjectItem]:
         """
-        Retrieve a list of all projects accessible to the authenticated user.
+        Retrieve a list of all projects accessible to the authenticated user with optional pagination, sorting, and filtering.
 
         This method fetches comprehensive information about all projects that the
         current user has access to, including project metadata, creation details,
-        and status information.
+        and status information. The results can be paginated, sorted, and filtered.
 
         Args:
+            page_number (int, optional): The page number to be fetched.
+            page_size (int, optional): The number of items per page.
+            sort_by (str, optional): Property to sort by.
+            sort_direction (str, optional): The direction of the sort, either "ASC" for ascending or "DESC" for descending.
+            filter (str, optional): The search filter.
             correlation_id (str, optional): A unique identifier for request tracing
                 and logging. If not provided, one will be automatically generated.
 
@@ -50,6 +61,15 @@ class AsyncProject(BaseProject):
                 print(f"Description: {project.description}")
                 print(f"Created: {project.created_at}")
                 print("---")
+
+            # Get projects with pagination and sorting
+            projects = await client.project.get_projects(
+                page_number=1,
+                page_size=10,
+                sort_by="name",
+                sort_direction="ASC",
+                filter="my-project"
+            )
             ```
 
         Note:
@@ -58,7 +78,13 @@ class AsyncProject(BaseProject):
             access to.
         """
         request_data = self._pre_get_projects(
-            correlation_id=correlation_id, api_version=ApiVersion.V1.value
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_direction=sort_direction,
+            filter=filter,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
         )
         resp = await self._request_handler.make_request("GET", request_data)
 

airia/client/project/base_project.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import Literal, Optional, Union
 from urllib.parse import urljoin
 
 from ...types._api_version import ApiVersion
@@ -11,6 +11,11 @@ class BaseProject:
 
     def _pre_get_projects(
         self,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_direction: Optional[Literal["ASC", "DESC"]] = None,
+        filter: Optional[str] = None,
         correlation_id: Optional[str] = None,
         api_version: str = ApiVersion.V1.value,
     ):
@@ -18,6 +23,11 @@ class BaseProject:
         Prepare request data for getting projects endpoint.
 
         Args:
+            page_number: The page number to be fetched
+            page_size: The number of items per page
+            sort_by: Property to sort by
+            sort_direction: The direction of the sort, either "ASC" for ascending or "DESC" for descending
+            filter: The search filter
             correlation_id: Optional correlation ID for tracing
             api_version: API version to use for the request
 
@@ -34,8 +44,21 @@ class BaseProject:
         url = urljoin(
             self._request_handler.base_url, f"{api_version}/Project/paginated"
         )
+
+        params = {}
+        if page_number is not None:
+            params["PageNumber"] = page_number
+        if page_size is not None:
+            params["PageSize"] = page_size
+        if sort_by is not None:
+            params["SortBy"] = sort_by
+        if sort_direction is not None:
+            params["SortDirection"] = sort_direction
+        if filter is not None:
+            params["Filter"] = filter
+
         request_data = self._request_handler.prepare_request(
-            url, correlation_id=correlation_id
+            url, params=params, correlation_id=correlation_id
         )
 
         return request_data

airia/client/project/sync_project.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List, Literal, Optional
 
 from ...types._api_version import ApiVersion
 from ...types.api.project import ProjectItem
@@ -10,15 +10,28 @@ class Project(BaseProject):
     def __init__(self, request_handler: RequestHandler):
         super().__init__(request_handler)
 
-    def get_projects(self, correlation_id: Optional[str] = None) -> List[ProjectItem]:
+    def get_projects(
+        self,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
+        sort_by: Optional[str] = None,
+        sort_direction: Optional[Literal["ASC", "DESC"]] = None,
+        filter: Optional[str] = None,
+        correlation_id: Optional[str] = None,
+    ) -> List[ProjectItem]:
         """
-        Retrieve a list of all projects accessible to the authenticated user.
+        Retrieve a list of all projects accessible to the authenticated user with optional pagination, sorting, and filtering.
 
         This method fetches comprehensive information about all projects that the
         current user has access to, including project metadata, creation details,
-        and status information.
+        and status information. The results can be paginated, sorted, and filtered.
 
         Args:
+            page_number (int, optional): The page number to be fetched.
+            page_size (int, optional): The number of items per page.
+            sort_by (str, optional): Property to sort by.
+            sort_direction (str, optional): The direction of the sort, either "ASC" for ascending or "DESC" for descending.
+            filter (str, optional): The search filter.
             correlation_id (str, optional): A unique identifier for request tracing
                 and logging. If not provided, one will be automatically generated.
 
@@ -48,6 +61,15 @@ class Project(BaseProject):
                 print(f"Description: {project.description}")
                 print(f"Created: {project.created_at}")
                 print("---")
+
+            # Get projects with pagination and sorting
+            projects = client.project.get_projects(
+                page_number=1,
+                page_size=10,
+                sort_by="name",
+                sort_direction="ASC",
+                filter="my-project"
+            )
             ```
 
         Note:
@@ -56,7 +78,13 @@ class Project(BaseProject):
             access to.
         """
         request_data = self._pre_get_projects(
-            correlation_id=correlation_id, api_version=ApiVersion.V1.value
+            page_number=page_number,
+            page_size=page_size,
+            sort_by=sort_by,
+            sort_direction=sort_direction,
+            filter=filter,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
         )
         resp = self._request_handler.make_request("GET", request_data)
 

airia/client/store/async_store.py

@@ -246,17 +246,22 @@ class AsyncStore(BaseStore):
         self,
         project_id: str,
         store_connector_id: str,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
         correlation_id: Optional[str] = None,
     ) -> GetFilesResponse:
         """
-        Retrieve all files from a store connector in the Airia store asynchronously.
+        Retrieve all files from a store connector in the Airia store asynchronously with optional pagination.
 
         This method retrieves information about all files in the specified store connector
         and project, including file metadata, download URLs, and processing status.
+        The results can be paginated using the page_number and page_size parameters.
 
         Args:
             project_id: The unique identifier of the project (GUID format)
             store_connector_id: The unique identifier of the store connector (GUID format)
+            page_number: The page number to be fetched
+            page_size: The number of items per page
             correlation_id: Optional correlation ID for request tracing
 
         Returns:
@@ -285,6 +290,14 @@ class AsyncStore(BaseStore):
                     store_connector_id="your_store_connector_id"
                 )
 
+                # Get files with pagination
+                files_response = await client.store.get_files(
+                    project_id="your_project_id",
+                    store_connector_id="your_store_connector_id",
+                    page_number=1,
+                    page_size=20
+                )
+
                 # Access files list
                 if files_response.files:
                     for file in files_response.files:
@@ -310,6 +323,8 @@ class AsyncStore(BaseStore):
         request_data = self._pre_get_files(
             project_id=project_id,
             store_connector_id=store_connector_id,
+            page_number=page_number,
+            page_size=page_size,
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )

airia/client/store/base_store.py

@@ -168,6 +168,8 @@ class BaseStore:
         self,
         project_id: str,
         store_connector_id: str,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
         correlation_id: Optional[str] = None,
         api_version: str = ApiVersion.V1.value,
     ):
@@ -179,6 +181,8 @@ class BaseStore:
         Args:
             project_id: ID of the project
             store_connector_id: ID of the store connector
+            page_number: The page number to be fetched
+            page_size: The number of items per page
             correlation_id: Optional correlation ID for tracing
             api_version: API version to use for the request
 
@@ -197,8 +201,14 @@ class BaseStore:
             f"{api_version}/Store/GetAllFiles/{project_id}/{store_connector_id}",
         )
 
+        params = {}
+        if page_number is not None:
+            params["PageNumber"] = page_number
+        if page_size is not None:
+            params["PageSize"] = page_size
+
         request_data = self._request_handler.prepare_request(
-            url, payload=None, correlation_id=correlation_id
+            url, params=params, payload=None, correlation_id=correlation_id
         )
 
         return request_data

airia/client/store/sync_store.py

@@ -231,17 +231,22 @@ class Store(BaseStore):
         self,
         project_id: str,
         store_connector_id: str,
+        page_number: Optional[int] = None,
+        page_size: Optional[int] = None,
         correlation_id: Optional[str] = None,
     ) -> GetFilesResponse:
         """
-        Retrieve all files from a store connector in the Airia store.
+        Retrieve all files from a store connector in the Airia store with optional pagination.
 
         This method retrieves information about all files in the specified store connector
         and project, including file metadata, download URLs, and processing status.
+        The results can be paginated using the page_number and page_size parameters.
 
         Args:
             project_id: The unique identifier of the project (GUID format)
             store_connector_id: The unique identifier of the store connector (GUID format)
+            page_number: The page number to be fetched
+            page_size: The number of items per page
             correlation_id: Optional correlation ID for request tracing
 
         Returns:
@@ -268,6 +273,14 @@ class Store(BaseStore):
                 store_connector_id="your_store_connector_id"
             )
 
+            # Get files with pagination
+            files_response = client.store.get_files(
+                project_id="your_project_id",
+                store_connector_id="your_store_connector_id",
+                page_number=1,
+                page_size=20
+            )
+
             # Access files list
             if files_response.files:
                 for file in files_response.files:
@@ -291,6 +304,8 @@ class Store(BaseStore):
         request_data = self._pre_get_files(
             project_id=project_id,
             store_connector_id=store_connector_id,
+            page_number=page_number,
+            page_size=page_size,
             correlation_id=correlation_id,
             api_version=ApiVersion.V1.value,
         )

airia/types/api/models/list_models.py

@@ -111,7 +111,7 @@ class ModelItem(BaseModel):
     source_type: str = Field(alias="sourceType")
     type: str
     provider: str
-    tenant_id: str = Field(alias="tenantId")
+    tenant_id: Optional[str] = Field(None, alias="tenantId")
     project_id: Optional[str] = Field(None, alias="projectId")
     project_name: Optional[str] = Field(None, alias="projectName")
     project: Optional[ModelProject] = None
@@ -121,7 +121,7 @@ class ModelItem(BaseModel):
     has_tool_support: bool = Field(alias="hasToolSupport")
     has_stream_support: bool = Field(alias="hasStreamSupport")
     library_model_id: Optional[str] = Field(None, alias="libraryModelId")
-    user_provided_details: ModelUserProvidedDetails = Field(alias="userProvidedDetails")
+    user_provided_details: Optional[ModelUserProvidedDetails] = Field(None, alias="userProvidedDetails")
     allow_airia_credentials: bool = Field(alias="allowAiriaCredentials")
     allow_byok_credentials: bool = Field(alias="allowBYOKCredentials")
     price_type: str = Field(alias="priceType")

airia/types/api/pipeline_execution/__init__.py

@@ -9,13 +9,21 @@ from ._pipeline_execution import (
     TemporaryAssistantStreamedResponse,
     TimeTrackingData,
 )
+from .get_pipeline_execution import (
+    GetPipelineExecutionResponse,
+    PipelineExecutionLogDetails,
+    StepExecutionLogRecord,
+)
 
 __all__ = [
     "AgentBaseStepResult",
+    "GetPipelineExecutionResponse",
     "PipelineExecutionAsyncStreamedResponse",
+    "PipelineExecutionLogDetails",
     "PipelineExecutionResponse",
     "PipelineExecutionStreamedResponse",
     "PipelineStepResult",
+    "StepExecutionLogRecord",
     "TemporaryAssistantAsyncStreamedResponse",
     "TemporaryAssistantResponse",
     "TemporaryAssistantStreamedResponse",

airia/types/api/pipeline_execution/_pipeline_execution.py

@@ -84,11 +84,19 @@ class PipelineExecutionResponse(BaseModel):
         result: The execution result as a string
         report: Optional Dictionary containing debugging information and execution details
         is_backup_pipeline: Whether a backup pipeline was used for execution
+        execution_id: Unique execution identifier
+        user_input_id: Identifier for the user input associated with the pipeline execution
+        files: Files processed during the pipeline execution
+        images: Images processed during the pipeline execution
     """
 
     result: Optional[str]
     report: Optional[Dict[str, PipelineStepResult]] = None
     is_backup_pipeline: bool = Field(alias="isBackupPipeline")
+    execution_id: UUID = Field(alias="executionId")
+    user_input_id: Optional[UUID] = Field(None, alias="userInputId")
+    files: Optional[List[str]] = None
+    images: Optional[List[str]] = None
 
 
 class PipelineExecutionStreamedResponse(BaseModel):

airia/types/api/pipeline_execution/get_pipeline_execution.py

@@ -0,0 +1,83 @@
+"""
+Pydantic models for get_pipeline_execution API response.
+
+This module defines the response models returned by the get_pipeline_execution endpoint,
+including pipeline execution details and step execution logs.
+"""
+
+from datetime import datetime
+from typing import Optional
+from uuid import UUID
+
+from pydantic import BaseModel, Field
+
+
+class PipelineExecutionLogDetails(BaseModel):
+    """
+    Pipeline execution log details.
+
+    Attributes:
+        duration: Duration of the execution (e.g., "00:00:00.0000000").
+        started_at: Start date for the pipeline execution.
+        finished_at: End date for the pipeline execution.
+        success: Success indicator for the pipeline execution.
+        exception: First exception for the pipeline execution if any.
+    """
+
+    duration: Optional[str] = None
+    started_at: Optional[datetime] = Field(None, alias="startedAt")
+    finished_at: Optional[datetime] = Field(None, alias="finishedAt")
+    success: Optional[bool] = None
+    exception: Optional[str] = None
+
+
+class StepExecutionLogRecord(BaseModel):
+    """
+    Step execution log record.
+
+    Attributes:
+        pipeline_id: Pipeline ID.
+        step_id: Step ID.
+        step_type: Step type (e.g., "AIOperation", "dataSearch", etc.).
+        step_title: Step title.
+        duration: Duration of the execution (e.g., "00:00:00.0000000").
+        started_at: Start date for the step execution.
+        finished_at: End date for the step execution.
+        success: Success indicator for the step execution.
+        exception: First exception for the step execution if any.
+    """
+
+    pipeline_id: UUID = Field(alias="pipelineId")
+    step_id: UUID = Field(alias="stepId")
+    step_type: Optional[str] = Field(None, alias="stepType")
+    step_title: Optional[str] = Field(None, alias="stepTitle")
+    duration: Optional[str] = None
+    started_at: Optional[datetime] = Field(None, alias="startedAt")
+    finished_at: Optional[datetime] = Field(None, alias="finishedAt")
+    success: Optional[bool] = None
+    exception: Optional[str] = None
+
+
+class GetPipelineExecutionResponse(BaseModel):
+    """
+    Response model for get_pipeline_execution requests.
+
+    Attributes:
+        execution_id: Execution result ID.
+        pipeline_id: Pipeline ID.
+        tenant_id: Tenant ID.
+        project_id: Project ID.
+        log_record_details: Pipeline execution log details.
+        step_execution_log_records: Step execution logs associated to the pipeline.
+    """
+
+    execution_id: UUID = Field(alias="executionId")
+    pipeline_id: UUID = Field(alias="pipelineId")
+    tenant_id: UUID = Field(alias="tenantId")
+    project_id: UUID = Field(alias="projectId")
+    log_record_details: Optional[PipelineExecutionLogDetails] = Field(
+        None, alias="logRecordDetails"
+    )
+    step_execution_log_records: Optional[list[StepExecutionLogRecord]] = Field(
+        None, alias="stepExecutionLogRecords"
+    )

{airia-0.1.30.dist-info → airia-0.1.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airia
-Version: 0.1.30
+Version: 0.1.32
 Summary: Python SDK for Airia API
 Author-email: Airia LLC <support@airia.com>
 License: MIT