trustgraph/docs/tech-specs/agent-explainability.md
cybermaggedon ddd4bd7790
Deliver explainability triples inline in retrieval response stream (#763)
Provenance triples are now included directly in explain messages from
GraphRAG, DocumentRAG, and Agent services, eliminating the need for
follow-up knowledge graph queries to retrieve explainability details.

Each explain message in the response stream now carries:
- explain_id: root URI for this provenance step (unchanged)
- explain_graph: named graph where triples are stored (unchanged)
- explain_triples: the actual provenance triples for this step (new)

Changes across the stack:
- Schema: added explain_triples field to GraphRagResponse,
  DocumentRagResponse, and AgentResponse
- Services: all explain message call sites pass triples through
  (graph_rag, document_rag, agent react, agent orchestrator)
- Translators: encode explain_triples via TripleTranslator for
  gateway wire format
- Python SDK: ProvenanceEvent now includes parsed ExplainEntity
  and raw triples; expanded event_type detection
- CLI: invoke_graph_rag, invoke_agent, invoke_document_rag use
  inline entity when available, fall back to graph query
- Tech specs updated

Additional explainability test
2026-04-07 12:19:05 +01:00

9.8 KiB

Agent Explainability: Provenance Recording

Overview

Add provenance recording to the React agent loop so agent sessions can be traced and debugged using the same explainability infrastructure as GraphRAG.

Design Decisions:

  • Write to urn:graph:retrieval (generic explainability graph)
  • Linear dependency chain for now (analysis N → wasDerivedFrom → analysis N-1)
  • Tools are opaque black boxes (record input/output only)
  • DAG support deferred to future iteration

Entity Types

Both GraphRAG and Agent use PROV-O as the base ontology with TrustGraph-specific subtypes:

GraphRAG Types

Entity PROV-O Type TG Types Description
Question prov:Activity tg:Question, tg:GraphRagQuestion The user's query
Exploration prov:Entity tg:Exploration Edges retrieved from knowledge graph
Focus prov:Entity tg:Focus Selected edges with reasoning
Synthesis prov:Entity tg:Synthesis Final answer

Agent Types

Entity PROV-O Type TG Types Description
Question prov:Activity tg:Question, tg:AgentQuestion The user's query
Analysis prov:Entity tg:Analysis Each think/act/observe cycle
Conclusion prov:Entity tg:Conclusion Final answer

Document RAG Types

Entity PROV-O Type TG Types Description
Question prov:Activity tg:Question, tg:DocRagQuestion The user's query
Exploration prov:Entity tg:Exploration Chunks retrieved from document store
Synthesis prov:Entity tg:Synthesis Final answer

Note: Document RAG uses a subset of GraphRAG's types (no Focus step since there's no edge selection/reasoning phase).

Question Subtypes

All Question entities share tg:Question as a base type but have a specific subtype to identify the retrieval mechanism:

Subtype URI Pattern Mechanism
tg:GraphRagQuestion urn:trustgraph:question:{uuid} Knowledge graph RAG
tg:DocRagQuestion urn:trustgraph:docrag:{uuid} Document/chunk RAG
tg:AgentQuestion urn:trustgraph:agent:{uuid} ReAct agent

This allows querying all questions via tg:Question while filtering by specific mechanism via the subtype.

Provenance Model

Question (urn:trustgraph:agent:{uuid})
    │
    │  tg:query = "User's question"
    │  prov:startedAtTime = timestamp
    │  rdf:type = prov:Activity, tg:Question
    │
    ↓ prov:wasDerivedFrom
    │
Analysis1 (urn:trustgraph:agent:{uuid}/i1)
    │
    │  tg:thought = "I need to query the knowledge base..."
    │  tg:action = "knowledge-query"
    │  tg:arguments = {"question": "..."}
    │  tg:observation = "Result from tool..."
    │  rdf:type = prov:Entity, tg:Analysis
    │
    ↓ prov:wasDerivedFrom
    │
Analysis2 (urn:trustgraph:agent:{uuid}/i2)
    │  ...
    ↓ prov:wasDerivedFrom
    │
Conclusion (urn:trustgraph:agent:{uuid}/final)
    │
    │  tg:answer = "The final response..."
    │  rdf:type = prov:Entity, tg:Conclusion

Document RAG Provenance Model

Question (urn:trustgraph:docrag:{uuid})
    │
    │  tg:query = "User's question"
    │  prov:startedAtTime = timestamp
    │  rdf:type = prov:Activity, tg:Question
    │
    ↓ prov:wasGeneratedBy
    │
Exploration (urn:trustgraph:docrag:{uuid}/exploration)
    │
    │  tg:chunkCount = 5
    │  tg:selectedChunk = "chunk-id-1"
    │  tg:selectedChunk = "chunk-id-2"
    │  ...
    │  rdf:type = prov:Entity, tg:Exploration
    │
    ↓ prov:wasDerivedFrom
    │
Synthesis (urn:trustgraph:docrag:{uuid}/synthesis)
    │
    │  tg:content = "The synthesized answer..."
    │  rdf:type = prov:Entity, tg:Synthesis

Changes Required

1. Schema Changes

File: trustgraph-base/trustgraph/schema/services/agent.py

Add session_id and collection fields to AgentRequest:

@dataclass
class AgentRequest:
    question: str = ""
    state: str = ""
    group: list[str] | None = None
    history: list[AgentStep] = field(default_factory=list)
    user: str = ""
    collection: str = "default"  # NEW: Collection for provenance traces
    streaming: bool = False
    session_id: str = ""         # NEW: For provenance tracking across iterations

File: trustgraph-base/trustgraph/messaging/translators/agent.py

Update translator to handle session_id and collection in both to_pulsar() and from_pulsar().

