mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 08:26:21 +02:00
Update API specs for 2.1 (#699)
* Updating API specs for 2.1 * Updated API and SDK docs
This commit is contained in:
parent
c387670944
commit
664d1d0384
19 changed files with 4280 additions and 1949 deletions
|
|
@ -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:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue