AxAIOpenAIChatRequest type AxAIOpenAIChatRequest < TModel > = object ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L140
Type Parameters Properties
audio? Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L145
format : "wav" | "mp3" | "flac" | "opus" | "aac" | "pcm16" ; voice voice :
| string
| {
id : string ;
};
frequency_penalty? optional frequency_penalty : number ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L238
logit_bias? optional logit_bias : Map < string , number >; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L239
max_completion_tokens? optional max_completion_tokens : number ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L231
messages messages : (
| {
content : string ;
role : "system" ;
}
| {
content : | string
| (
| {
text : string ;
type : string ;
}
| {
image_url : {
details? : ... ;
url : ... ;
};
type : "image_url" ;
}
| {
input_audio : {
channels? : ... ;
data : ... ;
format : ... ;
mimeType? : ... ;
sampleRate? : ... ;
};
type : "input_audio" ;
}
| {
file : {
file_data : ... ;
filename : ... ;
};
type : "file" ;
})[];
name? : string ;
role : "user" ;
}
| {
audio ?: {
id : string ;
};
content ?: | string
| {
text : string ;
type : string ;
};
name? : string ;
role : "assistant" ;
}
| {
content ?: | string
| {
text : string ;
type : string ;
};
name? : string ;
role : "assistant" ;
tool_calls : object [];
}
| {
content : string ;
role : "tool" ;
tool_call_id : string ;
})[]; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L149
modalities? optional modalities : readonly ( "text" | "audio" )[]; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L144
model Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L141
n? Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L234
organization? optional organization : string ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L241
presence_penalty? optional presence_penalty : number ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L237
reasoning_effort? optional reasoning_effort : "none" | "minimal" | "low" | "medium" | "high" | "xhigh" ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L142
optional response_format :
| {
type : string ;
}
| {
json_schema : any ;
type : "json_schema" ;
}; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L228
stop? optional stop : readonly string []; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L236
store? Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L143
stream? optional stream : boolean ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L235
temperature? optional temperature : number ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L232
optional tool_choice :
| "none"
| "auto"
| "required"
| {
function : {
name : string ;
};
type : "function" ;
}; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L223
optional tools : object []; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L215
function {
description : string ;
name : string ;
parameters? : object ;
} type
top_p? Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L233
user? Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L240
web_search_options? optional web_search_options : object ; Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L242
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 ;