@squidcloud/client
    Preparing search index...

    Interface QueryKnowledgeBaseGraphRequest

    Request structure for querying a knowledge base's graph (documents, entities, topics, facets) through the closed op set. ref accepts a facet nodeId (facet_… — exact; the only persistable concept handles), a topic id from KnowledgeBaseGraphTopic.id or an entity id from KnowledgeBaseGraphNode.id (both exact, both churn on rebuild) or a name, resolved server-side (exact → alias → similarity). An unresolvable ref fails with CONCEPT_NOT_FOUND plus the nearest matching names.

    interface QueryKnowledgeBaseGraphRequest {
        contextId?: string;
        contextMetadataFilter?: AiContextMetadataFilter;
        depth?: number;
        hops?: number;
        knowledgeBaseId: string;
        limit?: number;
        op: KnowledgeBaseGraphQueryOp;
        query?: string;
        recursive?: boolean;
        ref?: string;
        refB?: string;
    }
    Index
    contextId? contextMetadataFilter? depth? hops? knowledgeBaseId limit? op query? recursive? ref? refB?
    contextId?: string

    The document's contextId for conceptsOf.

    contextMetadataFilter?: AiContextMetadataFilter

    docsUnder and relationship: keeps only the documents whose context matches the filter. Filters on context-record metadata only, not on per-chunk keys.

    depth?: number

    subtree: maximum depth below the resolved node. Default (and cap) 3.

    hops?: number

    neighborhood: expansion hops from the resolved entity. Default 1, max 2.

    knowledgeBaseId: string

    The id of the AiKnowledgeBase.

    limit?: number

    docsUnder and relationship: maximum documents returned. Default 25, max 100 (totalDocs always reports the full count).

    op: KnowledgeBaseGraphQueryOp

    The operation to run.

    query?: string

    The free-text question for globalSummary (ranks the KB's topic summaries against it).

    recursive?: boolean

    docsUnder: when true (default), include documents under the whole subtree, not just the node itself.

    ref?: string

    Node ref (name, facet nodeId, topic id or entity id). Required by resolve/describe/subtree/docsUnder/ neighborhood/pathBetween/relationship.

    refB?: string

    Second node ref for pathBetween, and the target entity for relationship.

    Settings
    Member Visibility

    On This Page
    Properties