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
OpenAI.constructor
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:90
Properties
apiKey
• apiKey: string
Inherited from
OpenAI.apiKey
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:73
audio
• audio: Audio
Inherited from
OpenAI.audio
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:96
baseURL
• baseURL: string
Inherited from
OpenAI.baseURL
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:62
beta
• beta: Beta
Inherited from
OpenAI.beta
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:100
chat
• chat: Chat
Inherited from
OpenAI.chat
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:92
completions
• completions: Completions
Inherited from
OpenAI.completions
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:91
embeddings
• embeddings: Embeddings
Inherited from
OpenAI.embeddings
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:93
files
• files: Files
Inherited from
OpenAI.files
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:94
fineTuning
• fineTuning: FineTuning
Inherited from
OpenAI.fineTuning
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:99
httpAgent
• httpAgent: any
Inherited from
OpenAI.httpAgent
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:65
idempotencyHeader
• Protected
Optional
idempotencyHeader: string
Inherited from
OpenAI.idempotencyHeader
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:67
images
• images: Images
Inherited from
OpenAI.images
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:95
maxRetries
• maxRetries: number
Inherited from
OpenAI.maxRetries
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:63
models
• models: Models
Inherited from
OpenAI.models
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:98
moderations
• moderations: Moderations
Inherited from
OpenAI.moderations
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:97
organization
• organization: null
| string
Inherited from
OpenAI.organization
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:74
timeout
• timeout: number
Inherited from
OpenAI.timeout
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:64
APIConnectionError
▪ Static
APIConnectionError: typeof APIConnectionError
Inherited from
OpenAI.APIConnectionError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:107
APIConnectionTimeoutError
▪ Static
APIConnectionTimeoutError: typeof APIConnectionTimeoutError
Inherited from
OpenAI.APIConnectionTimeoutError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:108
APIError
▪ Static
APIError: typeof APIError
Inherited from
OpenAI.APIError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:106
APIUserAbortError
▪ Static
APIUserAbortError: typeof APIUserAbortError
Inherited from
OpenAI.APIUserAbortError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:109
AuthenticationError
▪ Static
AuthenticationError: typeof AuthenticationError
Inherited from
OpenAI.AuthenticationError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:114
BadRequestError
▪ Static
BadRequestError: typeof BadRequestError
Inherited from
OpenAI.BadRequestError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:113
ConflictError
▪ Static
ConflictError: typeof ConflictError
Inherited from
OpenAI.ConflictError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:111
InternalServerError
▪ Static
InternalServerError: typeof InternalServerError
Inherited from
OpenAI.InternalServerError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:115
NotFoundError
▪ Static
NotFoundError: typeof NotFoundError
Inherited from
OpenAI.NotFoundError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:110
OpenAI
▪ Static
OpenAI: typeof OpenAI
Inherited from
OpenAI.OpenAI
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:104
OpenAIError
▪ Static
OpenAIError: typeof OpenAIError
Inherited from
OpenAI.OpenAIError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:105
PermissionDeniedError
▪ Static
PermissionDeniedError: typeof PermissionDeniedError
Inherited from
OpenAI.PermissionDeniedError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:116
RateLimitError
▪ Static
RateLimitError: typeof RateLimitError
Inherited from
OpenAI.RateLimitError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:112
UnprocessableEntityError
▪ Static
UnprocessableEntityError: typeof UnprocessableEntityError
Inherited from
OpenAI.UnprocessableEntityError
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:117
Methods
authHeaders
▸ authHeaders(): Object
Returns
Object
Name | Type |
---|---|
api-key | string |
Overrides
OpenAI.authHeaders
Defined in
packages/core/src/llm/open_ai.ts:5
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
OpenAI.buildRequest
Defined in
node_modules/.pnpm/openai@4.26.1/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
OpenAI.buildURL
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:125
defaultHeaders
▸ defaultHeaders(opts
): Headers
Parameters
Name | Type |
---|---|
opts | FinalRequestOptions <unknown > |
Returns
Headers
Inherited from
OpenAI.defaultHeaders
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:102
defaultIdempotencyKey
▸ defaultIdempotencyKey(): string
Returns
string
Inherited from
OpenAI.defaultIdempotencyKey
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/core.d.ts:91
defaultQuery
▸ defaultQuery(): undefined
| DefaultQuery
Returns
undefined
| DefaultQuery
Inherited from
OpenAI.defaultQuery
Defined in
node_modules/.pnpm/openai@4.26.1/node_modules/openai/index.d.ts:101