Updated API specs

This commit is contained in:
Cyber MacGeddon 2026-03-17 13:16:47 +00:00
parent ab002e6edb
commit f6e588d408
13 changed files with 282 additions and 56 deletions

View file

@ -1,13 +1,31 @@
type: object
description: Document RAG response
description: Document RAG response message
properties:
message_type:
type: string
description: Type of message - "chunk" for LLM response chunks, "explain" for explainability events
enum: [chunk, explain]
example: chunk
response:
type: string
description: Generated response based on retrieved documents
example: The research papers found three key findings...
description: Generated response text (for chunk messages)
example: Based on the policy documents, customers can return items within 30 days...
explain_id:
type: string
description: Explainability node URI (for explain messages)
example: urn:trustgraph:question:abc123
explain_graph:
type: string
description: Named graph containing the explainability data
example: urn:graph:retrieval
end-of-stream:
type: boolean
description: Indicates streaming is complete (streaming mode)
description: Indicates LLM response stream is complete
default: false
example: true
end_of_session:
type: boolean
description: Indicates entire session is complete (all messages sent)
default: false
example: true
error:

View file

@ -3,17 +3,21 @@ description: Graph RAG response message
properties:
message_type:
type: string
description: Type of message - "chunk" for LLM response chunks, "provenance" for provenance announcements
enum: [chunk, provenance]
description: Type of message - "chunk" for LLM response chunks, "explain" for explainability events
enum: [chunk, explain]
example: chunk
response:
type: string
description: Generated response text (for chunk messages)
example: Quantum physics and computer science intersect in quantum computing...
provenance_id:
explain_id:
type: string
description: Provenance node URI (for provenance messages)
example: urn:trustgraph:session:abc123
description: Explainability node URI (for explain messages)
example: urn:trustgraph:question:abc123
explain_graph:
type: string
description: Named graph containing the explainability data
example: urn:graph:retrieval
end_of_stream:
type: boolean
description: Indicates LLM response stream is complete