Graph Inspection and Querying

Inspect graph entities, facts, traces, and retrieval behavior while tuning graph-weighted search.

Use graph.explore for Debugging

graph.explore() is an inspection API. Use it to inspect anchors, candidate entities, facts, and trace details without building a full prompt-oriented search response.

graph-explore.ts

const trace = await typegraph.graph.explore('Which customers are blocked by SSO?', {
  context: { groupId: GroupId('sales') },
  limit: 10,
})

console.log(trace.anchors)
console.log(trace.entities)
console.log(trace.facts)
console.log(trace.graphTrace)

Use search for Retrieval

Production retrieval should usually go through typegraph.search(). Include graph-backed resources and set weights.graph to control graph influence.

graph-search.ts

const response = await typegraph.search('Which customers are blocked by SSO?', {
  resources: ['events', 'documents', 'entities', 'facts'],
  weights: { semantic: 0.7, bm25: 0.4, graph: 1, recency: 0.6 },
  context: { groupId: GroupId('sales') },
  explain: true,
})

console.log(response.hits)
console.log(response.explanation?.graphTrace)

Inspect Entities and Edges

Use graph read APIs when you need direct graph objects for dashboards, debugging, curation, or admin tools.

entities-and-edges.ts

const entities = await typegraph.graph.searchEntities('Acme', {
  context: { groupId: GroupId('sales') },
  limit: 10,
})

const acme = await typegraph.graph.getEntity('org_acme', {
  context: { groupId: GroupId('sales') },
})

const edges = await typegraph.graph.getEdges('org_acme', {
  context: { groupId: GroupId('sales') },
})

Fetch a Subgraph

Subgraph reads are lower-level topology tools. They are useful for visualization and auditing, but they are not a replacement for ranked search.

subgraph.ts

const subgraph = await typegraph.graph.getSubgraph({
  entityIds: ['org_acme'],
  depth: 2,
  limit: 50,
  context: { groupId: GroupId('sales') },
})

Back to All Guides

const trace = await typegraph.graph.explore('Which customers are blocked by SSO?', { context: { groupId: GroupId('sales') }, limit: 10, }) console.log(trace.anchors) console.log(trace.entities) console.log(trace.facts) console.log(trace.graphTrace)

const response = await typegraph.search('Which customers are blocked by SSO?', { resources: ['events', 'documents', 'entities', 'facts'], weights: { semantic: 0.7, bm25: 0.4, graph: 1, recency: 0.6 }, context: { groupId: GroupId('sales') }, explain: true, }) console.log(response.hits) console.log(response.explanation?.graphTrace)

const entities = await typegraph.graph.searchEntities('Acme', { context: { groupId: GroupId('sales') }, limit: 10, }) const acme = await typegraph.graph.getEntity('org_acme', { context: { groupId: GroupId('sales') }, }) const edges = await typegraph.graph.getEdges('org_acme', { context: { groupId: GroupId('sales') }, })