Interface: AgentOSFinalResponseChunk

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:125

Extends

• AgentOSResponseChunk

Properties

activePersonaDetails?

optional activePersonaDetails: Partial<IPersonaDefinition>

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:141

---

audioOutput?

optional audioOutput: AudioOutputConfig

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:135

---

error?

optional error: object

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:139

code

code: string

details?

optional details: any

message

message: string

---

finalResponseText

finalResponseText: string | null

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:127

---

finalResponseTextPlain?

optional finalResponseTextPlain: string | null

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:132

Plain-text rendering of finalResponseText intended for voice/TTS and logs. When omitted, clients can derive it by stripping Markdown.

---

finalToolCalls?

optional finalToolCalls: ToolCallRequest[]

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:133

---

finalUiCommands?

optional finalUiCommands: UICommand[]

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:134

---

gmiInstanceId

gmiInstanceId: string

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:46

Inherited from

AgentOSResponseChunk.gmiInstanceId

---

imageOutput?

optional imageOutput: ImageOutputConfig

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:136

---

isFinal

isFinal: boolean

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:48

Inherited from

AgentOSResponseChunk.isFinal

---

metadata?

optional metadata: Record<string, any>

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:50

Inherited from

AgentOSResponseChunk.metadata

---

personaId

personaId: string

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:47

Inherited from

AgentOSResponseChunk.personaId

---

ragSources?

optional ragSources: RagRetrievedChunk[]

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:149

RAG source chunks that were used to generate this response. Populated by the GMI when RAG retrieval was performed. Used by grounding guardrails to verify response faithfulness. Undefined when no RAG retrieval was performed.

---

reasoningTrace?

optional reasoningTrace: ReasoningTraceEntry[]

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:138

---

streamId

streamId: string

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:45

Inherited from

AgentOSResponseChunk.streamId

---

structured?

optional structured: StructuredReplyOutput

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:152

On a structured turn (ProcessingOptions.structuredReply): the parsed value and how it was checked.

---

timestamp

timestamp: string

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:49

Inherited from

AgentOSResponseChunk.timestamp

---

type

type: FINAL_RESPONSE

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:126

Overrides

AgentOSResponseChunk.type

---

updatedConversationContext?

optional updatedConversationContext: ConversationContext

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:140

---

usage?

optional usage: CostAggregator

Defined in: packages/agentos/src/api/types/AgentOSResponse.ts:137