AxAIOpenAIChatRequest Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxAIOpenAIChatRequest.md type AxAIOpenAIChatRequest

AxAIOpenAIChatRequest

TypeScript
type AxAIOpenAIChatRequest<TModel> = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L140

Type Parameters

Type Parameter
TModel

Properties

audio?

TypeScript
optional audio: object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L145

format

TypeScript
format: "wav" | "mp3" | "flac" | "opus" | "aac" | "pcm16";

voice

TypeScript
voice: 
  | string
  | {
  id: string;
};

frequency_penalty?

TypeScript
optional frequency_penalty: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L238


logit_bias?

TypeScript
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?

TypeScript
optional max_completion_tokens: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L231


messages

TypeScript
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?

TypeScript
optional modalities: readonly ("text" | "audio")[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L144


model

TypeScript
model: TModel;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L141


n?

TypeScript
optional n: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L234


organization?

TypeScript
optional organization: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L241


presence_penalty?

TypeScript
optional presence_penalty: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L237


reasoning_effort?

TypeScript
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


response_format?

TypeScript
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?

TypeScript
optional stop: readonly string[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L236


store?

TypeScript
optional store: boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L143


stream?

TypeScript
optional stream: boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L235


temperature?

TypeScript
optional temperature: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L232


tool_choice?

TypeScript
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


tools?

TypeScript
optional tools: object[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L215

function

TypeScript
{
  description: string;
  name: string;
  parameters?: object;
}

type

TypeScript
type: "function";

top_p?

TypeScript
optional top_p: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L233


user?

TypeScript
optional user: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/chat_types.ts#L240


web_search_options?

TypeScript
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?

TypeScript
optional search_context_size: "low" | "medium" | "high";

user_location?

TypeScript
optional user_location: 
  | {
  approximate: {
     city?: string;
     country?: string;
     region?: string;
     timezone?: string;
     type: "approximate";
  };
}
  | null;
Docs