Interface AgentOSFinalResponseChunk

interface AgentOSFinalResponseChunk {
    streamId: string;
    gmiInstanceId: string;
    personaId: string;
    isFinal: boolean;
    timestamp: string;
    metadata?: Record<string, any>;
    type: FINAL_RESPONSE;
    finalResponseText: null | string;
    finalToolCalls?: ToolCallRequest[];
    finalUiCommands?: UICommand[];
    audioOutput?: AudioOutputConfig;
    imageOutput?: ImageOutputConfig;
    usage?: CostAggregator;
    reasoningTrace?: ReasoningTraceEntry[];
    error?: {
        code: string;
        message: string;
        details?: any;
    };
    updatedConversationContext?: ConversationContext;
    activePersonaDetails?: Partial<IPersonaDefinition>;
}

Hierarchy (view full)

AgentOSResponseChunk
- AgentOSFinalResponseChunk

Index

Properties

streamId gmiInstanceId personaId isFinal timestamp metadata? type finalResponseText finalToolCalls? finalUiCommands? audioOutput? imageOutput? usage? reasoningTrace? error? updatedConversationContext? activePersonaDetails?

Properties

streamId

streamId: string

gmiInstanceId

gmiInstanceId: string

personaId

personaId: string

isFinal

isFinal: boolean

timestamp

timestamp: string

`Optional` metadata

metadata?: Record<string, any>

type

type: FINAL_RESPONSE

finalResponseText

finalResponseText: null | string

`Optional` finalToolCalls

finalToolCalls?: ToolCallRequest[]

`Optional` finalUiCommands

finalUiCommands?: UICommand[]

`Optional` audioOutput

audioOutput?: AudioOutputConfig

`Optional` imageOutput

imageOutput?: ImageOutputConfig

`Optional` usage

usage?: CostAggregator

`Optional` reasoningTrace

reasoningTrace?: ReasoningTraceEntry[]

`Optional` error

error?: {
    code: string;
    message: string;
    details?: any;
}

Type declaration

code: string
message: string
Optional details?: any

`Optional` updatedConversationContext

updatedConversationContext?: ConversationContext

`Optional` activePersonaDetails

activePersonaDetails?: Partial<IPersonaDefinition>