Interface BaseChatOpenAICallOptions

interface BaseChatOpenAICallOptions {
    audio?: ChatCompletionAudioParam;
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    function_call?: FunctionCallOption;
    functions?: FunctionDefinition[];
    ls_structured_output_format?: {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    };
    maxConcurrency?: number;
    metadata?: Record<string, unknown>;
    modalities?: ChatCompletionModality[];
    options?: RequestOptions;
    parallel_tool_calls?: boolean;
    prediction?: ChatCompletionPredictionContent;
    promptCacheKey?: string;
    promptIndex?: number;
    reasoning?: Reasoning;
    recursionLimit?: number;
    response_format?: ChatOpenAIResponseFormat;
    runId?: string;
    runName?: string;
    seed?: number;
    service_tier?:
        | null
        | "auto"
        | "default"
        | "flex"
        | "scale"
        | "priority";
    signal?: AbortSignal;
    stop?: string[];
    stream_options?: ChatCompletionStreamOptions;
    strict?: boolean;
    tags?: string[];
    timeout?: number;
    tool_choice?:
        | string
        | ChatCompletionAllowedToolChoice
        | ChatCompletionNamedToolChoice
        | ChatCompletionNamedToolChoiceCustom
        | ToolChoiceAllowed
        | ToolChoiceTypes
        | ToolChoiceFunction
        | ToolChoiceMcp
        | ToolChoiceCustom;
    tools?: ChatOpenAIToolType[];
    verbosity?: OpenAIVerbosityParam;
}

Hierarchy (view full)

Properties

audio? callbacks? configurable? function_call? functions? ls_structured_output_format? maxConcurrency? metadata? modalities? options? parallel_tool_calls? prediction? promptCacheKey? promptIndex? reasoning? recursionLimit? response_format? runId? runName? seed? service_tier? signal? stop? stream_options? strict? tags? timeout? tool_choice? tools? verbosity?

Properties

Optionalaudio

audio?: ChatCompletionAudioParam

Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

Optionalcallbacks

callbacks?: Callbacks

Callbacks for this call and any sub-calls (eg. a Chain calling an LLM). Tags are passed to all callbacks, metadata is passed to handle*Start callbacks.

Optionalconfigurable

configurable?: Record<string, any>

Runtime values for attributes previously made configurable on this Runnable, or sub-Runnables.

Optionalfunction_call

function_call?: FunctionCallOption

Optionalfunctions

functions?: FunctionDefinition[]

Optionalls_structured_output_format

ls_structured_output_format?: {
    kwargs: {
        method: string;
    };
    schema?: JsonSchema7Type;
}

Describes the format of structured outputs. This should be provided if an output is considered to be structured

Type declaration

  • kwargs: {
        method: string;
    }

    An object containing the method used for structured output (e.g., "jsonMode").

    • method: string
  • Optionalschema?: JsonSchema7Type

    The JSON schema describing the expected output structure.

OptionalmaxConcurrency

maxConcurrency?: number

Maximum number of parallel calls to make.

Optionalmetadata

metadata?: Record<string, unknown>

Metadata for this call and any sub-calls (eg. a Chain calling an LLM). Keys should be strings, values should be JSON-serializable.

Optionalmodalities

modalities?: ChatCompletionModality[]

Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

["text"]

The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

["text", "audio"]

Optionaloptions

options?: RequestOptions

Additional options to pass to the underlying axios request.

Optionalparallel_tool_calls

parallel_tool_calls?: boolean

The model may choose to call multiple functions in a single turn. You can set parallel_tool_calls to false which ensures only one tool is called at most. Learn more

Optionalprediction

prediction?: ChatCompletionPredictionContent

Static predicted output content, such as the content of a text file that is being regenerated. Learn more.

OptionalpromptCacheKey

promptCacheKey?: string

Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. Learn more.

OptionalpromptIndex

promptIndex?: number

Adds a prompt index to prompts passed to the model to track what prompt is being used for a given generation.

Optionalreasoning

reasoning?: Reasoning

Options for reasoning models.

Note that some options, like reasoning summaries, are only available when using the responses API. If these options are set, the responses API will be used to fulfill the request.

These options will be ignored when not using a reasoning model.

OptionalrecursionLimit

recursionLimit?: number

Maximum number of times a call can recurse. If not provided, defaults to 25.

Optionalresponse_format

response_format?: ChatOpenAIResponseFormat

An object specifying the format that the model must output.

OptionalrunId

runId?: string

Unique identifier for the tracer run for this call. If not provided, a new UUID will be generated.

OptionalrunName

runName?: string

Name for the tracer run for this call. Defaults to the name of the class.

Optionalseed

seed?: number

When provided, the completions API will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.

Optionalservice_tier

service_tier?:
    | null
    | "auto"
    | "default"
    | "flex"
    | "scale"
    | "priority"

Service tier to use for this request. Can be "auto", "default", or "flex" Specifies the service tier for prioritization and latency optimization.

Optionalsignal

signal?: AbortSignal

Abort signal for this call. If provided, the call will be aborted when the signal is aborted.

See

https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal

Optionalstop

stop?: string[]

Stop tokens to use for this call. If not provided, the default stop tokens for the model will be used.

Optionalstream_options

stream_options?: ChatCompletionStreamOptions

Additional options to pass to streamed completions. If provided, this takes precedence over "streamUsage" set at initialization time.

Optionalstrict

strict?: boolean

If true, model output is guaranteed to exactly match the JSON Schema provided in the tool definition. If true, the input schema will also be validated according to https://platform.openai.com/docs/guides/structured-outputs/supported-schemas.

If false, input schema will not be validated and model output will not be validated.

If undefined, strict argument will not be passed to the model.

Optionaltags

tags?: string[]

Tags for this call and any sub-calls (eg. a Chain calling an LLM). You can use these to filter calls.

Optionaltimeout

timeout?: number

Timeout for this call in milliseconds.

Optionaltool_choice

tool_choice?:
    | string
    | ChatCompletionAllowedToolChoice
    | ChatCompletionNamedToolChoice
    | ChatCompletionNamedToolChoiceCustom
    | ToolChoiceAllowed
    | ToolChoiceTypes
    | ToolChoiceFunction
    | ToolChoiceMcp
    | ToolChoiceCustom

Specifies which tool the model should use to respond. Can be an OpenAIToolChoice or a ResponsesToolChoice. If not set, the model will decide which tool to use automatically.

Optionaltools

tools?: ChatOpenAIToolType[]

A list of tools that the model may use to generate responses. Each tool can be a function, a built-in tool, or a custom tool definition. If not provided, the model will not use any tools.

Optionalverbosity

verbosity?: OpenAIVerbosityParam

The verbosity of the model's response.

Settings

Member Visibility

On This Page

Properties