Skip to main content

Interface: GMIOutput

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:545

Export

Represents the complete, non-chunked output of a GMI turn or significant processing step. This is typically the TReturn type of an AsyncGenerator yielding GMIOutputChunk.

Interface​

GMIOutput

Properties​

audioOutput?​

optional audioOutput: AudioOutputConfig

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:561


error?​

optional error: object

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:565

code​

code: string

details?​

optional details: any

message​

message: string


imageOutput?​

optional imageOutput: ImageOutputConfig

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:562


isFinal​

isFinal: boolean

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:551

false with toolCalls stops the turn for the host: the runtime saves the pending request, and the host runs those calls and passes their results back. Any other output, final or naming no calls, ends the turn, or the tool-result continuation, with FINAL_RESPONSE.


ragSources?​

optional ragSources: RagRetrievedChunk[]

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:575

Retrieved RAG chunks for the turn, populated when the GMI performed a RAG retrieval; a tool continuation retrieves nothing of its own and carries the chunks of the user turn it continues, when the same GMI ran that turn (a pause stores no retrieved chunk). Threaded into the FINAL_RESPONSE chunk so client code and the output-guardrail layer (Grounding Guard, Citation Verifier) can verify generated claims against the same sources the model saw.


reasoningTrace?​

optional reasoningTrace: ReasoningTraceEntry[]

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:564


responseText?​

optional responseText: string | null

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:552


structuredOutput?​

optional structuredOutput: StructuredReplyOutput

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:577

On a structured turn: the parsed value and its check (see api/runtime/structuredReply).


toolCalls?​

optional toolCalls: ToolCallRequest[]

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:559

On an output with isFinal: false, the calls the host runs: the runtime reads every one of them as a call that waits on the host, since a call carries no mode of its own, so a GMI leaves out of such an output the calls it ran itself. On a final output, the calls of the GMI's own tool rounds, each one run or refused by the tool-call gate: FINAL_RESPONSE.finalToolCalls lists them, and nothing waits on them.


uiCommands?​

optional uiCommands: UICommand[]

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:560


usage?​

optional usage: CostAggregator

Defined in: packages/agentos/src/cognition/substrate/IGMI.ts:563