assistant

function assistant(content, options?): object;

Creates an assistant message entry for example for multi-shot prompting

Parameters

Parameter	Type	Description
content	| string | ( | { providerData?: Record<string, any>; refusal: string; type: "refusal"; } | { providerData?: Record<string, any>; text: string; type: "output_text"; } | { providerData?: Record<string, any>; text: string; type: "input_text"; } | { audio: | string | { id: string; }; format?: null | string; providerData?: Record<string, any>; transcript?: null | string; type: "audio"; } | { image: string; providerData?: Record<string, any>; type: "image"; })[]	‐
options?	Record<string, any>	Any additional options that will be directly passed to the model

Returns

a message entry

content

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

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: "assistant";

Representing a message from the assistant (i.e. the model)

status

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

The status of the message.

type?

optional type: "message";

Any item without a type is treated as a message