@squidcloud/client
    Preparing search index...

    Interface FileContextRequest

    Request structure for adding file-based context to an AI agent.

    interface FileContextRequest {
        contextId: string;
        discardOriginalFile?: boolean;
        extractImages?: boolean;
        extractionModel?: AiChatModelSelection;
        imageMinSizePixels?: number;
        metadata?: AiContextMetadata;
        options?: AiContextFileOptions;
        preferredExtractionMethod?: DocumentExtractionMethod;
        type: "file";
    }

    Hierarchy (View Summary)

    Index
    contextId discardOriginalFile? extractImages? extractionModel? imageMinSizePixels? metadata? options? preferredExtractionMethod? type
    contextId: string

    The unique identifier of the context item.

    discardOriginalFile?: boolean

    Whether Squid keeps or discards the original file.

    Keeping the original file allows reprocessing and the ability for the user to download it later.

    Defaults to false.

    extractImages?: boolean

    Whether to extract images from the file, describe them with a vision model, and index those descriptions alongside the text. Defaults to true — a document's charts, diagrams and scanned pages carry content the text layer does not. Note that the text context request has no such option: inline images in a text payload are extracted only for a knowledge-base text context, and default to OFF there.

    extractionModel?: AiChatModelSelection

    The AI model to use for extraction, if specified.

    imageMinSizePixels?: number

    The minimum size for extracted images, if applicable.

    metadata?: AiContextMetadata

    Optional metadata associated with the context item.

    options?: AiContextFileOptions

    General options for how to process the file.

    preferredExtractionMethod?: DocumentExtractionMethod

    The preferred method for extracting data from the document.

    type: "file"

    Specifies the context type as 'file'.

    Settings
    Member Visibility

    On This Page
    Properties