2. Add Explainability Producer to Agent Service

File: trustgraph-flow/trustgraph/agent/react/service.py

Register an "explainability" producer (same pattern as GraphRAG):

from ... base import ProducerSpec
from ... schema import Triples

# In __init__:
self.register_specification(
    ProducerSpec(
        name = "explainability",
        schema = Triples,
    )
)

3. Provenance Triple Generation

File: trustgraph-base/trustgraph/provenance/agent.py

Create helper functions (similar to GraphRAG's question_triples, exploration_triples, etc.):

def agent_session_triples(session_uri, query, timestamp):
    """Generate triples for agent Question."""
    return [
        Triple(s=session_uri, p=RDF_TYPE, o=PROV_ACTIVITY),
        Triple(s=session_uri, p=RDF_TYPE, o=TG_QUESTION),
        Triple(s=session_uri, p=TG_QUERY, o=query),
        Triple(s=session_uri, p=PROV_STARTED_AT_TIME, o=timestamp),
    ]

def agent_iteration_triples(iteration_uri, parent_uri, thought, action, arguments, observation):
    """Generate triples for one Analysis step."""
    return [
        Triple(s=iteration_uri, p=RDF_TYPE, o=PROV_ENTITY),
        Triple(s=iteration_uri, p=RDF_TYPE, o=TG_ANALYSIS),
        Triple(s=iteration_uri, p=TG_THOUGHT, o=thought),
        Triple(s=iteration_uri, p=TG_ACTION, o=action),
        Triple(s=iteration_uri, p=TG_ARGUMENTS, o=json.dumps(arguments)),
        Triple(s=iteration_uri, p=TG_OBSERVATION, o=observation),
        Triple(s=iteration_uri, p=PROV_WAS_DERIVED_FROM, o=parent_uri),
    ]

def agent_final_triples(final_uri, parent_uri, answer):
    """Generate triples for Conclusion."""
    return [
        Triple(s=final_uri, p=RDF_TYPE, o=PROV_ENTITY),
        Triple(s=final_uri, p=RDF_TYPE, o=TG_CONCLUSION),
        Triple(s=final_uri, p=TG_ANSWER, o=answer),
        Triple(s=final_uri, p=PROV_WAS_DERIVED_FROM, o=parent_uri),
    ]

4. Type Definitions

File: trustgraph-base/trustgraph/provenance/namespaces.py

Add explainability entity types and agent predicates:

# Explainability entity types (used by both GraphRAG and Agent)
TG_QUESTION = TG + "Question"
TG_EXPLORATION = TG + "Exploration"
TG_FOCUS = TG + "Focus"
TG_SYNTHESIS = TG + "Synthesis"
TG_ANALYSIS = TG + "Analysis"
TG_CONCLUSION = TG + "Conclusion"

# Agent predicates
TG_THOUGHT = TG + "thought"
TG_ACTION = TG + "action"
TG_ARGUMENTS = TG + "arguments"
TG_OBSERVATION = TG + "observation"
TG_ANSWER = TG + "answer"

Files Modified

File Change
trustgraph-base/trustgraph/schema/services/agent.py Add session_id and collection to AgentRequest
trustgraph-base/trustgraph/messaging/translators/agent.py Update translator for new fields
trustgraph-base/trustgraph/provenance/namespaces.py Add entity types, agent predicates, and Document RAG predicates
trustgraph-base/trustgraph/provenance/triples.py Add TG types to GraphRAG triple builders, add Document RAG triple builders
trustgraph-base/trustgraph/provenance/uris.py Add Document RAG URI generators
trustgraph-base/trustgraph/provenance/__init__.py Export new types, predicates, and Document RAG functions
trustgraph-base/trustgraph/schema/services/retrieval.py Add explain_id, explain_graph, and explain_triples to DocumentRagResponse
trustgraph-base/trustgraph/messaging/translators/retrieval.py Update DocumentRagResponseTranslator for explainability fields including inline triples
trustgraph-flow/trustgraph/agent/react/service.py Add explainability producer + recording logic
trustgraph-flow/trustgraph/retrieval/document_rag/document_rag.py Add explainability callback and emit provenance triples
trustgraph-flow/trustgraph/retrieval/document_rag/rag.py Add explainability producer and wire up callback
trustgraph-cli/trustgraph/cli/show_explain_trace.py Handle agent trace types
trustgraph-cli/trustgraph/cli/list_explain_traces.py List agent sessions alongside GraphRAG

Files Created

File Purpose
trustgraph-base/trustgraph/provenance/agent.py Agent-specific triple generators

CLI Updates

Detection: Both GraphRAG and Agent Questions have tg:Question type. Distinguished by:

  1. URI pattern: urn:trustgraph:agent: vs urn:trustgraph:question:
  2. Derived entities: tg:Analysis (agent) vs tg:Exploration (GraphRAG)

list_explain_traces.py:

  • Shows Type column (Agent vs GraphRAG)

show_explain_trace.py:

  • Auto-detects trace type
  • Agent rendering shows: Question → Analysis step(s) → Conclusion

Backwards Compatibility

  • session_id defaults to "" - old requests work, just won't have provenance
  • collection defaults to "default" - reasonable fallback
  • CLI gracefully handles both trace types

Verification

# Run an agent query
tg-invoke-agent -q "What is the capital of France?"

# List traces (should show agent sessions with Type column)
tg-list-explain-traces -U trustgraph -C default

# Show agent trace
tg-show-explain-trace "urn:trustgraph:agent:xxx"

Future Work (Not This PR)

  • DAG dependencies (when analysis N uses results from multiple prior analyses)
  • Tool-specific provenance linking (KnowledgeQuery → its GraphRAG trace)
  • Streaming provenance emission (emit as we go, not batch at end)