Interface ChatResponse<D, M>

Response sent back to the client after processing a chat request.

interface ChatResponse<D, M> {
    data?: D;
    intermediateSteps?: IntermediateStep[];
    message?: string;
    metadata?: M;
    toolCalls?: ToolCall[];
}

Type Parameters

D = JSONAbleObject
M = ChatResponseMetadata

Hierarchy

Pick<AgentResponse<D>, "message" | "data" | "toolCalls" | "intermediateSteps">
- ChatResponse

Index

Properties

data? intermediateSteps? message? metadata? toolCalls?

Properties

`Optional` data

data?: D

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?: M

`Optional` toolCalls

toolCalls?: ToolCall[]

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