trustgraph/specs/api/components/schemas/rag/DocumentRagResponse.yaml

type: object
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 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 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:
    type: object
    description: Error details if request failed
    properties:
      message:
        type: string
        description: Error message
        example: Failed to retrieve documents
      type:
        type: string
        description: Error type
        example: RETRIEVAL_ERROR