FunctionCallResultItem

type FunctionCallResultItem = object;

Type declaration

callId

callId: string;

The ID of the tool call. Required to match up the respective tool call result.

id?

optional id: string;

An ID to identify the item. This is optional by default. If a model provider absolutely requires this field, it will be validated on the model level.

name

name: string;

The name of the tool that was called

output

output:
  | {
  providerData: Record<string, any>;
  text: string;
  type: "text";
 }
  | {
  data: string;
  mediaType: string;
  providerData: Record<string, any>;
  type: "image";
};

The output of the tool call.

Type declaration

{ providerData: Record<string, any>; text: string; type: "text"; }

{ data: string; mediaType: string; providerData: Record<string, any>; type: "image"; }

providerData?

optional providerData: Record<string, any>;

Additional optional provider specific data. Used for custom functionality or model provider specific fields.

status

status: "in_progress" | "completed" | "incomplete";

The status of the tool call.

type

type: "function_call_result";