@squidcloud/client
    Preparing search index...

    Interface AiKnowledgeBaseMetadataField

    Represents a field in an AI knowledge base metadata.

    interface AiKnowledgeBaseMetadataField {
        dataType: "string" | "number" | "boolean" | "date" | "array";
        description?: string;
        descriptionGeneratedByAi?: boolean;
        name: string;
        required: boolean;
    }
    Index

    Properties

    dataType description? descriptionGeneratedByAi? name required

    Properties

    dataType: "string" | "number" | "boolean" | "date" | "array"

    The field data type - used for validation and filtering. date values are normalized to integer epoch milliseconds at write time so range filters ($gt/$lt) work across vector store backends. array is not yet supported and is rejected at knowledge-base upsert time.

    description?: string

    In case that the field is required and not provided when uploaded to the knowledge base, this description will be used for extracting the value from the document. Also, it will be used for auto filtering when a prompt is sent to an AI agent.

    descriptionGeneratedByAi?: boolean

    True when description was AI-generated (via generateMetadataFieldDescriptions). Undefined or false means the description was authored by a human or has not been generated yet; it clears back to false once a human edits the description.

    name: string

    The name of field.

    required: boolean

    Indicates if the field is required for knowledge base entries.

    Settings

    Member Visibility

    On This Page

    Properties