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

airia/client/_request_handler/base_request_handler.py

@@ -89,7 +89,7 @@ class BaseRequestHandler:
             log_payload = json.dumps(log_payload)
 
             self.logger.info(
-                f"API Request: POST {url}\n"
+                f"URL: {url}\n"
                 f"Headers: {json.dumps(log_headers)}\n"
                 f"Payload: {log_payload}\n"
                 f"Files: {log_files}\n"

airia/client/async_client.py

@@ -11,6 +11,7 @@ from ..constants import (
 from ._request_handler import AsyncRequestHandler
 from .base_client import AiriaBaseClient
 from .conversations import AsyncConversations
+from .data_vector_search import AsyncDataVectorSearch
 from .deployments import AsyncDeployments
 from .pipeline_execution import AsyncPipelineExecution
 from .pipelines_config import AsyncPipelinesConfig
@@ -64,6 +65,7 @@ class AiriaAsyncClient(AiriaBaseClient):
         self.conversations = AsyncConversations(self._request_handler)
         self.store = AsyncStore(self._request_handler)
         self.deployments = AsyncDeployments(self._request_handler)
+        self.data_vector_search = AsyncDataVectorSearch(self._request_handler)
 
     @classmethod
     def with_openai_gateway(

airia/client/data_vector_search/__init__.py

@@ -0,0 +1,4 @@
+from .async_data_vector_search import AsyncDataVectorSearch
+from .sync_data_vector_search import DataVectorSearch
+
+__all__ = ["DataVectorSearch", "AsyncDataVectorSearch"]

airia/client/data_vector_search/async_data_vector_search.py

@@ -0,0 +1,74 @@
+from typing import Optional
+
+from ...types._api_version import ApiVersion
+from ...types.api.data_vector_search import GetFileChunksResponse
+from .._request_handler import AsyncRequestHandler
+from .base_data_vector_search import BaseDataVectorSearch
+
+
+class AsyncDataVectorSearch(BaseDataVectorSearch):
+    def __init__(self, request_handler: AsyncRequestHandler):
+        super().__init__(request_handler)
+
+    async def get_file_chunks(
+        self, data_store_id: str, file_id: str, correlation_id: Optional[str] = None
+    ) -> GetFileChunksResponse:
+        """
+        Retrieve chunks from a specific file in a data store.
+
+        This method retrieves chunks from a file in the specified data store.
+
+        Args:
+            data_store_id: The unique identifier of the data store (GUID format)
+            file_id: The unique identifier of the file (GUID format)
+            correlation_id: Optional correlation ID for request tracing
+
+        Returns:
+            GetFileChunksResponse: Object containing the chunks and pagination information
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The data_store_id doesn't exist (404)
+                - The file_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+            ValueError: If required parameters are missing or invalid
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+            import asyncio
+
+            async def main():
+                client = AiriaAsyncClient(api_key="your_api_key")
+
+                # Get file chunks with default pagination
+                chunks_response = await client.data_vector_search.get_file_chunks(
+                    data_store_id="your_data_store_id",
+                    file_id="your_file_id"
+                )
+
+                # Access the chunks
+                for chunk in chunks_response.chunks:
+                    print(f"Chunk: {chunk.chunk}")
+                    print(f"Document: {chunk.document_name}")
+                    if chunk.score is not None:
+                        print(f"Score: {chunk.score}")
+
+                await client.close()
+
+            asyncio.run(main())
+            ```
+        """
+        request_data = self._pre_get_file_chunks(
+            data_store_id=data_store_id,
+            file_id=file_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        response = await self._request_handler.make_request(
+            "GET", request_data, return_json=True
+        )
+        return GetFileChunksResponse(**response)

airia/client/data_vector_search/base_data_vector_search.py

@@ -0,0 +1,50 @@
+from typing import Optional, Union
+from urllib.parse import urljoin
+
+from ...types._api_version import ApiVersion
+from .._request_handler import AsyncRequestHandler, RequestHandler
+
+
+class BaseDataVectorSearch:
+    def __init__(self, request_handler: Union[RequestHandler, AsyncRequestHandler]):
+        self._request_handler = request_handler
+
+    def _pre_get_file_chunks(
+        self,
+        data_store_id: str,
+        file_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for get file chunks endpoint.
+
+        This internal method constructs the URL for file chunks retrieval requests.
+
+        Args:
+            data_store_id: ID of the data store
+            file_id: ID of the file
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the get file chunks endpoint
+
+        Raises:
+            ValueError: If an invalid API version is provided
+        """
+        if api_version not in ApiVersion.as_list():
+            raise ValueError(
+                f"Invalid API version: {api_version}. Valid versions are: {', '.join(ApiVersion.as_list())}"
+            )
+
+        url = urljoin(
+            self._request_handler.base_url,
+            f"{api_version}/DataVectorSearch/chunks/{data_store_id}/{file_id}",
+        )
+
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id, params={"pageNumber": 1, "pageSize": 50}
+        )
+
+        return request_data

airia/client/data_vector_search/sync_data_vector_search.py

@@ -0,0 +1,68 @@
+from typing import Optional
+
+from ...types._api_version import ApiVersion
+from ...types.api.data_vector_search import GetFileChunksResponse
+from .._request_handler import RequestHandler
+from .base_data_vector_search import BaseDataVectorSearch
+
+
+class DataVectorSearch(BaseDataVectorSearch):
+    def __init__(self, request_handler: RequestHandler):
+        super().__init__(request_handler)
+
+    def get_file_chunks(
+        self, data_store_id: str, file_id: str, correlation_id: Optional[str] = None
+    ) -> GetFileChunksResponse:
+        """
+        Retrieve chunks from a specific file in a data store.
+
+        This method retrieves chunks from a file in the specified data store.
+
+        Args:
+            data_store_id: The unique identifier of the data store (GUID format)
+            file_id: The unique identifier of the file (GUID format)
+            correlation_id: Optional correlation ID for request tracing
+
+        Returns:
+            GetFileChunksResponse: Object containing the chunks and pagination information
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The data_store_id doesn't exist (404)
+                - The file_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+            ValueError: If required parameters are missing or invalid
+
+        Example:
+            ```python
+            from airia import AiriaClient
+
+            client = AiriaClient(api_key="your_api_key")
+
+            # Get file chunks with default pagination
+            chunks_response = client.data_vector_search.get_file_chunks(
+                data_store_id="your_data_store_id",
+                file_id="your_file_id"
+            )
+
+            # Access the chunks
+            for chunk in chunks_response.chunks:
+                print(f"Chunk: {chunk.chunk}")
+                print(f"Document: {chunk.document_name}")
+                if chunk.score is not None:
+                    print(f"Score: {chunk.score}")
+            ```
+        """
+        request_data = self._pre_get_file_chunks(
+            data_store_id=data_store_id,
+            file_id=file_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+
+        response = self._request_handler.make_request(
+            "GET", request_data, return_json=True
+        )
+        return GetFileChunksResponse(**response)

airia/client/pipelines_config/async_pipelines_config.py

@@ -1,7 +1,10 @@
 from typing import Optional
 
 from ...types._api_version import ApiVersion
-from ...types.api.pipelines_config import PipelineConfigResponse
+from ...types.api.pipelines_config import (
+    PipelineConfigResponse,
+    ExportPipelineDefinitionResponse,
+)
 from .._request_handler import AsyncRequestHandler
 from .base_pipelines_config import BasePipelinesConfig
 
@@ -63,3 +66,60 @@ class AsyncPipelinesConfig(BasePipelinesConfig):
         resp = await self._request_handler.make_request("GET", request_data)
 
         return PipelineConfigResponse(**resp)
+
+    async def export_pipeline_definition(
+        self, pipeline_id: str, correlation_id: Optional[str] = None
+    ) -> ExportPipelineDefinitionResponse:
+        """
+        Export the complete definition of a pipeline including all its components.
+
+        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 export
+                definition for.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            ExportPipelineDefinitionResponse: A response object containing the complete
+                pipeline definition export.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The pipeline_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaAsyncClient
+
+            client = AiriaAsyncClient(api_key="your_api_key")
+
+            # Export pipeline definition
+            export = await client.pipelines_config.export_pipeline_definition(
+                pipeline_id="your_pipeline_id"
+            )
+
+            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 exports the complete pipeline definition which can be used
+            for backup, version control, or importing into other environments.
+        """
+        request_data = self._pre_export_pipeline_definition(
+            pipeline_id=pipeline_id,
+            correlation_id=correlation_id,
+            api_version=ApiVersion.V1.value,
+        )
+        resp = await self._request_handler.make_request("GET", request_data)
+
+        return ExportPipelineDefinitionResponse(**resp)

airia/client/pipelines_config/base_pipelines_config.py

@@ -42,3 +42,37 @@ class BasePipelinesConfig:
         )
 
         return request_data
+
+    def _pre_export_pipeline_definition(
+        self,
+        pipeline_id: str,
+        correlation_id: Optional[str] = None,
+        api_version: str = ApiVersion.V1.value,
+    ):
+        """
+        Prepare request data for exporting pipeline definition endpoint.
+
+        Args:
+            pipeline_id: ID of the pipeline to export definition for
+            correlation_id: Optional correlation ID for tracing
+            api_version: API version to use for the request
+
+        Returns:
+            RequestData: Prepared request data for the export pipeline definition endpoint
+
+        Raises:
+            ValueError: If an invalid API version is provided
+        """
+        if api_version not in ApiVersion.as_list():
+            raise ValueError(
+                f"Invalid API version: {api_version}. Valid versions are: {', '.join(ApiVersion.as_list())}"
+            )
+        url = urljoin(
+            self._request_handler.base_url,
+            f"{api_version}/PipelinesConfig/export/{pipeline_id}",
+        )
+        request_data = self._request_handler.prepare_request(
+            url, correlation_id=correlation_id
+        )
+
+        return request_data

airia/client/pipelines_config/sync_pipelines_config.py

@@ -1,7 +1,10 @@
 from typing import Optional
 
 from ...types._api_version import ApiVersion
-from ...types.api.pipelines_config import PipelineConfigResponse
+from ...types.api.pipelines_config import (
+    PipelineConfigResponse,
+    ExportPipelineDefinitionResponse,
+)
 from .._request_handler import RequestHandler
 from .base_pipelines_config import BasePipelinesConfig
 
@@ -63,3 +66,60 @@ class PipelinesConfig(BasePipelinesConfig):
         resp = self._request_handler.make_request("GET", request_data)
 
         return PipelineConfigResponse(**resp)
+
+    def export_pipeline_definition(
+        self, pipeline_id: str, correlation_id: Optional[str] = None
+    ) -> ExportPipelineDefinitionResponse:
+        """
+        Export the complete definition of a pipeline including all its components.
+
+        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 export
+                definition for.
+            correlation_id (str, optional): A unique identifier for request tracing
+                and logging. If not provided, one will be automatically generated.
+
+        Returns:
+            ExportPipelineDefinitionResponse: A response object containing the complete
+                pipeline definition export.
+
+        Raises:
+            AiriaAPIError: If the API request fails, including cases where:
+                - The pipeline_id doesn't exist (404)
+                - Authentication fails (401)
+                - Access is forbidden (403)
+                - Server errors (5xx)
+
+        Example:
+            ```python
+            from airia import AiriaClient
+
+            client = AiriaClient(api_key="your_api_key")
+
+            # Export pipeline definition
+            export = client.pipelines_config.export_pipeline_definition(
+                pipeline_id="your_pipeline_id"
+            )
+
+            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 exports the complete pipeline definition which can be used
+            for backup, version control, or importing into other environments.
+        """
+        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 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 .data_vector_search import DataVectorSearch
 from .deployments import Deployments
 from .pipeline_execution import PipelineExecution
 from .pipelines_config import PipelinesConfig
@@ -64,6 +65,7 @@ class AiriaClient(AiriaBaseClient):
         self.conversations = Conversations(self._request_handler)
         self.store = Store(self._request_handler)
         self.deployments = Deployments(self._request_handler)
+        self.data_vector_search = DataVectorSearch(self._request_handler)
 
     @classmethod
     def with_openai_gateway(

airia/types/api/data_vector_search/__init__.py

@@ -0,0 +1,3 @@
+from .get_file_chunks import GetFileChunksResponse, FileChunk
+
+__all__ = ["GetFileChunksResponse", "FileChunk"]

airia/types/api/data_vector_search/get_file_chunks.py

@@ -0,0 +1,45 @@
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class FileChunk(BaseModel):
+    """Represents a chunk of a file with score and metadata.
+
+    Attributes:
+        path: Path of the chunk
+        score: Optional relevance score for the chunk
+        chunk: The text content of the chunk
+        sequence_number: Optional sequence number of the chunk in the document
+        document_id: Unique identifier of the document (GUID format)
+        document_name: Name of the document
+    """
+
+    path: Optional[str] = None
+    score: Optional[float] = None
+    chunk: str
+    sequence_number: Optional[int] = Field(None, alias="sequenceNumber")
+    document_id: Optional[str] = Field(None, alias="documentId")
+    document_name: Optional[str] = Field(None, alias="documentName")
+
+
+class GetFileChunksResponse(BaseModel):
+    """Response model for file chunks retrieval.
+
+    Attributes:
+        data_store_id: The data store identifier (GUID format)
+        file_id: The file identifier (GUID format)
+        chunks: List of chunks from the file
+        page_number: Current page number
+        page_size: Page size used for pagination
+        total_count: Total count of chunks
+        total_pages: Total number of pages
+    """
+
+    data_store_id: Optional[str] = Field(None, alias="dataStoreId")
+    file_id: Optional[str] = Field(None, alias="fileId")
+    chunks: List[FileChunk]
+    page_number: int = Field(alias="pageNumber")
+    page_size: int = Field(alias="pageSize")
+    total_count: int = Field(alias="totalCount")
+    total_pages: int = Field(alias="totalPages")

airia/types/api/pipelines_config/__init__.py

@@ -16,6 +16,33 @@ from .get_pipeline_config import (
     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",
@@ -24,6 +51,7 @@ __all__ = [
     "Deployment",
     "DeploymentAssignment",
     "DeploymentUserPrompt",
+    "ExportPipelineDefinitionResponse",
     "Pipeline",
     "PipelineConfigResponse",
     "PipelineExecutionStats",
@@ -32,4 +60,28 @@ __all__ = [
     "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",
 ]