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;
    };
    tool_choice?: "auto" | "required" | "none" | ChatCompletionNamedToolChoice;
    tools?: StructuredToolInterface[] | ChatCompletionTool[];
}

Hierarchy (view full)

Properties

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

Properties

Optional options

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

Additional options to pass to the underlying axios request.

Optional parallel_tool_calls

parallel_tool_calls?: boolean

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

Optional promptIndex

promptIndex?: number

Optional response_format

response_format?: {
    type: "json_object";
}

Type declaration

  • type: "json_object"

Optional seed

seed?: number

Optional stream_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.

Optional tool_choice

tool_choice?: "auto" | "required" | "none" | ChatCompletionNamedToolChoice

Optional tools

tools?: StructuredToolInterface[] | ChatCompletionTool[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc