AxAI
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L133
Type Parameters
Type Parameter | Default type |
---|---|
TModelKey | string |
Implements
AxAIService
<any
,any
,TModelKey
>
Constructors
Constructor
new AxAI<TModelKey>(options: Readonly<AxAIArgs<TModelKey>>): AxAI<TModelKey>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L161
Deprecated
Use AxAI.create()
or ai()
function instead for better type safety.
This constructor will be removed in v15.0.0.
Migration timeline:
- v13.0.24+: Deprecation warnings (current)
- v14.0.0: Runtime console warnings
- v15.0.0: Complete removal
Example
// Instead of: new AxAI({ name: 'openai', apiKey: '...' })
// Use: AxAI.create({ name: 'openai', apiKey: '...' })
// Or: ai({ name: 'openai', apiKey: '...' })
Parameters
Parameter | Type |
---|---|
options | Readonly <AxAIArgs <TModelKey >> |
Returns
AxAI
<TModelKey
>
Methods
chat()
chat(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<
| AxChatResponse
| ReadableStream<AxChatResponse>>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L245
Parameters
Parameter | Type |
---|---|
req | Readonly <AxChatRequest <TModelKey >> |
options? | Readonly <AxAIServiceOptions > |
Returns
Promise
<
| AxChatResponse
| ReadableStream
<AxChatResponse
>>
Implementation of
embed()
embed(req: Readonly<AxEmbedRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxEmbedResponse>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L252
Parameters
Parameter | Type |
---|---|
req | Readonly <AxEmbedRequest <TModelKey >> |
options? | Readonly <AxAIServiceOptions > |
Returns
Promise
<AxEmbedResponse
>
Implementation of
getFeatures()
getFeatures(model?: string): AxAIFeatures;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L221
Parameters
Parameter | Type |
---|---|
model? | string |
Returns
Implementation of
getId()
getId(): string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L217
Returns
string
Implementation of
getLastUsedChatModel()
getLastUsedChatModel(): any;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L229
Returns
any
Implementation of
AxAIService
.getLastUsedChatModel
getLastUsedEmbedModel()
getLastUsedEmbedModel(): any;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L233
Returns
any
Implementation of
AxAIService
.getLastUsedEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig(): undefined | AxModelConfig;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L237
Returns
undefined
| AxModelConfig
Implementation of
AxAIService
.getLastUsedModelConfig
getLogger()
getLogger(): AxLoggerFunction;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L267
Returns
Implementation of
getMetrics()
getMetrics(): AxAIServiceMetrics;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L241
Returns
Implementation of
getModelList()
getModelList():
| undefined
| AxAIModelList<TModelKey>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L225
Returns
| undefined
| AxAIModelList
<TModelKey
>
Implementation of
getName()
getName(): string;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L213
Returns
string
Implementation of
getOptions()
getOptions(): Readonly<AxAIServiceOptions>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L263
Returns
Readonly
<AxAIServiceOptions
>
Implementation of
setOptions()
setOptions(options: Readonly<AxAIServiceOptions>): void;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L259
Parameters
Parameter | Type |
---|---|
options | Readonly <AxAIServiceOptions > |
Returns
void
Implementation of
create()
static create<T>(options: T): AxAI<InferTModelKey<T>>;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/wrap.ts#L139
Type Parameters
Type Parameter |
---|
T extends AxAIArgs <any > |
Parameters
Parameter | Type |
---|---|
options | T |
Returns
AxAI
<InferTModelKey
<T
>>