Interface ClientToolResult

The result of executing a client-side tool handler.

interface ClientToolResult {
    Data?: unknown;
    ErrorMessage?: string;
    Media?: ClientToolMediaItem[];
    Success: boolean;
}

Index

Properties

Data? ErrorMessage? Media? Success

Properties

`Optional`Data

Data?: unknown

The result data

`Optional`ErrorMessage

ErrorMessage?: string

Error message if execution failed

`Optional`Media

Media?: ClientToolMediaItem[]

Images for the model, when the tool returns any

Success

Success: boolean

Whether the tool executed successfully