Interface FileBatchListFilesParams

interface FileBatchListFilesParams {
    after?: string;
    before?: string;
    filter?:
        | "in_progress"
        | "completed"
        | "failed"
        | "cancelled";
    limit?: number;
    order?: "asc" | "desc";
    vector_store_id: string;
}

Hierarchy (view full)

Properties

after? before? filter? limit? order? vector_store_id

Properties

Optionalafter

after?: string

Optionalbefore

before?: string

Query param: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Optionalfilter

filter?:
    | "in_progress"
    | "completed"
    | "failed"
    | "cancelled"

Query param: Filter by file status. One of in_progress, completed, failed, cancelled.

Optionallimit

limit?: number

Optionalorder

order?: "asc" | "desc"

Query param: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

vector_store_id

vector_store_id: string

Path param: The ID of the vector store that the files belong to.

Settings

Member Visibility

On This Page

Properties