AxAIOpenAIResponses

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/responses_api_base.ts#L255

Base class for OpenAI AI services using the /v1/responses API endpoint

Extends

AxAIOpenAIResponsesBase<AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel, TModelKey, AxAIOpenAIResponsesRequest<AxAIOpenAIResponsesModel>>

Type Parameters

Type Parameter	Default type
`TModelKey`	`string`

Constructors

Constructor

TypeScript

new AxAIOpenAIResponses<TModelKey>(__namedParameters: Readonly<Omit<AxAIOpenAIResponsesArgs<"openai-responses", AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel, TModelKey>, "name">>): AxAIOpenAIResponses<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/openai/responses_api_base.ts#L263

Parameters

Parameter	Type
`__namedParameters`	`Readonly`<`Omit`<`AxAIOpenAIResponsesArgs`<`"openai-responses"`, `AxAIOpenAIResponsesModel`, `AxAIOpenAIEmbedModel`, `TModelKey`>, `"name"`>>

Returns

AxAIOpenAIResponses<TModelKey>

Overrides

AxAIOpenAIResponsesBase.constructor

Accessors

debug

Get Signature

TypeScript

get debug(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L744

Returns

boolean

Inherited from

AxAIOpenAIResponsesBase.debug

Methods

chat()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L1494

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxAIOpenAIResponsesBase.chat

embed()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L2158

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

AxAIOpenAIResponsesBase.embed

getEstimatedCost()

TypeScript

getEstimatedCost(modelUsage?: AxModelUsage): number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L1489

Parameters

Parameter	Type
`modelUsage?`	`AxModelUsage`

Returns

number

Inherited from

AxAIOpenAIResponsesBase.getEstimatedCost

getFeatures()

TypeScript

getFeatures(model?: AxAIOpenAIResponsesModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L835

Parameters

Parameter	Type
`model?`	`AxAIOpenAIResponsesModel`

Returns

AxAIFeatures

Inherited from

AxAIOpenAIResponsesBase.getFeatures

getId()

TypeScript

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L732

Returns

string

Inherited from

AxAIOpenAIResponsesBase.getId

getLastUsedChatModel()

TypeScript

getLastUsedChatModel(): 
  | undefined
  | AxAIOpenAIResponsesModel;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L841

Returns

| undefined | AxAIOpenAIResponsesModel

Inherited from

AxAIOpenAIResponsesBase.getLastUsedChatModel

getLastUsedEmbedModel()

TypeScript

getLastUsedEmbedModel(): 
  | undefined
  | AxAIOpenAIEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L845

Returns

| undefined | AxAIOpenAIEmbedModel

Inherited from

AxAIOpenAIResponsesBase.getLastUsedEmbedModel

getLastUsedModelConfig()

TypeScript

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L849

Returns

undefined | AxModelConfig

Inherited from

AxAIOpenAIResponsesBase.getLastUsedModelConfig

getLogger()

TypeScript

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L789

Returns

AxLoggerFunction

Inherited from

AxAIOpenAIResponsesBase.getLogger

getMetrics()

TypeScript

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L1484

Returns

AxAIServiceMetrics

Inherited from

AxAIOpenAIResponsesBase.getMetrics

getModelList()

TypeScript

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/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L804

Returns

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

Inherited from

AxAIOpenAIResponsesBase.getModelList

getName()

TypeScript

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L831

Returns

string

Inherited from

AxAIOpenAIResponsesBase.getName

getOptions()

TypeScript

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L768

Returns

Readonly<AxAIServiceOptions>

Inherited from

AxAIOpenAIResponsesBase.getOptions

setAPIURL()

TypeScript

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L736

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setAPIURL

setHeaders()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L740

Parameters

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

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setHeaders

setName()

TypeScript

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L728

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setName

setOptions()

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L748

Parameters

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

Returns

void

Inherited from

AxAIOpenAIResponsesBase.setOptions

speak()

TypeScript

speak(req: Readonly<AxSpeechRequest<TModel | TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxChatAudioOutput>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L872

Parameters

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

Returns

Promise<AxChatAudioOutput>

Inherited from

AxAIOpenAIResponsesBase.speak

transcribe()

TypeScript

transcribe(req: Readonly<AxTranscriptionRequest<TModel | TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxTranscriptionResponse>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/base.ts#L853

Parameters

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

Returns

Promise<AxTranscriptionResponse>

Inherited from

AxAIOpenAIResponsesBase.transcribe