Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface AssistantFileModel

    The response format for a successful file upload request.

    AssistantFileModel

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

    The timestamp when the file was uploaded, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

    AssistantFileModel

    id: string

    The unique identifier for the uploaded file. This may be a user-provided identifier or a system-generated ID.

    AssistantFileModel

    metadata?: object | null

    Optional metadata associated with the file. This metadata can be used to filter files when listing them or to restrict search results when querying the assistant.

    AssistantFileModel

    multimodal?: boolean

    Indicates whether the file was processed as multimodal.

    AssistantFileModel

    name: string

    The name of the uploaded file.

    AssistantFileModel

    signedUrl?: string | null

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

    AssistantFileModel

    size?: number

    The size of the uploaded file, in bytes.

    AssistantFileModel

    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.

    AssistantFileModel

    updatedOn?: Date

    The timestamp of the most recent update to the file, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

    AssistantFileModel

    Settings
    Member Visibility

    On This Page
    Properties