Type Alias ChatOpenAICallOptions

ChatOpenAICallOptions: {
    audio: undefined | ChatCompletionAudioParam;
    callbacks?: undefined | Callbacks;
    configurable: undefined | Record<string, any>;
    function_call: undefined | FunctionCallOption;
    functions: undefined | FunctionDefinition[];
    include: undefined | null | ResponseIncludable[];
    ls_structured_output_format?: undefined | {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    };
    maxConcurrency: undefined | number;
    metadata?: undefined | Record<string, unknown>;
    modalities: undefined | ChatCompletionModality[];
    options?: undefined | RequestOptions;
    parallel_tool_calls: undefined | boolean;
    prediction: undefined | ChatCompletionPredictionContent;
    previous_response_id: undefined | null | string;
    promptIndex: undefined | number;
    reasoning: undefined | Reasoning;
    recursionLimit: undefined | number;
    response_format: undefined | ChatOpenAIResponseFormat;
    runId?: undefined | string;
    runName?: undefined | string;
    seed: undefined | number;
    service_tier:
        | undefined
        | null
        | "auto"
        | "default"
        | "flex";
    signal: undefined | AbortSignal;
    stop?: undefined | string[];
    stream_options: undefined | ChatCompletionStreamOptions;
    strict: undefined | boolean;
    tags?: undefined | string[];
    text: undefined | ResponseTextConfig;
    timeout: undefined | number;
    tool_choice:
        | undefined
        | string
        | ChatCompletionNamedToolChoice
        | ToolChoiceTypes
        | ToolChoiceFunction;
    tools: undefined | ChatOpenAIToolType[];
    truncation:
        | undefined
        | null
        | "auto"
        | "disabled";
}

Type declaration

  • audio: undefined | ChatCompletionAudioParam
  • Optionalcallbacks?: undefined | 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.

  • configurable: undefined | Record<string, any>
  • function_call: undefined | FunctionCallOption
  • functions: undefined | FunctionDefinition[]
  • include: undefined | null | ResponseIncludable[]
  • Optionalls_structured_output_format?: undefined | {
        kwargs: {
            method: string;
        };
        schema?: JsonSchema7Type;
    }

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

  • maxConcurrency: undefined | number
  • Optionalmetadata?: undefined | 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.

  • modalities: undefined | ChatCompletionModality[]
  • Optionaloptions?: undefined | RequestOptions

    Additional options to pass to the underlying axios request.

  • parallel_tool_calls: undefined | boolean
  • prediction: undefined | ChatCompletionPredictionContent
  • previous_response_id: undefined | null | string
  • promptIndex: undefined | number
  • reasoning: undefined | Reasoning
  • recursionLimit: undefined | number
  • response_format: undefined | ChatOpenAIResponseFormat
  • OptionalrunId?: undefined | string

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

  • OptionalrunName?: undefined | string

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

  • seed: undefined | number
  • service_tier:
        | undefined
        | null
        | "auto"
        | "default"
        | "flex"
  • signal: undefined | AbortSignal
  • Optionalstop?: undefined | string[]

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

  • stream_options: undefined | ChatCompletionStreamOptions
  • strict: undefined | boolean
  • Optionaltags?: undefined | string[]

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

  • text: undefined | ResponseTextConfig
  • timeout: undefined | number
  • tool_choice:
        | undefined
        | string
        | ChatCompletionNamedToolChoice
        | ToolChoiceTypes
        | ToolChoiceFunction
  • tools: undefined | ChatOpenAIToolType[]
  • truncation:
        | undefined
        | null
        | "auto"
        | "disabled"

Settings

Member Visibility