Interface AssistantFileModel

The response format for a successful file upload request.

Export

AssistantFileModel

interface AssistantFileModel {
    createdOn?: Date;
    errorMessage?: null | string;
    id: string;
    metadata?: null | object;
    multimodal?: boolean;
    name: string;
    percentDone?: null | number;
    signedUrl?: null | string;
    status?: string;
    updatedOn?: Date;
}

Properties

createdOn? errorMessage? id metadata? multimodal? name percentDone? signedUrl? status? updatedOn?

Properties

OptionalcreatedOn

createdOn?: Date

Memberof

AssistantFileModel

OptionalerrorMessage

errorMessage?: null | string

A message describing any error during file processing. Provided only if an error occurs.

Memberof

AssistantFileModel

id

id: string

Memberof

AssistantFileModel

Optionalmetadata

metadata?: null | object

Memberof

AssistantFileModel

Optionalmultimodal

multimodal?: boolean

Indicates whether the file was processed as multimodal.

Memberof

AssistantFileModel

name

name: string

Memberof

AssistantFileModel

OptionalpercentDone

percentDone?: null | number

The percentage of the file that has been processed

Memberof

AssistantFileModel

OptionalsignedUrl

signedUrl?: null | string

A signed URL that provides temporary, read-only access to the underlying file. Anyone with the link can access the file, so treat it as sensitive data. Expires after a short time.

Memberof

AssistantFileModel

Optionalstatus

status?: string

The current state of the uploaded file. Possible values:

  • Processing: File is being processed (parsed, chunked, embedded)
  • Available: Processing completed successfully; file is ready for use
  • Deleting: Deletion has been initiated but not yet completed
  • ProcessingFailed: Processing failed with an error

Note: Once a file is deleted, the API returns 404 Not Found instead of a file object.

Memberof

AssistantFileModel

OptionalupdatedOn

updatedOn?: Date

Memberof

AssistantFileModel

Settings

Member Visibility

On This Page

Properties