@squidcloud/client
    Preparing search index...

    Interface AiConnectedKnowledgeBaseMetadata

    Metadata for a connected AI Knowledge Base callable by the current agent.

    interface AiConnectedKnowledgeBaseMetadata {
        description: string;
        enableMetadataInspection?: boolean;
        includeMetadata?: boolean;
        knowledgeBaseId: string;
    }
    Index

    Properties

    description enableMetadataInspection? includeMetadata? knowledgeBaseId

    Properties

    description: string

    A description of when to use this AiKnowledgeBase

    enableMetadataInspection?: boolean

    When true, the chat agent gets a tool to enumerate/search this KB's metadata field values on demand. Off by default. (Chat surface only for now; MCP/CLI is not wired.)

    includeMetadata?: boolean

    Whether to include document metadata when providing KB search results to the agent. Defaults to false.

    knowledgeBaseId: string

    The ID of the connected AI KnowledgeBase

    Settings

    Member Visibility

    On This Page

    Properties