Skip to content

assistant

function assistant(content, options?): object

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

Parameter Type Description

content

| string | ( | { providerData: Record<string, any>; text: string; type: "output_text"; } | { providerData: Record<string, any>; refusal: string; type: "refusal"; } | { 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

object

a message entry

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";
})[];
optional id: string;
optional providerData: Record<string, any>;
role: "assistant";
status: "in_progress" | "completed" | "incomplete";
optional type: "message";