Interface ClientToolResultSummary

Summary of a client tool execution result, used in conversation messages.

interface ClientToolResultSummary {
    ErrorMessage?: string;
    Media?: ClientToolMediaItem[];
    Result?: unknown;
    Success: boolean;
    ToolName: string;
}

Index

Properties

ErrorMessage? Media? Result? Success ToolName

Properties

`Optional`ErrorMessage

ErrorMessage?: string

Error message if the tool failed

`Optional`Media

Media?: ClientToolMediaItem[]

Images for the model, when the tool returns any.

`Optional`Result

Result?: unknown

Result data from the tool

Success

Success: boolean

Whether the execution succeeded

ToolName

ToolName: string

Name of the tool that was executed