AxAIService
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L464
Type Parameters
Type Parameter | Default type |
---|---|
TModel | unknown |
TEmbedModel | unknown |
TModelKey | string |
Methods
chat()
chat(req: Readonly<AxChatRequest<TModel | TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<
| AxChatResponse
| ReadableStream<AxChatResponse>>;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L480
Parameters
Parameter | Type |
---|---|
req | Readonly <AxChatRequest <TModel | TModelKey >> |
options? | Readonly <AxAIServiceOptions > |
Returns
Promise
<
| AxChatResponse
| ReadableStream
<AxChatResponse
>>
embed()
embed(req: Readonly<AxEmbedRequest<TEmbedModel | TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<AxEmbedResponse>;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L484
Parameters
Parameter | Type |
---|---|
req | Readonly <AxEmbedRequest <TEmbedModel | TModelKey >> |
options? | Readonly <AxAIServiceOptions > |
Returns
Promise
<AxEmbedResponse
>
getFeatures()
getFeatures(model?: TModel): AxAIFeatures;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L471
Parameters
Parameter | Type |
---|---|
model? | TModel |
Returns
getId()
getId(): string;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L469
Returns
string
getLastUsedChatModel()
getLastUsedChatModel(): undefined | TModel;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L476
Returns
undefined
| TModel
getLastUsedEmbedModel()
getLastUsedEmbedModel(): undefined | TEmbedModel;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L477
Returns
undefined
| TEmbedModel
getLastUsedModelConfig()
getLastUsedModelConfig(): undefined | AxModelConfig;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L478
Returns
undefined
| AxModelConfig
getLogger()
getLogger(): AxLoggerFunction;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L474
Returns
getMetrics()
getMetrics(): AxAIServiceMetrics;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L473
Returns
getModelList()
getModelList():
| undefined
| AxAIModelList<TModelKey>;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L472
Returns
| undefined
| AxAIModelList
<TModelKey
>
getName()
getName(): string;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L470
Returns
string
getOptions()
getOptions(): Readonly<AxAIServiceOptions>;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L490
Returns
Readonly
<AxAIServiceOptions
>
setOptions()
setOptions(options: Readonly<AxAIServiceOptions>): void;
Defined in: https://github.com/ax-llm/ax/blob/8dfd0ce02b8cb386fb2c93fa280a2ec0da2d6011/src/ax/ai/types.ts#L489
Parameters
Parameter | Type |
---|---|
options | Readonly <AxAIServiceOptions > |
Returns
void