AxAIOpenAIChatRequest
type AxAIOpenAIChatRequest<TModel> = object;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L102
Type Parameters
Properties
frequency_penalty?
optional frequency_penalty: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L186
logit_bias?
optional logit_bias: Map<string, number>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L187
max_completion_tokens?
optional max_completion_tokens: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L179
messages
messages: (
| {
content: string;
role: "system";
}
| {
content: | string
| (
| {
text: string;
type: string;
}
| {
image_url: {
details?: ...;
url: ...;
};
type: "image_url";
}
| {
input_audio: {
data: ...;
format?: ...;
};
type: "input_audio";
}
| {
file: {
file_data: ...;
filename: ...;
};
type: "file";
})[];
name?: string;
role: "user";
}
| {
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/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L106
model
model: TModel;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L103
n?
optional n: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L182
organization?
optional organization: string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L189
presence_penalty?
optional presence_penalty: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L185
reasoning_effort?
optional reasoning_effort: "low" | "medium" | "high";
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L104
optional response_format: object;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L178
type
type: string;
stop?
optional stop: readonly string[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L184
store?
optional store: boolean;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L105
stream?
optional stream: boolean;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L183
temperature?
optional temperature: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L180
optional tool_choice:
| "none"
| "auto"
| "required"
| {
function: {
name: string;
};
type: "function";
};
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L173
optional tools: object[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L165
function
{
description: string;
name: string;
parameters?: object;
}
type
type: "function";
top_p?
optional top_p: number;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L181
user?
optional user: string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L188
web_search_options?
optional web_search_options: object;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/openai/chat_types.ts#L190
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;