Class: AzureOpenAI
Hierarchy
-
OpenAI
↳
AzureOpenAI
Constructors
constructor
• new AzureOpenAI(«destructured»?
): AzureOpenAI
API Client for interfacing with the OpenAI API.
Parameters
Name | Type |
---|---|
«destructured» | ClientOptions |
Returns
Inherited from
OrigOpenAI.constructor
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:96
Properties
apiKey
• apiKey: string
Inherited from
OrigOpenAI.apiKey
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:77
audio
• audio: Audio
Inherited from
OrigOpenAI.audio
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:102
baseURL
• baseURL: string
Inherited from
OrigOpenAI.baseURL
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:62
batches
• batches: Batches
Inherited from
OrigOpenAI.batches
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:107
beta
• beta: Beta
Inherited from
OrigOpenAI.beta
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:106
chat
• chat: Chat
Inherited from
OrigOpenAI.chat
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:98
completions
• completions: Completions
Inherited from
OrigOpenAI.completions
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:97
embeddings
• embeddings: Embeddings
Inherited from
OrigOpenAI.embeddings
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:99
files
• files: Files
Inherited from
OrigOpenAI.files
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:100
fineTuning
• fineTuning: FineTuning
Inherited from
OrigOpenAI.fineTuning
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:105
httpAgent
• httpAgent: undefined
| Agent
Inherited from
OrigOpenAI.httpAgent
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:65
idempotencyHeader
• Protected
Optional
idempotencyHeader: string
Inherited from
OrigOpenAI.idempotencyHeader
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:67
images
• images: Images
Inherited from
OrigOpenAI.images
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:101
maxRetries
• maxRetries: number
Inherited from
OrigOpenAI.maxRetries
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:63
models
• models: Models
Inherited from
OrigOpenAI.models
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:104
moderations
• moderations: Moderations
Inherited from
OrigOpenAI.moderations
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:103
organization
• organization: null
| string
Inherited from
OrigOpenAI.organization
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:78
project
• project: null
| string
Inherited from
OrigOpenAI.project
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:79
timeout
• timeout: number
Inherited from
OrigOpenAI.timeout
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:64
APIConnectionError
▪ Static
APIConnectionError: typeof APIConnectionError
Inherited from
OrigOpenAI.APIConnectionError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:114
APIConnectionTimeoutError
▪ Static
APIConnectionTimeoutError: typeof APIConnectionTimeoutError
Inherited from
OrigOpenAI.APIConnectionTimeoutError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:115
APIError
▪ Static
APIError: typeof APIError
Inherited from
OrigOpenAI.APIError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:113
APIUserAbortError
▪ Static
APIUserAbortError: typeof APIUserAbortError
Inherited from
OrigOpenAI.APIUserAbortError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:116
AuthenticationError
▪ Static
AuthenticationError: typeof AuthenticationError
Inherited from
OrigOpenAI.AuthenticationError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:121
BadRequestError
▪ Static
BadRequestError: typeof BadRequestError
Inherited from
OrigOpenAI.BadRequestError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:120
ConflictError
▪ Static
ConflictError: typeof ConflictError
Inherited from
OrigOpenAI.ConflictError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:118
InternalServerError
▪ Static
InternalServerError: typeof InternalServerError
Inherited from
OrigOpenAI.InternalServerError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:122
NotFoundError
▪ Static
NotFoundError: typeof NotFoundError
Inherited from
OrigOpenAI.NotFoundError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:117
OpenAI
▪ Static
OpenAI: typeof OpenAI
Inherited from
OrigOpenAI.OpenAI
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:111
OpenAIError
▪ Static
OpenAIError: typeof OpenAIError
Inherited from
OrigOpenAI.OpenAIError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:112
PermissionDeniedError
▪ Static
PermissionDeniedError: typeof PermissionDeniedError
Inherited from
OrigOpenAI.PermissionDeniedError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:123
RateLimitError
▪ Static
RateLimitError: typeof RateLimitError
Inherited from
OrigOpenAI.RateLimitError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:119
UnprocessableEntityError
▪ Static
UnprocessableEntityError: typeof UnprocessableEntityError
Inherited from
OrigOpenAI.UnprocessableEntityError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:124
fileFromPath
▪ Static
fileFromPath: (path
: string
, options?
: FileFromPathOptions
) => Promise
<File
>(path
: string
, filename?
: string
, options?
: FileFromPathOptions
) => Promise
<File
>
Type declaration
▸ (path
, options?
): Promise
<File
>
Parameters
Name | Type |
---|---|
path | string |
options? | FileFromPathOptions |
Returns
Promise
<File
>
▸ (path
, filename?
, options?
): Promise
<File
>
Parameters
Name | Type |
---|---|
path | string |
filename? | string |
options? | FileFromPathOptions |
Returns
Promise
<File
>
Inherited from
OrigOpenAI.fileFromPath
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:126
toFile
▪ Static
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
Name | Type | Description |
---|---|---|
value | ToFileInput | PromiseLike <ToFileInput > | the raw content of the file. Can be an Uploadable, BlobLikePart, or AsyncIterable of BlobLikeParts |
name? | null | string | the name of the file. If omitted, toFile will try to determine a file name from bits if possible |
options? | FilePropertyBag | additional properties |
Returns
Promise
<FileLike
>
a File with the given properties
Inherited from
OrigOpenAI.toFile
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:125
Methods
authHeaders
▸ authHeaders(): Object
Returns
Object
Name | Type |
---|---|
api-key | string |
Overrides
OrigOpenAI.authHeaders
Defined in
packages/core/src/llm/openai.ts:47
buildRequest
▸ buildRequest<Req
>(options
): Object
Type parameters
Name |
---|
Req |
Parameters
Name | Type |
---|---|
options | FinalRequestOptions <Req > |
Returns
Object
Name | Type |
---|---|
req | RequestInit |
timeout | number |
url | string |
Inherited from
OrigOpenAI.buildRequest
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:100
buildURL
▸ buildURL<Req
>(path
, query
): string
Type parameters
Name |
---|
Req |
Parameters
Name | Type |
---|---|
path | string |
query | undefined | null | Req |
Returns
string
Inherited from
OrigOpenAI.buildURL
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:125
defaultHeaders
▸ defaultHeaders(opts
): Headers
Parameters
Name | Type |
---|---|
opts | FinalRequestOptions <unknown > |
Returns
Headers
Inherited from
OrigOpenAI.defaultHeaders
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:109
defaultIdempotencyKey
▸ defaultIdempotencyKey(): string
Returns
string
Inherited from
OrigOpenAI.defaultIdempotencyKey
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:91
defaultQuery
▸ defaultQuery(): undefined
| DefaultQuery
Returns
undefined
| DefaultQuery
Inherited from
OrigOpenAI.defaultQuery
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/index.d.mts:108
delete
▸ delete<Req
, Rsp
>(path
, opts?
): APIPromise
<Rsp
>
Type parameters
Name |
---|
Req |
Rsp |
Parameters
Name | Type |
---|---|
path | string |
opts? | PromiseOrValue <RequestOptions <Req >> |
Returns
APIPromise
<Rsp
>
Inherited from
OrigOpenAI.delete
Defined in
node_modules/.pnpm/openai@4.38.5/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
>
Inherited from
OrigOpenAI.fetchWithTimeout
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:127
get
▸ get<Req
, Rsp
>(path
, opts?
): APIPromise
<Rsp
>
Type parameters
Name |
---|
Req |
Rsp |
Parameters
Name | Type |
---|---|
path | string |
opts? | PromiseOrValue <RequestOptions <Req >> |
Returns
APIPromise
<Rsp
>
Inherited from
OrigOpenAI.get
Defined in
node_modules/.pnpm/openai@4.38.5/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
>
Inherited from
OrigOpenAI.getAPIList
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:98
getRequestClient
▸ getRequestClient(): RequestClient
Returns
RequestClient
Inherited from
OrigOpenAI.getRequestClient
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:128
makeStatusError
▸ makeStatusError(status
, error
, message
, headers
): APIError
Parameters
Name | Type |
---|---|
status | undefined | number |
error | undefined | Object |
message | undefined | string |
headers | undefined | Headers |
Returns
APIError
Inherited from
OrigOpenAI.makeStatusError
Defined in
node_modules/.pnpm/openai@4.38.5/node_modules/openai/core.d.ts:121
parseHeaders
▸ parseHeaders(headers
): Record
<string
, string
>
Parameters
Name | Type |
---|---|
headers | undefined | null | HeadersInit |