Interface ChatNovitaCallOptions

interface ChatNovitaCallOptions {
    audio?: ChatCompletionAudioParam;
    callbacks?: Callbacks;
    configurable?: Record<string, any>;
    include?: null | ResponseIncludable[];
    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;
    previous_response_id?: null | string;
    promptIndex?: number;
    reasoning?: Reasoning;
    reasoning_effort?: ChatCompletionReasoningEffort;
    recursionLimit?: number;
    response_format: {
        schema: Record<string, unknown>;
        type: "json_object";
    };
    runId?: string;
    runName?: string;
    seed?: number;
    service_tier?:
        | null
        | "default"
        | "auto"
        | "flex";
    signal?: AbortSignal;
    stop?: string[];
    stream_options?: {
        include_usage: boolean;
    };
    strict?: boolean;
    tags?: string[];
    text?: ResponseTextConfig;
    timeout?: number;
    tool_choice?:
        | string
        | ChatCompletionNamedToolChoice
        | ToolChoiceTypes
        | ToolChoiceFunction;
    tools?: ChatOpenAIToolType[];
    truncation?: null | "auto" | "disabled";
}

Hierarchy

  • Omit<ChatOpenAICallOptions, NovitaUnsupportedCallOptions>
    • ChatNovitaCallOptions

Properties

audio? callbacks? configurable? include? ls_structured_output_format? maxConcurrency? metadata? modalities? options? parallel_tool_calls? prediction? previous_response_id? promptIndex? reasoning? reasoning_effort? recursionLimit? response_format runId? runName? seed? service_tier? signal? stop? stream_options? strict? tags? text? timeout? tool_choice? tools? truncation?

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.

Optionalinclude

include?: null | ResponseIncludable[]

Specify additional output data to include in the model response.

If set, the Responses API will be used to fulfill the request.

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

Whether or not to restrict the ability to call multiple tools in one response.

Optionalprediction

prediction?: ChatCompletionPredictionContent

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

Optionalprevious_response_id

previous_response_id?: null | string

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Will be set automatically if ChatOpenAI.zdrEnabled is false, provided that AIMessages included in the request have a response_metadata.id property. Ignored unless ChatOpenAI.useResponsesApi is true.

If set, the Responses API will be used to fulfill the request.

OptionalpromptIndex

promptIndex?: number

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.

Optionalreasoning_effort

reasoning_effort?: ChatCompletionReasoningEffort

Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

Deprecated

Use reasoning object instead.

OptionalrecursionLimit

recursionLimit?: number

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

response_format

response_format: {
    schema: Record<string, unknown>;
    type: "json_object";
}

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

Optionalservice_tier

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

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?: {
    include_usage: boolean;
}

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

Type declaration

  • include_usage: boolean

    Whether or not to include token usage in the stream. If set to true, this will include an additional chunk at the end of the stream with the token usage.

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.

Version

0.2.6

Optionaltags

tags?: string[]

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

Optionaltext

text?: ResponseTextConfig

Configuration options for a text response from the model. Can be plain text or structured JSON data.

If set, the Responses API will be used to fulfill the request.

Optionaltimeout

timeout?: number

Timeout for this call in milliseconds.

Optionaltool_choice

tool_choice?:
    | string
    | ChatCompletionNamedToolChoice
    | ToolChoiceTypes
    | ToolChoiceFunction

Optionaltools

tools?: ChatOpenAIToolType[]

Optionaltruncation

truncation?: null | "auto" | "disabled"

The truncation strategy to use for the model response.

If set, the Responses API will be used to fulfill the request.

Settings

Member Visibility

On This Page

Properties