Skip to content

data_vector_search

Bases: BaseDataVectorSearch

Source code in airia/client/data_vector_search/sync_data_vector_search.py 
10
11
def __init__(self, request_handler: RequestHandler):
    super().__init__(request_handler)

get_file_chunks(data_store_id, file_id, page_number=1, page_size=50, correlation_id=None)

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
page_number int

The page number (1-based). Default is 1.

 1
page_size int

The page size. Maximum supported value is 100. Default is 50.

 50
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 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"
)

# Get file chunks with custom pagination
chunks_response = client.data_vector_search.get_file_chunks(
    data_store_id="your_data_store_id",
    file_id="your_file_id",
    page_number=2,
    page_size=100
)

# 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}")
Source code in airia/client/data_vector_search/sync_data_vector_search.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def get_file_chunks(
    self,
    data_store_id: str,
    file_id: str,
    page_number: int = 1,
    page_size: int = 50,
    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)
        page_number: The page number (1-based). Default is 1.
        page_size: The page size. Maximum supported value is 100. Default is 50.
        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"
        )

        # Get file chunks with custom pagination
        chunks_response = client.data_vector_search.get_file_chunks(
            data_store_id="your_data_store_id",
            file_id="your_file_id",
            page_number=2,
            page_size=100
        )

        # 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,
        page_number=page_number,
        page_size=page_size,
        correlation_id=correlation_id,
        api_version=ApiVersion.V1.value,
    )

    response = self._request_handler.make_request(
        "GET", request_data, return_json=True
    )
    return GetFileChunksResponse(**response)