AxAICohere

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/cohere/api.ts#L357

Main Cohere AI service class that extends the base AI implementation

Extends

AxBaseAI<AxAICohereModel, AxAICohereEmbedModel, AxAICohereChatRequest, AxAICohereEmbedRequest, AxAICohereChatResponse, AxAICohereChatResponseDelta, AxAICohereEmbedResponse, TModelKey>

Type Parameters

Type Parameter	Description
`TModelKey`	The type of model keys supported

Constructors

Constructor

new AxAICohere<TModelKey>(args: Readonly<Omit<AxAICohereArgs<TModelKey>, "name">>): AxAICohere<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/cohere/api.ts#L371

Creates a new instance of AxAICohere

Parameters

Parameter	Type	Description
`args`	`Readonly`<`Omit`<`AxAICohereArgs`<`TModelKey`>, `"name"`>>	Configuration arguments including API key, config, options, and models

Returns

AxAICohere<TModelKey>

Overrides

AxBaseAI.constructor

Accessors

debug

Get Signature

get debug(): boolean;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L281

Returns

boolean

Inherited from

AxBaseAI.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/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L873

Parameters

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

Returns

Promise< | AxChatResponse | ReadableStream<AxChatResponse>>

Inherited from

AxBaseAI.chat

embed()

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

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L1379

Parameters

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

Returns

Promise<AxEmbedResponse>

Inherited from

AxBaseAI.embed

getFeatures()

getFeatures(model?: AxAICohereModel): AxAIFeatures;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L348

Parameters

Parameter	Type
`model?`	`AxAICohereModel`

Returns

AxAIFeatures

Inherited from

AxBaseAI.getFeatures

getId()

getId(): string;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L269

Returns

string

Inherited from

AxBaseAI.getId

getLastUsedChatModel()

getLastUsedChatModel(): undefined | AxAICohereModel;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L354

Returns

undefined | AxAICohereModel

Inherited from

AxBaseAI.getLastUsedChatModel

getLastUsedEmbedModel()

getLastUsedEmbedModel(): 
  | undefined
  | AxAICohereEmbedModel;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L358

Returns

| undefined | AxAICohereEmbedModel

Inherited from

AxBaseAI.getLastUsedEmbedModel

getLastUsedModelConfig()

getLastUsedModelConfig(): undefined | AxModelConfig;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L362

Returns

undefined | AxModelConfig

Inherited from

AxBaseAI.getLastUsedModelConfig

getLogger()

getLogger(): AxLoggerFunction;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L313

Returns

AxLoggerFunction

Inherited from

AxBaseAI.getLogger

getMetrics()

getMetrics(): AxAIServiceMetrics;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L869

Returns

AxAIServiceMetrics

Inherited from

AxBaseAI.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/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L317

Returns

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

Inherited from

AxBaseAI.getModelList

getName()

getName(): string;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L344

Returns

string

Inherited from

AxBaseAI.getName

getOptions()

getOptions(): Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L298

Returns

Readonly<AxAIServiceOptions>

Inherited from

AxBaseAI.getOptions

setAPIURL()

setAPIURL(apiURL: string): void;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L273

Parameters

Parameter	Type
`apiURL`	`string`

Returns

void

Inherited from

AxBaseAI.setAPIURL

setHeaders()

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

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L277

Parameters

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

Returns

void

Inherited from

AxBaseAI.setHeaders

setName()

setName(name: string): void;

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L265

Parameters

Parameter	Type
`name`	`string`

Returns

void

Inherited from

AxBaseAI.setName

setOptions()

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

Defined in: https://github.com/ax-llm/ax/blob/b50783a160295ce34ac10dcaf3bd8fff4a01d535/src/ax/ai/base.ts#L285

Parameters

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

Returns

void

Inherited from

AxBaseAI.setOptions