Interface AgentChatRequest

interface AgentChatRequest {
    agentName: string;
    appConfig: Record<string, any>;
    conversationId?: string;
    onStreamContentPush?: ((content) => void);
    payload?: Record<string, any>;
    toolCallResults?: ToolCallResult[];
    userMessage?: string;
}

Hierarchy

  • Omit<ChatRequest, "conversationId" | "requestId" | "isNewConversation" | "stream">
    • AgentChatRequest

Properties

agentName appConfig conversationId? onStreamContentPush? payload? toolCallResults? userMessage?

Properties

agentName

agentName: string

appConfig

appConfig: Record<string, any>

Additional configuration that can be passed from the client to the agent. This can be used to pass feature-flags or other configuration values. E.g. { model: 'gpt-3.5-turbo-0125', promptVersion: "chain-of-thought", }

Optional conversationId

conversationId?: string

Optional onStreamContentPush

onStreamContentPush?: ((content) => void)

Stream response -- can be set optionally, otherwise the response will be returned

Type declaration

Optional payload

payload?: Record<string, any>

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

agentNameappConfigconversationIdonStreamContentPushpayloadtoolCallResultsuserMessage