Interface AgentResponse<Data>

interface AgentResponse<Data> {
    conversationId: string;
    data?: Data;
    intermediateSteps?: IntermediateStep[];
    message?: string;
    metadata?: AgentResponseMetadata;
    requestId: string;
    toolCalls?: ToolCall[];
}

Type Parameters

  • Data = Record<string, any>

Hierarchy (view full)

Properties

conversationId data? intermediateSteps? message? metadata? requestId toolCalls?

Properties

conversationId

conversationId: string

ID of the conversation associated with the response.

Optional data

data?: Data

Additional data that can be sent back to the client.

Optional intermediateSteps

intermediateSteps?: IntermediateStep[]

Intermediate steps that the agent has taken. This can be used for debugging or logging purposes, or to provide additional context to the client.

Optional message

message?: string

Message to be sent back to the client.

Optional metadata

metadata?: AgentResponseMetadata

Additional metadata that you want to log with the response. Often used for tagging metrics data.

requestId

requestId: string

Unique ID associated with the request.

Optional toolCalls

toolCalls?: ToolCall[]

Tool calls that needs to be executed on the client-side.

Settings

Member Visibility

Theme

On This Page

conversationIddataintermediateStepsmessagemetadatarequestIdtoolCalls