ToolCallStructuredOutput

type ToolCallStructuredOutput =
  | {
  providerData?: Record<string, any>;
  text: string;
  type: "input_text";
}
  | {
  detail?: string;
  image?:   | string
     | {
     id: string;
   };
  providerData?: Record<string, any>;
  type: "input_image";
}
  | {
  file?:   | string
     | {
     id: string;
   }
     | {
     url: string;
   };
  filename?: string;
  providerData?: Record<string, any>;
  type: "input_file";
};

Type Declaration

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

providerData?

optional providerData: Record<string, any>;

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

text

text: string;

A text input for example a message from a user

type

type: "input_text";

{
  detail?: string;
  image?:   | string
     | {
     id: string;
   };
  providerData?: Record<string, any>;
  type: "input_image";
}

detail?

optional detail: string;

Controls the level of detail requested for image understanding tasks. Future models may add new values, therefore this accepts any string.

image?

optional image:
  | string
  | {
  id: string;
};

The image input to the model. Could be provided inline (image), as a URL, or by reference to a previously uploaded OpenAI file.

providerData?

optional providerData: Record<string, any>;

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

type

type: "input_image";

{
  file?:   | string
     | {
     id: string;
   }
     | {
     url: string;
   };
  filename?: string;
  providerData?: Record<string, any>;
  type: "input_file";
}

file?

optional file:
  | string
  | {
  id: string;
}
  | {
  url: string;
};

The file input to the model. Could be raw data, a URL, or an OpenAI file ID.

filename?

optional filename: string;

Optional filename metadata when uploading file data inline.

providerData?

optional providerData: Record<string, any>;

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

type

type: "input_file";