AxAIOpenAI

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/openai/api.ts#L716

Extends

AxAIOpenAIBase<AxAIOpenAIModel, AxAIOpenAIEmbedModel, TModelKey>

Type Parameters

Type Parameter	Default type
`TModelKey`	`string`

Constructors

Constructor

new AxAIOpenAI<TModelKey>(__namedParameters: Readonly<Omit<AxAIOpenAIArgs<"openai", AxAIOpenAIModel, AxAIOpenAIEmbedModel, TModelKey>, "name">>): AxAIOpenAI<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/openai/api.ts#L721

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIOpenAIArgs`<`"openai"`, `AxAIOpenAIModel`, `AxAIOpenAIEmbedModel`, `TModelKey`>, `"name"`>>

Returns

AxAIOpenAI<TModelKey>

Overrides

AxAIOpenAIBase.constructor

Accessors

debug

Get Signature

get debug(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L410

Returns

boolean

Inherited from

AxAIOpenAIBase.debug

Methods

chat()

chat(req: Readonly<AxChatRequest<TModel | TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L1123

Parameters

Parameter	Type
`req`	`Readonly`<`AxChatRequest`<`TModel` \| `TModelKey`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAIBase.chat

embed()

embed(req: Readonly<AxEmbedRequest<TEmbedModel>>, options?: Readonly<AxAIServiceOptions>): Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L1668

Parameters

Parameter	Type
`req`	`Readonly`<`AxEmbedRequest`<`TEmbedModel`>>
`options?`	`Readonly`<`AxAIServiceOptions`>

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAIBase.embed

getFeatures()

getFeatures(model?: AxAIOpenAIModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L495

Parameters

Parameter	Type
`model?`	`AxAIOpenAIModel`

Returns

AxAIFeatures

Inherited from

AxAIOpenAIBase.getFeatures

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L398

Returns

string

Inherited from

AxAIOpenAIBase.getId

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAIOpenAIModel;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L501

Returns

undefined | AxAIOpenAIModel

Inherited from

AxAIOpenAIBase.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAIOpenAIEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L505

Returns

| undefined | AxAIOpenAIEmbedModel

Inherited from

AxAIOpenAIBase.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L509

Returns

undefined | AxModelConfig

Inherited from

AxAIOpenAIBase.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L449

Returns

AxLoggerFunction

Inherited from

AxAIOpenAIBase.getLogger

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L1119

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAIBase.getMetrics

getModelList()

getModelList(): (
  | {
  description: string;
  embedModel?: undefined;
  key: TModelKey;
  model: string;
}
  | {
  description: string;
  embedModel: string;
  key: TModelKey;
  model?: undefined;
})[];

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L464

Returns

( | { description: string; embedModel?: undefined; key: TModelKey; model: string; } | { description: string; embedModel: string; key: TModelKey; model?: undefined; })[]

Inherited from

AxAIOpenAIBase.getModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L491

Returns

string

Inherited from

AxAIOpenAIBase.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L431

Returns

Readonly<AxAIServiceOptions>

Inherited from

AxAIOpenAIBase.getOptions

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L402

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

AxAIOpenAIBase.setAPIURL

setHeaders()

setHeaders(headers: () => Promise<Record<string, string>>): void;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L406

Parameters

Parameter	Type
`headers`	() => `Promise`<`Record`<`string`, `string`>>

Returns

void

Inherited from

AxAIOpenAIBase.setHeaders

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L394

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

AxAIOpenAIBase.setName

setOptions()

setOptions(options: Readonly<AxAIServiceOptions>): void;

Defined in: https://github.com/ax-llm/ax/blob/242cf18d21de9f9d58c7c82f53305f0605497473/src/ax/ai/base.ts#L414

Parameters

Parameter	Type
`options`	`Readonly`<`AxAIServiceOptions`>

Returns

void

Inherited from

AxAIOpenAIBase.setOptions