AxAIOpenAIChatRequest
type AxAIOpenAIChatRequest<TModel> = object;Type Parameters
| Type Parameter |
|---|
TModel |
Properties
audio?
optional audio: object;format
format: "wav" | "mp3" | "flac" | "opus" | "aac" | "pcm16";voice
voice:
| string
| {
id: string;
};frequency_penalty?
optional frequency_penalty: number;logit_bias?
optional logit_bias: Map<string, number>;max_completion_tokens?
optional max_completion_tokens: number;messages
messages: (
| {
content: | string
| AxAIOpenAIChatContentPart[];
role: "system";
}
| {
content: | string
| AxAIOpenAIChatContentPart[];
name?: string;
role: "user";
}
| {
audio?: {
id: string;
};
content?: | string
| {
text: string;
type: string;
}
| AxAIOpenAIChatContentPart[];
name?: string;
reasoning_content?: string;
role: "assistant";
}
| {
content?: | string
| {
text: string;
type: string;
}
| AxAIOpenAIChatContentPart[];
name?: string;
reasoning_content?: string;
role: "assistant";
tool_calls: object[];
}
| {
content: | string
| AxAIOpenAIChatContentPart[];
role: "tool";
tool_call_id: string;
})[];modalities?
optional modalities: readonly ("text" | "audio")[];model
model: TModel;n?
optional n: number;organization?
optional organization: string;presence_penalty?
optional presence_penalty: number;prompt_cache_key?
optional prompt_cache_key: string;Stable per-conversation key that routes the request to the shard its cache lives on. GPT-5.6+ requires it for reliable matching; earlier families predate it and reject it with a 400.
prompt_cache_options?
optional prompt_cache_options: object;implicit (the default) also places a breakpoint at the newest user or tool
message; explicit uses only caller-provided breakpoints.
mode?
optional mode: "implicit" | "explicit";reasoning_effort?
optional reasoning_effort: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";response_format?
optional response_format:
| {
type: string;
}
| {
json_schema: any;
type: "json_schema";
};stop?
optional stop: readonly string[];store?
optional store: boolean;stream?
optional stream: boolean;temperature?
optional temperature: number;tool_choice?
optional tool_choice:
| "none"
| "auto"
| "required"
| {
function: {
name: string;
};
type: "function";
};tools?
optional tools: object[];function
{
description: string;
name: string;
parameters?: object;
}type
type: "function";top_p?
optional top_p: number;user?
optional user: string;web_search_options?
optional web_search_options: object;search_context_size?
optional search_context_size: "low" | "medium" | "high";user_location?
optional user_location:
| {
approximate: {
city?: string;
country?: string;
region?: string;
timezone?: string;
type: "approximate";
};
}
| null;