@squidcloud/client
    Preparing search index...

    Interface FileContextRequest

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

    interface FileContextRequest {
        contextId: string;
        extractImages?: boolean;
        extractionModel?:
            | "o1"
            | "o1-mini"
            | "o3"
            | "o3-mini"
            | "o4-mini"
            | "gpt-4o"
            | "gpt-4o-mini"
            | "gpt-4.1-nano"
            | "gpt-4.1-mini"
            | "gpt-4.1"
            | "gemini-1.5-pro"
            | "gemini-2.0-flash"
            | "claude-3-5-haiku-latest"
            | "claude-3-5-sonnet-latest"
            | "claude-3-7-sonnet-latest";
        imageMinSizePixels?: number;
        metadata?: AiContextMetadata;
        options?: AiContextFileOptions;
        type: "file";
    }

    Hierarchy

    • BaseContextRequest
      • FileContextRequest
    Index

    Properties

    contextId extractImages? extractionModel? imageMinSizePixels? metadata? options? type

    Properties

    contextId: string
    extractImages?: boolean

    Whether to extract images from the file; defaults to false.

    extractionModel?:
        | "o1"
        | "o1-mini"
        | "o3"
        | "o3-mini"
        | "o4-mini"
        | "gpt-4o"
        | "gpt-4o-mini"
        | "gpt-4.1-nano"
        | "gpt-4.1-mini"
        | "gpt-4.1"
        | "gemini-1.5-pro"
        | "gemini-2.0-flash"
        | "claude-3-5-haiku-latest"
        | "claude-3-5-sonnet-latest"
        | "claude-3-7-sonnet-latest"

    The AI model to use for extraction, if specified.

    imageMinSizePixels?: number

    The minimum size for extracted images, if applicable.

    metadata?: AiContextMetadata
    options?: AiContextFileOptions

    General options for how to process the file.

    type: "file"

    Specifies the context type as 'file'.

    Settings

    Member Visibility

    On This Page

    Properties