Interface ChatOpenAICallOptions

interface ChatOpenAICallOptions {
    options?: OpenAICoreRequestOptions<Record<string, unknown>>;
    parallel_tool_calls?: boolean;
    promptIndex?: number;
    response_format?: {
        type: "json_object";
    };
    seed?: number;
    stream_options?: {
        include_usage: boolean;
    };
    strict?: boolean;
    tool_choice?: OpenAIToolChoice;
    tools?: StructuredToolInterface[] | ChatCompletionTool[];
}

Hierarchy (view full)

Properties

options? parallel_tool_calls? promptIndex? response_format? seed? stream_options? strict? tool_choice? tools?

Properties

Optionaloptions

options?: OpenAICoreRequestOptions<Record<string, unknown>>

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.

OptionalpromptIndex

promptIndex?: number

Optionalresponse_format

response_format?: {
    type: "json_object";
}

Optionalseed

seed?: number

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.

Enabled by default for "gpt-" models.

Version

0.2.6

Optionaltool_choice

tool_choice?: OpenAIToolChoice

Optionaltools

tools?: StructuredToolInterface[] | ChatCompletionTool[]

Settings

Member Visibility

On This Page

Properties