Interface AgentRequestContent<Payload>

interface AgentRequestContent<Payload> {
    payload?: Payload;
    toolCallResults?: ToolCallResult[];
    userMessage?: string;
}

Type Parameters

  • Payload = Record<string, any>

Hierarchy

  • AgentRequestContent

    Properties

    payload? toolCallResults? userMessage?

    Properties

    Optional payload

    payload?: Payload

    Additional data that can be passed to the agent.

    Optional toolCallResults

    toolCallResults?: ToolCallResult[]

    For client-sided tools, this can be used to notify the result of the tool call. E.g. If the previous agent call response was: { toolCalls: [ { id: '1', name: 'getWeather', parameters: { ... } }, } Then when the client-side tool is executed, you can call the agent with: { toolCallResults: [ { id: '1', result: { ... } } ]

    Optional userMessage

    userMessage?: string

    For chat-based agents, this is the user message sent from the client.

    Settings

    Member Visibility

    Theme

    On This Page

    payloadtoolCallResultsuserMessage