@ralphschuler.ai function caller.index.<internal>.APIClient

Class: APIClient

index.<internal>.APIClient

Hierarchy

• APIClient

  ↳ OpenAI

  ↳ OpenAI

Table of contents

Constructors

• constructor

Properties

• baseURL
• calculateContentLength
• calculateDefaultRetryTimeoutMillis
• fetch
• getUserAgent
• httpAgent
• idempotencyHeader
• makeRequest
• maxRetries
• methodRequest
• retryRequest
• shouldRetry
• timeout

Methods

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

Constructors

constructor

• new APIClient(«destructured»): APIClient

Parameters

Name	Type
«destructured»	Object
› baseURL	string
› fetch	undefined | Fetch
› httpAgent	undefined | Agent
› maxRetries?	number
› timeout	undefined | number

Returns

APIClient

Defined in

node_modules/openai/core.d.ts:68

Properties

baseURL

• baseURL: string

Defined in

node_modules/openai/core.d.ts:62

---

calculateContentLength

• Private calculateContentLength: any

Defined in

node_modules/openai/core.d.ts:99

---

calculateDefaultRetryTimeoutMillis

• Private calculateDefaultRetryTimeoutMillis: any

Defined in

node_modules/openai/core.d.ts:126

---

fetch

• Private fetch: any

Defined in

node_modules/openai/core.d.ts:66

---

getUserAgent

• Private getUserAgent: any

Defined in

node_modules/openai/core.d.ts:127

---

httpAgent

• httpAgent: undefined | Agent

Defined in

node_modules/openai/core.d.ts:65

---

idempotencyHeader

• Protected Optional idempotencyHeader: string

Defined in

node_modules/openai/core.d.ts:67

---

makeRequest

• Private makeRequest: any

Defined in

node_modules/openai/core.d.ts:118

---

maxRetries

• maxRetries: number

Defined in

node_modules/openai/core.d.ts:63

---

methodRequest

• Private methodRequest: any

Defined in

node_modules/openai/core.d.ts:97

---

retryRequest

• Private retryRequest: any

Defined in

node_modules/openai/core.d.ts:125

---

shouldRetry

• Private shouldRetry: any

Defined in

node_modules/openai/core.d.ts:124

---

timeout

• timeout: number

Defined in

node_modules/openai/core.d.ts:64

Methods

authHeaders

▸ authHeaders(opts): Headers

Parameters

Name	Type
opts	FinalRequestOptions<Readable | Record<string, unknown>>

Returns

Headers

Defined in

node_modules/openai/core.d.ts:76

---

buildRequest

▸ buildRequest<Req>(options): Object

Type parameters

Name	Type
Req	extends Object

Parameters

Name	Type
options	FinalRequestOptions<Req>

Returns

Object

Name	Type
req	RequestInit
timeout	number
url	string

Defined in

node_modules/openai/core.d.ts:100

---

buildURL

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

Type parameters

Name	Type
Req	extends Record<string, unknown>

Parameters

Name	Type
path	string
query	undefined | null | Req

Returns

string

Defined in

node_modules/openai/core.d.ts:120

---

defaultHeaders

▸ defaultHeaders(opts): Headers

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

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

Parameters

Name	Type
opts	FinalRequestOptions<Readable | Record<string, unknown>>

Returns

Headers

Defined in

node_modules/openai/core.d.ts:85

---

defaultIdempotencyKey

▸ defaultIdempotencyKey(): string

Returns

string

Defined in

node_modules/openai/core.d.ts:91

---

defaultQuery

▸ defaultQuery(): undefined | DefaultQuery

Returns

undefined | DefaultQuery

Defined in

node_modules/openai/core.d.ts:86

---

delete

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
path	string
opts?	PromiseOrValue<RequestOptions<Req>>

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:96

---

fetchWithTimeout

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

Parameters

Name	Type
url	RequestInfo
init	undefined | RequestInit
ms	number
controller	AbortController

Returns

Promise<Response>

Defined in

node_modules/openai/core.d.ts:122

---

get

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
path	string
opts?	PromiseOrValue<RequestOptions<Req>>

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:92

---

getAPIList

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

Type parameters

Name	Type
Item	Item
PageClass	extends AbstractPage<Item> = AbstractPage<Item>

Parameters

Name	Type
path	string
Page	(...args: any[]) => PageClass
opts?	RequestOptions<any>

Returns

PagePromise<PageClass, Item>

Defined in

node_modules/openai/core.d.ts:98

---

getRequestClient

▸ getRequestClient(): RequestClient

Returns

RequestClient

Defined in

node_modules/openai/core.d.ts:123

---

makeStatusError

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

Parameters

Name	Type
status	undefined | number
error	undefined | Object
message	undefined | string
headers	undefined | Headers

Returns

APIError

Defined in

node_modules/openai/core.d.ts:116

---

parseHeaders

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

Parameters

Name	Type
headers	undefined | null | HeadersInit

Returns

Record<string, string>

Defined in

node_modules/openai/core.d.ts:115

---

patch

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
path	string
opts?	PromiseOrValue<RequestOptions<Req>>

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:94

---

post

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
path	string
opts?	PromiseOrValue<RequestOptions<Req>>

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:93

---

prepareRequest

▸ prepareRequest(request, «destructured»): 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

Name	Type
request	RequestInit
«destructured»	Object
› options	FinalRequestOptions<Readable | Record<string, unknown>>
› url	string

Returns

Promise<void>

Defined in

node_modules/openai/core.d.ts:111

---

put

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
path	string
opts?	PromiseOrValue<RequestOptions<Req>>

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:95

---

request

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

Type parameters

Name	Type
Req	extends Object
Rsp	Rsp

Parameters

Name	Type
options	PromiseOrValue<FinalRequestOptions<Req>>
remainingRetries?	null | number

Returns

APIPromise<Rsp>

Defined in

node_modules/openai/core.d.ts:117

---

requestAPIList

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

Type parameters

Name	Type
Item	unknown
PageClass	extends AbstractPage<Item> = AbstractPage<Item>

Parameters

Name	Type
Page	(...args: [client: APIClient, response: Response, body: unknown, options: FinalRequestOptions<Readable | Record<string, unknown>>]) => PageClass
options	FinalRequestOptions<Readable | Record<string, unknown>>

Returns

PagePromise<PageClass, Item>

Defined in

node_modules/openai/core.d.ts:119

---

stringifyQuery

▸ stringifyQuery(query): string

Parameters

Name	Type
query	Record<string, unknown>

Returns

string

Defined in

node_modules/openai/core.d.ts:121

---

validateHeaders

▸ validateHeaders(headers, customHeaders): void

Override this to add your own headers validation:

Parameters

Name	Type
headers	Headers
customHeaders	Headers

Returns

void

Defined in

node_modules/openai/core.d.ts:90