AxAIOpenAIResponsesRequest Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxAIOpenAIResponsesRequest.md interface AxAIOpenAIResponsesRequest

AxAIOpenAIResponsesRequest

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/openai/responses_types.ts#L288

Type Parameters

Type ParameterDefault type
TModelAxAIOpenAIResponsesModel

Properties

PropertyModifierType
background?readonlyboolean | null
include?readonly| readonly ( | "file_search_call.results" | "message.input_image.image_url" | "computer_call_output.output.image_url" | "reasoning.encrypted_content" | "code_interpreter_call.outputs" | "web_search_call.action.return_token_budget")[] | null
inputreadonly| string | readonly AxAIOpenAIResponsesInputItem[]
instructions?readonlystring | null
max_output_tokens?readonlynumber | null
metadata?readonlyReadonly<Record<string, string>> | null
modelreadonlyTModel
parallel_tool_calls?readonlyboolean | null
previous_response_id?readonlystring | null
prompt_cache_key?readonlystring
prompt_cache_options?readonlyobject
prompt_cache_options.mode?readonly"explicit" | "implicit"
prompt_cache_options.ttl?readonly"30m"
prompt_cache_retention?readonly"in_memory" | "24h"
reasoning?readonly| { effort?: "high" | "low" | "max" | "none" | "medium" | "minimal" | "xhigh" | null; summary?: "auto" | "detailed" | "concise" | null; } | null
seed?readonlynumber | null
service_tier?readonlystring | null
store?readonlyboolean | null
stream?readonlyboolean | null
temperature?readonlynumber | null
text?readonly| { format?: | { type: "text"; } | { type: "json_object"; } | { description?: string; json_schema?: object; name?: string; schema?: object; strict?: boolean; type: "json_schema"; } | null; } | null
tool_choice?readonly| AxAIOpenAIResponsesToolChoice | null
tools?readonly| readonly AxAIOpenAIResponsesToolDefinition[] | null
top_p?readonlynumber | null
truncation?readonly"auto" | "disabled" | null
user?readonlystring | null
Docs