@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;
        name: string;
        required: boolean;
    }
    Index

    Properties

    dataType description? name required

    Properties

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

    The field data type - used for filtering. For array, only array of strings is supported.

    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.

    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