Skip to main content
Module

x/openai/mod.ts>ClientOptions

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface ClientOptions
import { type ClientOptions } from "https://deno.land/x/openai@v4.40.0/mod.ts";

Properties

optional
apiKey: string | undefined

Defaults to process.env['OPENAI_API_KEY'].

optional
organization: string | null | undefined

Defaults to process.env['OPENAI_ORG_ID'].

optional
project: string | null | undefined

Defaults to process.env['OPENAI_PROJECT_ID'].

optional
baseURL: string | null | undefined

Override the default base URL for the API, e.g., "https://api.example.com/v2/"

Defaults to process.env['OPENAI_BASE_URL'].

optional
timeout: number

The maximum amount of time (in milliseconds) that the client should wait for a response from the server before timing out a single request.

Note that request timeouts are retried by default, so in a worst-case scenario you may wait much longer than this timeout before the promise succeeds or fails.

optional
httpAgent: Agent

An HTTP agent used to manage HTTP(S) connections.

If not provided, an agent will be constructed by default in the Node.js environment, otherwise no agent is used.

optional
fetch: Core.Fetch | undefined

Specify a custom fetch function implementation.

If not provided, we use node-fetch on Node.js and otherwise expect that fetch is defined globally.

optional
maxRetries: number

The maximum number of times that the client will retry a request in case of a temporary failure, like a network error or a 5XX error from the server.

optional
defaultHeaders: Core.Headers

Default headers to include with every request to the API.

These can be removed in individual requests by explicitly setting the header to undefined or null in request options.

optional
defaultQuery: Core.DefaultQuery

Default query parameters to include with every request to the API.

These can be removed in individual requests by explicitly setting the param to undefined in request options.

optional
dangerouslyAllowBrowser: boolean

By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. Only set this option to true if you understand the risks and have appropriate mitigations in place.