Class OpenAI

API Client for interfacing with the OpenAI API.

Hierarchy

  • APIClient
    • OpenAI

Constructors

constructor

Properties

_options apiKey audio baseURL beta chat completions embeddings files fineTuning httpAgent idempotencyHeader? images maxRetries models moderations organization timeout APIConnectionError APIConnectionTimeoutError APIError APIUserAbortError AuthenticationError BadRequestError ConflictError InternalServerError NotFoundError OpenAI OpenAIError PermissionDeniedError RateLimitError UnprocessableEntityError

Methods

authHeaders buildRequest buildURL defaultHeaders defaultIdempotencyKey defaultQuery delete fetchWithTimeout get getAPIList getRequestClient makeStatusError parseHeaders patch post prepareOptions prepareRequest put request requestAPIList stringifyQuery validateHeaders

Constructors

constructor

  • new OpenAI(__namedParameters?): openai.OpenAI

  • API Client for interfacing with the OpenAI API.

    Parameters

    Returns openai.OpenAI

Properties

Private _options

_options: any

apiKey

apiKey: string

audio

audio: Audio

baseURL

baseURL: string

beta

beta: Beta

chat

chat: openai.OpenAI.Chat

completions

completions: openai.OpenAI.Completions

embeddings

embeddings: Embeddings

files

files: openai.OpenAI.Files

fineTuning

fineTuning: FineTuning

httpAgent

httpAgent: any

Protected Optional idempotencyHeader

idempotencyHeader?: string

images

images: Images

maxRetries

maxRetries: number

models

models: Models

moderations

moderations: Moderations

organization

organization: null | string

timeout

timeout: number

Static APIConnectionError

APIConnectionError: typeof APIConnectionError

Static APIConnectionTimeoutError

APIConnectionTimeoutError: typeof APIConnectionTimeoutError

Static APIError

APIError: typeof APIError

Static APIUserAbortError

APIUserAbortError: typeof APIUserAbortError

Static AuthenticationError

AuthenticationError: typeof AuthenticationError

Static BadRequestError

BadRequestError: typeof BadRequestError

Static ConflictError

ConflictError: typeof ConflictError

Static InternalServerError

InternalServerError: typeof InternalServerError

Static NotFoundError

NotFoundError: typeof NotFoundError

Static OpenAI

OpenAI: typeof OpenAI

Static OpenAIError

OpenAIError: typeof OpenAIError

Static PermissionDeniedError

PermissionDeniedError: typeof PermissionDeniedError

Static RateLimitError

RateLimitError: typeof RateLimitError

Static UnprocessableEntityError

UnprocessableEntityError: typeof UnprocessableEntityError

Methods

Protected authHeaders

  • authHeaders(opts): Headers

  • Parameters

    • opts: FinalRequestOptions<unknown>

    Returns Headers

buildRequest

  • buildRequest<Req>(options): {
        req: RequestInit;
        timeout: number;
        url: string;
    }

  • Type Parameters

    • Req

    Parameters

    • options: FinalRequestOptions<Req>

    Returns {
        req: RequestInit;
        timeout: number;
        url: string;
    }

    • req: RequestInit
    • timeout: number
    • url: string

buildURL

  • buildURL<Req>(path, query): string

  • Type Parameters

    • Req

    Parameters

    • path: string
    • query: undefined | null | Req

    Returns string

Protected defaultHeaders

  • defaultHeaders(opts): Headers

  • Parameters

    • opts: FinalRequestOptions<unknown>

    Returns Headers

Protected defaultIdempotencyKey

  • defaultIdempotencyKey(): string

  • Returns string

Protected defaultQuery

  • defaultQuery(): undefined | DefaultQuery

  • Returns undefined | DefaultQuery

delete

  • delete<Req, Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    Returns APIPromise<Rsp>

fetchWithTimeout

  • fetchWithTimeout(url, init, ms, controller): Promise<Response>

  • Parameters

    • url: never
    • init: undefined | RequestInit
    • ms: number
    • controller: AbortController

    Returns Promise<Response>

get

  • get<Req, Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    Returns APIPromise<Rsp>

getAPIList

Protected getRequestClient

  • getRequestClient(): RequestClient

  • Returns RequestClient

Protected makeStatusError

  • makeStatusError(status, error, message, headers): APIError

  • Parameters

    • status: undefined | number
    • error: undefined | Object
    • message: undefined | string
    • headers: undefined | Headers

    Returns APIError

Protected parseHeaders

  • parseHeaders(headers): Record<string, string>

  • Parameters

    • headers: undefined | null

    Returns Record<string, string>

patch

  • patch<Req, Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    Returns APIPromise<Rsp>

post

  • post<Req, Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    Returns APIPromise<Rsp>

Protected prepareOptions

  • prepareOptions(options): Promise<void>

  • Used as a callback for mutating the given FinalRequestOptions object.

    Parameters

    • options: FinalRequestOptions<unknown>

    Returns Promise<void>

Protected prepareRequest

  • prepareRequest(request, __namedParameters): Promise<void>

  • Used as a callback for mutating the given RequestInit object.

    This is useful for cases where you want to add certain headers based off of the request properties, e.g. method or url.

    Parameters

    • request: RequestInit
    • __namedParameters: {
          options: FinalRequestOptions<unknown>;
          url: string;
      }
      • options: FinalRequestOptions<unknown>
      • url: string

    Returns Promise<void>

put

  • put<Req, Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    Returns APIPromise<Rsp>

request

  • request<Req, Rsp>(options, remainingRetries?): APIPromise<Rsp>

  • Type Parameters

    • Req

    • Rsp

    Parameters

    • options: PromiseOrValue<FinalRequestOptions<Req>>
    • Optional remainingRetries: null | number

    Returns APIPromise<Rsp>

requestAPIList

  • requestAPIList<Item, PageClass>(Page, options): PagePromise<PageClass, Item>

  • Type Parameters

    • Item = unknown

    • PageClass extends AbstractPage<Item> = AbstractPage<Item>

    Parameters

    • Page: (new (...args) => PageClass)
        • new (...args): PageClass

        • Parameters

          • Rest ...args: [client: APIClient, response: Response, body: unknown, options: FinalRequestOptions<unknown>]

          Returns PageClass

    • options: FinalRequestOptions<unknown>

    Returns PagePromise<PageClass, Item>

Protected stringifyQuery

  • stringifyQuery(query): string

  • Parameters

    • query: Record<string, unknown>

    Returns string

Protected validateHeaders

  • validateHeaders(headers, customHeaders): void

  • Override this to add your own headers validation:

    Parameters

    • headers: Headers
    • customHeaders: Headers

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc