@squidcloud/client
    Preparing search index...

    Interface AiKnowledgeBaseFileContextRequest

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

    interface AiKnowledgeBaseFileContextRequest {
        contextId: string;
        discardOriginalFile?: boolean;
        extractImages?: boolean;
        imageExtractionModel?: string;
        imageMinSizePixels?: number;
        metadata?: AiContextMetadata;
        options?: AiKnowledgeBaseContextFileOptions;
        preferredExtractionMethod?: DocumentExtractionMethod;
        type: "file";
    }

    Hierarchy

    • BaseAiKnowledgeBaseContextRequest
      • AiKnowledgeBaseFileContextRequest
    Index

    Properties

    contextId discardOriginalFile? extractImages? imageExtractionModel? imageMinSizePixels? metadata? options? preferredExtractionMethod? type

    Properties

    contextId: string
    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; defaults to false.

    imageExtractionModel?: string

    The AI model to use for extraction, if specified.

    imageMinSizePixels?: number

    The minimum size for extracted images, if applicable.

    metadata?: AiContextMetadata
    options?: AiKnowledgeBaseContextFileOptions

    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