@squidcloud/client
    Preparing search index...

    Interface BaseAiKnowledgeBaseContextRequest

    Base fields shared by all knowledge base context requests.

    interface BaseAiKnowledgeBaseContextRequest {
        contextId?: string;
        metadata?: AiContextMetadata;
        scopes?: string[];
        type: AiKnowledgeBaseContextType;
    }

    Hierarchy (View Summary)

    Index
    contextId?: string

    The unique identifier of the context item.

    Optional metadata associated with the context item.

    scopes?: string[]

    Access scopes granting read access to this context, stamped onto every chunk it produces. Only meaningful on a knowledge base with accessControl.mode: 'enforced', where a caller retrieves the context only if they hold at least one of these scopes.

    Supplied here rather than through a follow-up call so a restricted context is never briefly readable by everyone between being indexed and being scoped. Omitted on a re-ingest keeps whatever scopes the context already had; an empty array makes it visible to every caller.

    Scopes are opaque strings the resolver and the ingest side agree on. The __ prefix is reserved.

    The type of the context content.