Skip to content
Ax

AxAIAzureOpenAI

Class: AxAIAzureOpenAI

Extends

Constructors

new AxAIAzureOpenAI()

new AxAIAzureOpenAI(__namedParameters): AxAIAzureOpenAI

Parameters

• __namedParameters: Readonly<Omit<AxAIAzureOpenAIArgs, "name">>

Returns

AxAIAzureOpenAI

Overrides

AxAIOpenAI.constructor

Defined in

src/ax/ai/azure-openai/api.ts:35

Properties

apiURL

protected apiURL: string

Inherited from

AxAIOpenAI.apiURL

Defined in

src/ax/ai/base.ts:95

headers

protected headers: Record<string, string>

Inherited from

AxAIOpenAI.headers

Defined in

src/ax/ai/base.ts:97

name

protected name: string

Inherited from

AxAIOpenAI.name

Defined in

src/ax/ai/base.ts:96

supportFor

protected supportFor: AxBaseAIFeatures | (model) => AxBaseAIFeatures

Inherited from

AxAIOpenAI.supportFor

Defined in

src/ax/ai/base.ts:98

Methods

_chat()

_chat(model, chatReq, options?, span?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Parameters

• model: string

• chatReq: Readonly<AxChatRequest>

• options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

• span?: AxSpan

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI._chat

Defined in

src/ax/ai/base.ts:254

_embed()

_embed(embedModel, embedReq, options?, span?): Promise<AxEmbedResponse>

Parameters

• embedModel: string

• embedReq: Readonly<AxEmbedRequest>

• options?: Readonly<AxAIServiceActionOptions>

• span?: AxSpan

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI._embed

Defined in

src/ax/ai/base.ts:400

chat()

chat(req, options?): Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Parameters

• req: Readonly<AxChatRequest>

• options?: Readonly<AxAIPromptConfig & AxAIServiceActionOptions>

Returns

Promise<AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAI.chat

Defined in

src/ax/ai/base.ts:212

embed()

embed(req, options?): Promise<AxEmbedResponse>

Parameters

• req: Readonly<AxEmbedRequest>

• options?: Readonly<AxAIServiceActionOptions>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAI.embed

Defined in

src/ax/ai/base.ts:367

generateChatReq()

generateChatReq(req, _config): [API, AxAIOpenAIChatRequest]

Parameters

• req: Readonly<AxInternalChatRequest>

• _config: Readonly<AxAIPromptConfig>

Returns

[API, AxAIOpenAIChatRequest]

Inherited from

AxAIOpenAI.generateChatReq

Defined in

src/ax/ai/openai/api.ts:129

generateChatResp()

generateChatResp(resp): AxChatResponse

Parameters

• resp: Readonly<AxAIOpenAIChatResponse>

Returns

AxChatResponse

Inherited from

AxAIOpenAI.generateChatResp

Defined in

src/ax/ai/openai/api.ts:224

generateChatStreamResp()

generateChatStreamResp(resp, state): AxChatResponse

Parameters

• resp: Readonly<AxAIOpenAIChatResponseDelta>

• state: object

Returns

AxChatResponse

Inherited from

AxAIOpenAI.generateChatStreamResp

Defined in

src/ax/ai/openai/api.ts:267

generateEmbedReq()

generateEmbedReq(req): [API, AxAIOpenAIEmbedRequest]

Parameters

• req: Readonly<AxInternalEmbedRequest>

Returns

[API, AxAIOpenAIEmbedRequest]

Inherited from

AxAIOpenAI.generateEmbedReq

Defined in

src/ax/ai/openai/api.ts:198

generateEmbedResp()

generateEmbedResp(resp): AxEmbedResponse

Parameters

• resp: Readonly<AxAIOpenAIEmbedResponse>

Returns

AxEmbedResponse

Inherited from

AxAIOpenAI.generateEmbedResp

Defined in

src/ax/ai/openai/api.ts:333

getEmbedModelInfo()

getEmbedModelInfo(): undefined | AxModelInfoWithProvider

Returns

undefined | AxModelInfoWithProvider

Inherited from

AxAIOpenAI.getEmbedModelInfo

Defined in

src/ax/ai/base.ts:185

getFeatures()

getFeatures(model?): AxBaseAIFeatures

Parameters

• model?: string

Returns

AxBaseAIFeatures

Inherited from

AxAIOpenAI.getFeatures

Defined in

src/ax/ai/base.ts:202

getModelConfig()

getModelConfig(): AxModelConfig

Returns

AxModelConfig

Inherited from

AxAIOpenAI.getModelConfig

Defined in

src/ax/ai/openai/api.ts:115

getModelInfo()

getModelInfo(): Readonly<AxModelInfoWithProvider>

Returns

Readonly<AxModelInfoWithProvider>

Inherited from

AxAIOpenAI.getModelInfo

Defined in

src/ax/ai/base.ts:178

getModelMap()

getModelMap(): undefined | AxAIModelMap

Returns

undefined | AxAIModelMap

Inherited from

AxAIOpenAI.getModelMap

Defined in

src/ax/ai/base.ts:194

getName()

getName(): string

Returns

string

Inherited from

AxAIOpenAI.getName

Defined in

src/ax/ai/base.ts:198

setAPIURL()

setAPIURL(apiURL): void

Parameters

• apiURL: string

Returns

void

Inherited from

AxAIOpenAI.setAPIURL

Defined in

src/ax/ai/base.ts:139

setHeaders()

setHeaders(headers): void

Parameters

• headers: Record<string, string>

Returns

void

Inherited from

AxAIOpenAI.setHeaders

Defined in

src/ax/ai/base.ts:143

setName()

setName(name): void

Parameters

• name: string

Returns

void

Inherited from

AxAIOpenAI.setName

Defined in

src/ax/ai/base.ts:135

setOptions()

setOptions(options): void

Parameters

• options: Readonly<AxAIServiceOptions>

Returns

void

Inherited from

AxAIOpenAI.setOptions

Defined in

src/ax/ai/base.ts:147