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?: OpenAICoreRequestOptions<Record<string, unknown>>

Additional options to pass to the underlying axios request.

parallel_tool_calls?: boolean

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

promptIndex?: number
response_format?: {
    type: "json_object";
}

Type declaration

  • type: "json_object"
seed?: number
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.

tool_choice?: "auto" | "required" | "none" | ChatCompletionNamedToolChoice
tools?: StructuredToolInterface[] | ChatCompletionTool[]

Generated using TypeDoc