user

function user(input, options?): object;

Creates a user message entry

Parameters

Parameter	Type	Description
input	| string | ( | { providerData?: Record<string, any>; text: string; type: "input_text"; } | { image: | string | { id: string; }; providerData?: Record<string, any>; type: "input_image"; } | { file: | string | { id: string; } | { url: string; }; providerData?: Record<string, any>; type: "input_file"; } | { audio: | string | { id: string; }; format?: string | null; providerData?: Record<string, any>; transcript?: string | null; type: "audio"; })[]	The input message from the user.
options?	Record<string, any>	Any additional options that will be directly passed to the model.

Returns

A message entry.

content

content:
  | string
  | (
  | {
  providerData?: Record<string, any>;
  text: string;
  type: "input_text";
}
  | {
  image:   | string
     | {
     id: string;
   };
  providerData?: Record<string, any>;
  type: "input_image";
}
  | {
  file:   | string
     | {
     id: string;
   }
     | {
     url: string;
   };
  providerData?: Record<string, any>;
  type: "input_file";
}
  | {
  audio:   | string
     | {
     id: string;
   };
  format?: string | null;
  providerData?: Record<string, any>;
  transcript?: string | null;
  type: "audio";
})[];

The content of the message.

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.

providerData?

optional providerData: Record<string, any>;

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

role

role: "user";

Representing a message from the user

type?

optional type: "message";

Any item without a type is treated as a message