Class OpenAIClient

API Client for interfacing with the OpenAI API.

Hierarchy

  • APIClient
    • OpenAIClient

Constructors

constructor

Properties

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

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 OpenAIClient(__namedParameters?): OpenAIClient

  • API Client for interfacing with the OpenAI API.

    Parameters

    Returns OpenAIClient

Properties

apiKey

apiKey: string

audio

audio: OpenAIClient.Audio

baseURL

baseURL: string

batches

batches: Batches

beta

beta: Beta

chat

chat: OpenAIClient.Chat

completions

completions: OpenAIClient.Completions

embeddings

embeddings: OpenAIClient.Embeddings

files

files: OpenAIClient.Files

fineTuning

fineTuning: FineTuning

httpAgent

httpAgent: undefined | Agent

Protected OptionalidempotencyHeader

idempotencyHeader?: string

images

images: Images

maxRetries

maxRetries: number

models

models: Models

moderations

moderations: Moderations

organization

organization: null | string

project

project: null | string

timeout

timeout: number

uploads

uploads: Uploads

StaticAPIConnectionError

APIConnectionError: typeof APIConnectionError

StaticAPIConnectionTimeoutError

APIConnectionTimeoutError: typeof APIConnectionTimeoutError

StaticAPIError

APIError: typeof APIError

StaticAPIUserAbortError

APIUserAbortError: typeof APIUserAbortError

StaticAuthenticationError

AuthenticationError: typeof AuthenticationError

StaticBadRequestError

BadRequestError: typeof BadRequestError

StaticConflictError

ConflictError: typeof ConflictError

StaticDEFAULT_TIMEOUT

DEFAULT_TIMEOUT: number

StaticInternalServerError

InternalServerError: typeof InternalServerError

StaticNotFoundError

NotFoundError: typeof NotFoundError

StaticOpenAI

OpenAI: typeof OpenAIClient

StaticOpenAIError

OpenAIError: typeof OpenAIError

StaticPermissionDeniedError

PermissionDeniedError: typeof PermissionDeniedError

StaticRateLimitError

RateLimitError: typeof RateLimitError

StaticUnprocessableEntityError

UnprocessableEntityError: typeof UnprocessableEntityError

StaticfileFromPath

fileFromPath: {
    (path: string, options?: FileFromPathOptions): Promise<File>;
    (path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
}

StatictoFile

toFile: ((value: ToFileInput | PromiseLike<ToFileInput>, name?: null | string, options?: FilePropertyBag) => Promise<FileLike>)

Type declaration

    • (value, name?, options?): Promise<FileLike>

    • Helper for creating a File to pass to an SDK upload method from a variety of different data formats

      Parameters

      • value: ToFileInput | PromiseLike<ToFileInput>

        the raw content of the file. Can be an Uploadable, BlobLikePart, or AsyncIterable of BlobLikeParts

      • Optionalname: null | string

        the name of the file. If omitted, toFile will try to determine a file name from bits if possible

      • Optionaloptions: FilePropertyBag

        additional properties

      Returns Promise<FileLike>

      a File with the given properties

Methods

ProtectedauthHeaders

  • authHeaders(opts): Headers

  • Parameters

    • opts: FinalRequestOptions<unknown>

    Returns Headers

buildRequest

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

  • Type Parameters

    • Req

    Parameters

    • options: FinalRequestOptions<Req>
    • Optional__namedParameters: {
          retryCount?: number;
      }
      • OptionalretryCount?: number

    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

ProtecteddefaultHeaders

  • defaultHeaders(opts): Headers

  • Override this to add your own default headers, for example:

    { ...super.defaultHeaders(), Authorization: 'Bearer 123', }

    Parameters

    • opts: FinalRequestOptions<unknown>

    Returns Headers

ProtecteddefaultIdempotencyKey

  • defaultIdempotencyKey(): string

  • Returns string

ProtecteddefaultQuery

  • defaultQuery(): undefined | DefaultQuery

  • Returns undefined | DefaultQuery

delete

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

  • Type Parameters

    • Req
    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions<Req>>

    Returns APIPromise<Rsp>

fetchWithTimeout

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

  • Parameters

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

    Returns Promise<Response>

get

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

  • Type Parameters

    • Req
    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions<Req>>

    Returns APIPromise<Rsp>

getAPIList

  • getAPIList<Item, PageClass>(path, Page, opts?): PagePromise<PageClass, Item>

  • Type Parameters

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

    Parameters

    • path: string
    • Page: (new (...args: any[]) => PageClass)
    • Optionalopts: RequestOptions<any>

    Returns PagePromise<PageClass, Item>

ProtectedgetRequestClient

  • getRequestClient(): RequestClient

  • Returns RequestClient

ProtectedmakeStatusError

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

  • Parameters

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

    Returns APIError

ProtectedparseHeaders

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

  • Parameters

    • headers: undefined | null | HeadersInit

    Returns Record<string, string>

patch

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

  • Type Parameters

    • Req
    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions<Req>>

    Returns APIPromise<Rsp>

post

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

  • Type Parameters

    • Req
    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions<Req>>

    Returns APIPromise<Rsp>

ProtectedprepareOptions

  • prepareOptions(options): Promise<void>

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

    Parameters

    • options: FinalRequestOptions<unknown>

    Returns Promise<void>

ProtectedprepareRequest

  • 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

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions<Req>>

    Returns APIPromise<Rsp>

request

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

  • Type Parameters

    • Req
    • Rsp

    Parameters

    • options: PromiseOrValue<FinalRequestOptions<Req>>
    • OptionalremainingRetries: 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: [client: APIClient, response: Response, body: unknown, options: FinalRequestOptions<unknown>]) => 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>

ProtectedstringifyQuery

  • stringifyQuery(query): string

  • Parameters

    • query: Record<string, unknown>

    Returns string

ProtectedvalidateHeaders

  • validateHeaders(headers, customHeaders): void

  • Override this to add your own headers validation:

    Parameters

    • headers: Headers
    • customHeaders: Headers

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods