Store
DownloadInfo
Bases: BaseModel
Contains information needed to download a file.
Attributes:
| Name | Type | Description |
|---|---|---|
file_id |
Optional[str]
|
Optional ID of the file to download |
url |
Optional[str]
|
Optional download URL for the file |
File
Bases: BaseModel
Represents a file in the Airia system with metadata and processing information.
Attributes:
| Name | Type | Description |
|---|---|---|
store_connector_id |
Optional[str]
|
Optional ID of the store connector |
parent_id |
Optional[str]
|
Optional ID of the parent file/folder |
has_parent_id |
bool
|
Whether the file has a parent ID |
id |
Optional[str]
|
Optional unique identifier for the file |
name |
Optional[str]
|
Optional name of the file |
size |
int
|
Size of the file in bytes |
mime_type |
Optional[str]
|
Optional MIME type of the file |
path |
Optional[str]
|
Optional file path |
file_last_updated_at |
Optional[Timestamp]
|
Optional timestamp of last file update |
additional_metadata_json |
Optional[str]
|
Optional JSON string containing additional metadata |
has_additional_metadata_json |
bool
|
Whether the file has additional metadata |
file_hash |
Optional[str]
|
Optional hash of the file content |
status |
str
|
Current status of the file |
user_errors |
Optional[List[str]]
|
Optional list of user-related errors |
system_errors |
Optional[List[str]]
|
Optional list of system-related errors |
folder_id |
Optional[str]
|
Optional ID of the containing folder |
has_folder_id |
bool
|
Whether the file has a folder ID |
external_id |
Optional[str]
|
Optional external identifier |
has_external_id |
bool
|
Whether the file has an external ID |
ingestion_duration |
int
|
Duration of ingestion process in milliseconds |
has_ingestion_duration |
bool
|
Whether ingestion duration is available |
tokens_consumed |
int
|
Number of tokens consumed during processing |
has_tokens_consumed |
bool
|
Whether token consumption data is available |
processing_message |
Optional[str]
|
Optional message about processing status |
has_processing_message |
bool
|
Whether a processing message is available |
processed_at |
Optional[Timestamp]
|
Optional timestamp when processing completed |
ingestion_processing_statuses |
Optional[List[IngestionProcessingStatus]]
|
Optional list of processing statuses |
GetFileResponse
Bases: BaseModel
Response model for getting a single file.
Contains file metadata, download information, and preview information.
Attributes:
| Name | Type | Description |
|---|---|---|
file |
Optional[File]
|
Optional file object with metadata and processing information |
download_info |
Optional[DownloadInfo]
|
Optional download information for the file |
preview_info |
Optional[PreviewInfo]
|
Optional preview information for the file |
GetFilesResponse
Bases: BaseModel
Response model for getting multiple files.
Contains a list of files, their download information, and total count.
Attributes:
| Name | Type | Description |
|---|---|---|
files |
Optional[List[File]]
|
Optional list of file objects with metadata and processing information |
download_infos |
Optional[List[DownloadInfo]]
|
Optional list of download information for the files |
totalCount |
int
|
Total number of files available (may be greater than files returned) |
IngestionProcessingStatus
Bases: BaseModel
Represents the processing status of a file during ingestion.
Attributes:
| Name | Type | Description |
|---|---|---|
table_document_processing_mode |
str
|
The processing mode for table documents |
user_errors |
Optional[List[str]]
|
Optional list of user-related errors during processing |
system_errors |
Optional[List[str]]
|
Optional list of system-related errors during processing |
status |
str
|
The current processing status |
PreviewInfo
Bases: BaseModel
Contains information for previewing a file.
Attributes:
| Name | Type | Description |
|---|---|---|
preview_url |
Optional[str]
|
Optional URL for file preview |
last_modified_date_time_drive |
Optional[str]
|
Optional last modified datetime from drive |
description |
Optional[str]
|
Optional description of the file |
connector_type_id |
Optional[str]
|
Optional ID of the connector type |
connector_type_name |
Optional[str]
|
Optional name of the connector type |
Timestamp
Bases: BaseModel
Represents a timestamp with seconds and nanoseconds precision.
Attributes:
| Name | Type | Description |
|---|---|---|
seconds |
int
|
The number of seconds since the epoch |
nanos |
int
|
The number of nanoseconds within the second |