Class OpenAIClient

API Client for interfacing with the OpenAI API.

Constructors

constructor

Properties

apiKey audio baseURL batches beta chat completions containers embeddings evals fetchOptions files fineTuning graders idempotencyHeader? images logLevel logger maxRetries models moderations organization project responses timeout uploads vectorStores webhookSecret webhooks APIConnectionError APIConnectionTimeoutError APIError APIUserAbortError AuthenticationError BadRequestError ConflictError DEFAULT_TIMEOUT InternalServerError InvalidWebhookSignatureError NotFoundError OpenAI OpenAIError PermissionDeniedError RateLimitError UnprocessableEntityError toFile

Methods

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

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: Chat

completions

completions: OpenAIClient.Completions

containers

containers: Containers

embeddings

embeddings: OpenAIClient.Embeddings

evals

evals: Evals

fetchOptions

fetchOptions: undefined | MergedRequestInit

files

files: OpenAIClient.Files

fineTuning

fineTuning: FineTuning

graders

graders: OpenAIClient.Graders

Protected OptionalidempotencyHeader

idempotencyHeader?: string

images

images: Images

logLevel

logLevel: undefined | LogLevel

logger

logger: undefined | Logger

maxRetries

maxRetries: number

models

models: Models

moderations

moderations: Moderations

organization

organization: null | string

project

project: null | string

responses

responses: OpenAIClient.Responses

timeout

timeout: number

uploads

uploads: Uploads

vectorStores

vectorStores: VectorStores

webhookSecret

webhookSecret: null | string

webhooks

webhooks: Webhooks

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

StaticInvalidWebhookSignatureError

InvalidWebhookSignatureError: typeof InvalidWebhookSignatureError

StaticNotFoundError

NotFoundError: typeof NotFoundError

StaticOpenAI

OpenAI: typeof OpenAIClient

StaticOpenAIError

OpenAIError: typeof OpenAIError

StaticPermissionDeniedError

PermissionDeniedError: typeof PermissionDeniedError

StaticRateLimitError

RateLimitError: typeof RateLimitError

StaticUnprocessableEntityError

UnprocessableEntityError: typeof UnprocessableEntityError

StatictoFile

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

Type declaration

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

    • 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<File>

      a File with the given properties

Methods

ProtectedauthHeaders

  • authHeaders(opts): Promise<undefined | NullableHeaders>

  • Parameters

    • opts: FinalRequestOptions

    Returns Promise<undefined | NullableHeaders>

buildRequest

  • buildRequest(inputOptions, __namedParameters?): Promise<{
        req: FinalizedRequestInit;
        timeout: number;
        url: string;
    }>

  • Parameters

    • inputOptions: FinalRequestOptions
    • Optional__namedParameters: {
          retryCount?: number;
      }
      • OptionalretryCount?: number

    Returns Promise<{
        req: FinalizedRequestInit;
        timeout: number;
        url: string;
    }>

buildURL

  • buildURL(path, query, defaultBaseURL?): string

  • Parameters

    • path: string
    • query: undefined | null | Record<string, unknown>
    • OptionaldefaultBaseURL: string

    Returns string

ProtecteddefaultIdempotencyKey

  • defaultIdempotencyKey(): string

  • Returns string

ProtecteddefaultQuery

  • defaultQuery(): undefined | Record<string, undefined | string>

  • Returns undefined | Record<string, undefined | string>

delete

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

  • Type Parameters

    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions>

    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<Rsp>(path, opts?): APIPromise<Rsp>

  • Type Parameters

    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions>

    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

    Returns PagePromise<PageClass, Item>

ProtectedmakeStatusError

  • makeStatusError(status, error, message, headers): APIError<undefined | number, undefined | Headers, undefined | Object>

  • Parameters

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

    Returns APIError<undefined | number, undefined | Headers, undefined | Object>

patch

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

  • Type Parameters

    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions>

    Returns APIPromise<Rsp>

post

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

  • Type Parameters

    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions>

    Returns APIPromise<Rsp>

ProtectedprepareOptions

  • prepareOptions(options): Promise<void>

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

    Parameters

    • options: FinalRequestOptions

    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;
          url: string;
      }
      • options: FinalRequestOptions
      • url: string

    Returns Promise<void>

put

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

  • Type Parameters

    • Rsp

    Parameters

    • path: string
    • Optionalopts: PromiseOrValue<RequestOptions>

    Returns APIPromise<Rsp>

request

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

  • Type Parameters

    • Rsp

    Parameters

    • options: PromiseOrValue<FinalRequestOptions>
    • 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: OpenAIClient, response: Response, body: unknown, options: FinalRequestOptions]) => PageClass)
        • new (...args): PageClass

        • Parameters

          • Rest...args: [client: OpenAIClient, response: Response, body: unknown, options: FinalRequestOptions]

          Returns PageClass

    • options: FinalRequestOptions

    Returns PagePromise<PageClass, Item>

ProtectedstringifyQuery

  • stringifyQuery(query): string

  • Parameters

    • query: Record<string, unknown>

    Returns string

ProtectedvalidateHeaders

  • validateHeaders(__namedParameters): void

  • Parameters

    • __namedParameters: NullableHeaders

    Returns void

withOptions

  • withOptions(options): this

  • Create a new client instance re-using the same options given to the current client with optional overriding.

    Parameters

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods