data_vector_search

Bases: BaseDataVectorSearch

Source code in airia/client/data_vector_search/async_data_vector_search.py

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

get_file_chunks(data_store_id, file_id, correlation_id=None) async

Retrieve chunks from a specific file in a data store.

This method retrieves chunks from a file in the specified data store.

Parameters:

Name	Type	Description	Default
data_store_id	str	The unique identifier of the data store (GUID format)	required
file_id	str	The unique identifier of the file (GUID format)	required
correlation_id	Optional[str]	Optional correlation ID for request tracing	None

Returns:

Name	Type	Description
GetFileChunksResponse	GetFileChunksResponse	Object containing the chunks and pagination information

Raises:

Type	Description
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

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())

Source code in airia/client/data_vector_search/async_data_vector_search.py

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)