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

AxAITypesafeArgs

TypeScript
type AxAITypesafeArgs<TModelKey> = object;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L31

Typesafe evaluates typed questions; it does not generate freeform text.

Type Parameters

Type ParameterDefault type
TModelKeystring

Properties

apiKey?

TypeScript
optional apiKey: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L33


apiURL?

TypeScript
optional apiURL: string;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L35


config?

TypeScript
optional config: object;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L36

model?

TypeScript
optional model: string;

credentialProvider?

TypeScript
optional credentialProvider: AxAICredentialProvider;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L34


modelInfo?

TypeScript
optional modelInfo: AxModelInfo[];

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L39


models?

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

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L38


name

TypeScript
name: "typesafe";

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L32


options?

TypeScript
optional options: Readonly<AxAIServiceOptions>;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L37


trueThreshold?

TypeScript
optional trueThreshold: number;

Defined in: https://github.com/ax-llm/ax/blob/e690b4823b8309e258594064abe941d4cff6ef89/src/ax/ai/typesafe/api.ts#L41

Convert a Noul probability to true at or above this value. Default: 0.5.

Docs