@squidcloud/client
    Preparing search index...

    Interface QueryKnowledgeBaseGraphResponse

    Response structure for a graph query. op echoes the request; exactly the fields that op produces are set (e.g. matches for resolve, tree for subtree).

    interface QueryKnowledgeBaseGraphResponse {
        concepts?: KnowledgeBaseGraphQueryConcepts;
        documents?: KnowledgeBaseGraphQueryDoc[];
        graph?: ExploreKnowledgeBaseGraphResponse;
        matches?: KnowledgeBaseGraphQueryMatch[];
        node?: KnowledgeBaseGraphQueryMatch;
        op: KnowledgeBaseGraphQueryOp;
        overview?: string;
        path?: string[];
        pathBetween?: KnowledgeBaseGraphQueryPath;
        related?: { docCount?: number; name: string; relation: string }[];
        summaries?: KnowledgeBaseGraphQueryGlobalSummary[];
        totalDocs?: number;
        tree?: KnowledgeBaseGraphQuerySubtreeNode;
    }
    Index

    Properties

    concepts? documents? graph? matches? node? op overview? path? pathBetween? related? summaries? totalDocs? tree?

    Properties

    concepts?: KnowledgeBaseGraphQueryConcepts

    conceptsOf: the document's concept memberships.

    documents?: KnowledgeBaseGraphQueryDoc[]

    docsUnder: documents in the resolved node's closure (capped by limit).

    graph?: ExploreKnowledgeBaseGraphResponse

    neighborhood: the entity subgraph around the resolved entity.

    matches?: KnowledgeBaseGraphQueryMatch[]

    resolve: matching nodes across all kinds, best first.

    node?: KnowledgeBaseGraphQueryMatch

    describe: the resolved node.

    op: KnowledgeBaseGraphQueryOp

    The operation that ran.

    overview?: string

    overview: the rendered knowledge-graph map (names + counts).

    path?: string[]

    describe: ancestor names root-first (facet path / topic hierarchy), when the node has one.

    pathBetween?: KnowledgeBaseGraphQueryPath

    pathBetween: the two-tier path answer; absent when the refs are entirely unconnected.

    related?: { docCount?: number; name: string; relation: string }[]

    describe: immediate related nodes — children with counts, a document's concepts, an entity's edges.

    summaries?: KnowledgeBaseGraphQueryGlobalSummary[]

    globalSummary: the KB's topic summaries ranked against the query, most relevant first.

    totalDocs?: number

    docsUnder: the full closure size (compare with documents.length for truncation).

    tree?: KnowledgeBaseGraphQuerySubtreeNode

    subtree: the resolved node's subtree with doc counts.

    Settings

    Member Visibility

    On This Page

    Properties