AxAIProfileArgs Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxAIProfileArgs.md type AxAIProfileArgs

AxAIProfileArgs

TypeScript

type AxAIProfileArgs<TModelKey> = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L870

Type Parameters

Type Parameter	Default type
`TModelKey`	`string`

Properties

apiKey?

TypeScript

optional apiKey: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L872

apiURL?

TypeScript

optional apiURL: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L874

config?

TypeScript

optional config: Partial<AxAIOpenAIConfig<string, string>>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L875

credentialProvider?

TypeScript

optional credentialProvider: AxAICredentialProvider;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L873

deploymentName?

TypeScript

optional deploymentName: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L880

modelInfo?

TypeScript

optional modelInfo: AxModelInfo[];

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L877

models?

TypeScript

optional models: AxAIInputModelList<string, string, TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L878

name

TypeScript

name: AxAIProfileId;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L871

options?

TypeScript

optional options: Readonly<AxAIServiceOptions> & Record<string, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L876

resourceName?

TypeScript

optional resourceName: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L879

version?

TypeScript

optional version: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/provider_profiles.ts#L881

Docs