Interface ChatOpenAICallOptions

interface ChatOpenAICallOptions {
    options?: OpenAICoreRequestOptions<Record<string, unknown>>;
    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? 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 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;
}

Type declaration

  • include_usage: boolean

Optional tool_choice

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

Optional tools

tools?: StructuredToolInterface[] | ChatCompletionTool[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc