ai() API

LLM provider, model, media, routing, and embedding APIs.

Most Used

`ai`

Factory function for creating AI service instances with full type safety.

Field	Value
Kind	`function`
Form	`ai`
Returns	`AxAI`<`InferTModelKey`<`T`>> A configured AI service instance ready for chat completions and embeddings
Source	source

Call Shape

TypeScript

function ai<T>(options: T): AxAI<InferTModelKey<T>>;

Arguments And Options

Name	Type	Description
`options`	`T`	Provider-specific configuration. Must include `name` to identify the provider.

Examples

TypeScript

const ai = ai({
  name: 'openai',
  apiKey: process.env.OPENAI_API_KEY
});

TypeScript

const ai = ai({
  name: 'anthropic',
  apiKey: process.env.ANTHROPIC_API_KEY,
  config: {
    model: 'claude-sonnet-4-20250514',
    maxTokens: 4096,
    temperature: 0.7
  }
});

Full reference

`AxAI`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAI`
Source	source

Call Shape

TypeScript

chat(req: Readonly<AxChatRequest<TModelKey>>, options?: Readonly<AxAIServiceOptions>): Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Full reference

`AxAIAnthropic`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAIAnthropic`
Source	source

Call Shape

TypeScript

new AxAIAnthropic<TModelKey>(__namedParameters: Readonly<Omit<AxAIAnthropicArgs<TModelKey>, "name">>): AxAIAnthropic<TModelKey>;

Full reference

`AxAIGoogleGemini`

TypeScript class exported by @ax-llm/ax. See the constructor, methods, and full reference below.

Field	Value
Kind	`class`
Form	`AxAIGoogleGemini`
Source	source

Call Shape

TypeScript

new AxAIGoogleGemini<TModelKey>(__namedParameters: Readonly<Omit<AxAIGoogleGeminiArgs<TModelKey>, "name">>): AxAIGoogleGemini<TModelKey>;

Full reference

Advanced / internals / full reference

`AxAgentStateExecutorModelState`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAgentStateExecutorModelState`
Source	source

Call Shape

TypeScript

type AxAgentStateExecutorModelState = object;

Full reference

`AxAIAnthropicArgs`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicArgs`
Source	source

Full reference

`AxAIAnthropicChatError`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicChatError`
Source	source

Call Shape

TypeScript

type AxAIAnthropicChatError = object;

Full reference

`AxAIAnthropicChatRequest`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicChatRequest`
Source	source

Call Shape

TypeScript

type AxAIAnthropicChatRequest = object;

Full reference

`AxAIAnthropicChatRequestCacheParam`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicChatRequestCacheParam`
Source	source

Call Shape

TypeScript

type AxAIAnthropicChatRequestCacheParam = object;

Full reference

`AxAIAnthropicChatResponse`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicChatResponse`
Source	source

Call Shape

TypeScript

type AxAIAnthropicChatResponse = object;

Full reference

`AxAIAnthropicChatResponseDelta`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicChatResponseDelta`
Source	source

Call Shape

TypeScript

type AxAIAnthropicChatResponseDelta = 
  | AxAIAnthropicMessageStartEvent
  | AxAIAnthropicContentBlockStartEvent
  | AxAIAnthropicContentBlockDeltaEvent
  | AxAIAnthropicContentBlockStopEvent
  | AxAIAnthropicMessageDeltaEvent
  | AxAIAnthropicMessageStopEvent
  | AxAIAnthropicPingEvent
  | AxAIAnthropicErrorEvent;

Full reference

`AxAIAnthropicConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicConfig`
Source	source

Call Shape

TypeScript

type AxAIAnthropicConfig = AxModelConfig & object;

Full reference

`AxAIAnthropicContentBlockDeltaEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicContentBlockDeltaEvent`
Source	source

Full reference

`AxAIAnthropicContentBlockStartEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicContentBlockStartEvent`
Source	source

Full reference

`AxAIAnthropicContentBlockStopEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicContentBlockStopEvent`
Source	source

Full reference

`axAIAnthropicDefaultConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIAnthropicDefaultConfig`
Returns	`AxAIAnthropicConfig`
Source	source

Call Shape

TypeScript

function axAIAnthropicDefaultConfig(): AxAIAnthropicConfig;

Full reference

`AxAIAnthropicEffortLevel`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicEffortLevel`
Source	source

Call Shape

TypeScript

type AxAIAnthropicEffortLevel = "low" | "medium" | "high" | "xhigh" | "max";

Full reference

`AxAIAnthropicEffortLevelMapping`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicEffortLevelMapping`
Source	source

Call Shape

TypeScript

type AxAIAnthropicEffortLevelMapping = object;

Full reference

`AxAIAnthropicErrorEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicErrorEvent`
Source	source

Full reference

`AxAIAnthropicFunctionTool`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicFunctionTool`
Source	source

Call Shape

TypeScript

type AxAIAnthropicFunctionTool = object & AxAIAnthropicChatRequestCacheParam;

Full reference

`AxAIAnthropicMessageDeltaEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicMessageDeltaEvent`
Source	source

Full reference

`AxAIAnthropicMessageStartEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicMessageStartEvent`
Source	source

Full reference

`AxAIAnthropicMessageStopEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicMessageStopEvent`
Source	source

Full reference

`AxAIAnthropicModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIAnthropicModel`
Source	source

Full reference

`AxAIAnthropicOutputConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicOutputConfig`
Source	source

Call Shape

TypeScript

type AxAIAnthropicOutputConfig = object;

Full reference

`AxAIAnthropicPingEvent`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIAnthropicPingEvent`
Source	source

Full reference

`AxAIAnthropicRequestTool`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicRequestTool`
Source	source

Call Shape

TypeScript

type AxAIAnthropicRequestTool = 
  | AxAIAnthropicFunctionTool
  | AxAIAnthropicWebSearchTool;

Full reference

`AxAIAnthropicStopDetails`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicStopDetails`
Source	source

Call Shape

TypeScript

type AxAIAnthropicStopDetails = object;

Full reference

`AxAIAnthropicTaskBudget`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicTaskBudget`
Source	source

Call Shape

TypeScript

type AxAIAnthropicTaskBudget = object;

Full reference

`AxAIAnthropicThinkingConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicThinkingConfig`
Source	source

Call Shape

TypeScript

type AxAIAnthropicThinkingConfig = object;

Full reference

`AxAIAnthropicThinkingTokenBudgetLevels`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicThinkingTokenBudgetLevels`
Source	source

Call Shape

TypeScript

type AxAIAnthropicThinkingTokenBudgetLevels = object;

Full reference

`AxAIAnthropicThinkingWire`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicThinkingWire`
Source	source

Call Shape

TypeScript

type AxAIAnthropicThinkingWire = 
  | {
  budget_tokens: number;
  type: "enabled";
}
  | {
  display?: "summarized" | "omitted";
  type: "adaptive";
};

Full reference

`axAIAnthropicVertexDefaultConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIAnthropicVertexDefaultConfig`
Returns	`AxAIAnthropicConfig`
Source	source

Call Shape

TypeScript

function axAIAnthropicVertexDefaultConfig(): AxAIAnthropicConfig;

Full reference

`AxAIAnthropicVertexModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIAnthropicVertexModel`
Source	source

Full reference

`AxAIAnthropicWebSearchTool`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIAnthropicWebSearchTool`
Source	source

Call Shape

TypeScript

type AxAIAnthropicWebSearchTool = object;

Full reference

`AxAIArgs`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIArgs`
Source	source

Call Shape

TypeScript

type AxAIArgs<TModelKey> = 
  | AxAIOpenAIArgs<"openai", AxAIOpenAIModel, AxAIOpenAIEmbedModel, TModelKey>
  | AxAIOpenAIResponsesArgs<"openai-responses", AxAIOpenAIResponsesModel, AxAIOpenAIEmbedModel, TModelKey>
  | AxAIAnthropicArgs<TModelKey>
  | AxAIGoogleGeminiArgs<TModelKey>
  | AxAIDeploymentProfileArgs<TModelKey>
| AxAIWebLLMArgs<TModelKey>;

Full reference

`AxAICohereEmbedModel`

Cohere: Models for use in embeddings

Field	Value
Kind	`enumeration`
Form	`AxAICohereEmbedModel`
Source	source

Full reference

`AxAICohereModel`

Cohere: Models for text generation

Field	Value
Kind	`enumeration`
Form	`AxAICohereModel`
Source	source

Full reference

`AxAICredentialProvider`

Supplies fresh authentication headers immediately before each HTTP attempt.

Field	Value
Kind	`typealias`
Form	`AxAICredentialProvider`
Returns	`Promise`<`Record`<`string`, `string`>>
Source	source

Call Shape

TypeScript

type AxAICredentialProvider = (request: AxAICredentialRequest) => Promise<Record<string, string>>;

Arguments And Options

Name	Type	Description
`request`	`AxAICredentialRequest`

Full reference

`AxAICredentialRequest`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAICredentialRequest`
Source	source

Call Shape

TypeScript

type AxAICredentialRequest = Readonly<{
  method: string;
  operation:   | "chat"
     | "stream_chat"
     | "embed"
     | "responses"
     | "transcribe"
     | "speak"
     | "realtime";
  profile: string;
  url: string;
}>;

Full reference

`AxAIDeepSeekModel`

DeepSeek: Models for text generation

Field	Value
Kind	`enumeration`
Form	`AxAIDeepSeekModel`
Source	source

Full reference

`AxAIDeploymentProfileArgs`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIDeploymentProfileArgs`
Source	source

Call Shape

TypeScript

type AxAIDeploymentProfileArgs<TModelKey> = Omit<AxAIProfileArgs<TModelKey>, "name"> & object;

Full reference

`AxAIDeploymentProfileId`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIDeploymentProfileId`
Source	source

Call Shape

TypeScript

type AxAIDeploymentProfileId = Exclude<AxAIProfileId, "openai" | "openai-responses" | "anthropic" | "google-gemini" | "webllm">;

Full reference

`AxAIEmbedModels`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIEmbedModels`
Source	source

Call Shape

TypeScript

type AxAIEmbedModels = 
  | AxAIOpenAIEmbedModel
  | AxAIGoogleGeminiEmbedModel
  | AxAICohereEmbedModel;

Full reference

`AxAIFeatures`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIFeatures`
Source	source

Full reference

`AxAIGoogleGeminiArgs`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIGoogleGeminiArgs`
Source	source

Full reference

`AxAIGoogleGeminiBatchEmbedRequest`

AxAIGoogleGeminiEmbedRequest: Structure for making an embedding request to the Google Gemini API.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiBatchEmbedRequest`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiBatchEmbedRequest = object;

Full reference

`AxAIGoogleGeminiBatchEmbedResponse`

AxAIGoogleGeminiEmbedResponse: Structure for handling responses from the Google Gemini API embedding requests.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiBatchEmbedResponse`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiBatchEmbedResponse = object;

Full reference

`AxAIGoogleGeminiCacheCreateRequest`

Request to create a context cache in Vertex AI / Gemini API.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiCacheCreateRequest`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiCacheCreateRequest = object;

Full reference

`AxAIGoogleGeminiCacheResponse`

Response from creating/getting a context cache.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiCacheResponse`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiCacheResponse = object;

Full reference

`AxAIGoogleGeminiCacheUpdateRequest`

Request to update a context cache (e.g., extend TTL).

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiCacheUpdateRequest`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiCacheUpdateRequest = object;

Full reference

`AxAIGoogleGeminiChatRequest`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiChatRequest`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiChatRequest = object;

Full reference

`AxAIGoogleGeminiChatResponse`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiChatResponse`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiChatResponse = object;

Full reference

`AxAIGoogleGeminiChatResponseDelta`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiChatResponseDelta`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiChatResponseDelta = AxAIGoogleGeminiChatResponse;

Full reference

`AxAIGoogleGeminiConfig`

AxAIGoogleGeminiConfig: Configuration options for Google Gemini API

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiConfig`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiConfig = AxModelConfig & object;

Full reference

`AxAIGoogleGeminiContent`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiContent`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiContent = object;

Full reference

`AxAIGoogleGeminiContentPart`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiContentPart`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiContentPart = object & 
  | {
  text: string;
  thought?: boolean;
}
  | {
  thought: string;
}
  | {
  inlineData: {
     data: string;
     mimeType: string;
  };
}
  | {
  functionCall: {
     args: object;
     name: string;
  };
}
  | {
  functionResponse: {
     name: string;
     response: object;
  };
}
  | {
  fileData: {
     fileUri: string;
     mimeType: string;
  };
}
  | {
  executableCode: object;
}
  | {
  codeExecutionResult: object;
};

Full reference

`axAIGoogleGeminiDefaultConfig`

AxAIGoogleGemini: Default Model options for text generation

Field	Value
Kind	`function`
Form	`axAIGoogleGeminiDefaultConfig`
Returns	`AxAIGoogleGeminiConfig`
Source	source

Call Shape

TypeScript

function axAIGoogleGeminiDefaultConfig(): AxAIGoogleGeminiConfig;

Full reference

`axAIGoogleGeminiDefaultCreativeConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIGoogleGeminiDefaultCreativeConfig`
Returns	`AxAIGoogleGeminiConfig`
Source	source

Call Shape

TypeScript

function axAIGoogleGeminiDefaultCreativeConfig(): AxAIGoogleGeminiConfig;

Full reference

`AxAIGoogleGeminiEmbedModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGoogleGeminiEmbedModel`
Source	source

Full reference

`AxAIGoogleGeminiEmbedTypes`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGoogleGeminiEmbedTypes`
Source	source

Full reference

`AxAIGoogleGeminiGenerationConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiGenerationConfig`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiGenerationConfig = object;

Full reference

`axAIGoogleGeminiLiveAudioDefaultConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIGoogleGeminiLiveAudioDefaultConfig`
Returns	`AxAIGoogleGeminiConfig`
Source	source

Call Shape

TypeScript

function axAIGoogleGeminiLiveAudioDefaultConfig(): AxAIGoogleGeminiConfig;

Full reference

`AxAIGoogleGeminiModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGoogleGeminiModel`
Source	source

Full reference

`AxAIGoogleGeminiOptionsTools`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIGoogleGeminiOptionsTools`
Source	source

Full reference

`AxAIGoogleGeminiRetrievalConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiRetrievalConfig`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiRetrievalConfig = object;

Full reference

`AxAIGoogleGeminiSafetyCategory`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGoogleGeminiSafetyCategory`
Source	source

Full reference

`AxAIGoogleGeminiSafetySettings`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiSafetySettings`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiSafetySettings = object[];

Full reference

`AxAIGoogleGeminiSafetyThreshold`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGoogleGeminiSafetyThreshold`
Source	source

Full reference

`AxAIGoogleGeminiThinkingConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiThinkingConfig`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiThinkingConfig = object;

Full reference

`AxAIGoogleGeminiThinkingLevel`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiThinkingLevel`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiThinkingLevel = "minimal" | "low" | "medium" | "high";

Full reference

`AxAIGoogleGeminiThinkingLevelMapping`

Maps thinkingTokenBudget string levels to Gemini 3 thinkingLevel values. The mapped result is clamped to the levels supported by the resolved model.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiThinkingLevelMapping`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiThinkingLevelMapping = object;

Full reference

`AxAIGoogleGeminiThinkingTokenBudgetLevels`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiThinkingTokenBudgetLevels`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiThinkingTokenBudgetLevels = object;

Full reference

`AxAIGoogleGeminiTool`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiTool`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiTool = object;

Full reference

`AxAIGoogleGeminiToolConfig`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiToolConfig`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiToolConfig = object;

Full reference

`AxAIGoogleGeminiToolFunctionDeclaration`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiToolFunctionDeclaration`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiToolFunctionDeclaration = object;

Full reference

`AxAIGoogleGeminiToolGoogleMaps`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiToolGoogleMaps`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiToolGoogleMaps = object;

Full reference

`AxAIGoogleGeminiToolGoogleSearchRetrieval`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleGeminiToolGoogleSearchRetrieval`
Source	source

Call Shape

TypeScript

type AxAIGoogleGeminiToolGoogleSearchRetrieval = object;

Full reference

`AxAIGoogleVertexBatchEmbedRequest`

AxAIGoogleVertexBatchEmbedRequest: Structure for making an embedding request to the Google Vertex API.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleVertexBatchEmbedRequest`
Source	source

Call Shape

TypeScript

type AxAIGoogleVertexBatchEmbedRequest = object;

Full reference

`AxAIGoogleVertexBatchEmbedResponse`

AxAIGoogleVertexBatchEmbedResponse: Structure for handling responses from the Google Vertex API embedding requests.

Field	Value
Kind	`typealias`
Form	`AxAIGoogleVertexBatchEmbedResponse`
Source	source

Call Shape

TypeScript

type AxAIGoogleVertexBatchEmbedResponse = object;

Full reference

`axAIGrokBestConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIGrokBestConfig`
Returns	`AxAIOpenAIConfig`<`AxAIGrokModel`, `GrokEmbedSmall`>
Source	source

Call Shape

TypeScript

function axAIGrokBestConfig(): AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>;

Full reference

`axAIGrokDefaultConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIGrokDefaultConfig`
Returns	`AxAIOpenAIConfig`<`AxAIGrokModel`, `GrokEmbedSmall`>
Source	source

Call Shape

TypeScript

function axAIGrokDefaultConfig(): AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>;

Full reference

`AxAIGrokEmbedModels`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGrokEmbedModels`
Source	source

Full reference

`AxAIGrokModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIGrokModel`
Source	source

Full reference

`axAIGrokVoiceDefaultConfig`

TypeScript function exported by @ax-llm/ax. See the call shape, arguments, and full reference below.

Field	Value
Kind	`function`
Form	`axAIGrokVoiceDefaultConfig`
Returns	`AxAIOpenAIConfig`<`AxAIGrokModel`, `GrokEmbedSmall`>
Source	source

Call Shape

TypeScript

function axAIGrokVoiceDefaultConfig(): AxAIOpenAIConfig<AxAIGrokModel, GrokEmbedSmall>;

Full reference

`AxAIInputModelList`

TypeScript typealias exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`typealias`
Form	`AxAIInputModelList`
Source	source

Call Shape

TypeScript

type AxAIInputModelList<TModel, TEmbedModel, TModelKey> = AxAIModelListBase<TModelKey> & object & 
  | {
  model: TModel;
}
  | {
  embedModel: TEmbedModel;
}[];

Full reference

`AxAIMemory`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIMemory`
Source	source

Call Shape

TypeScript

addFunctionResults(results: readonly AxFunctionResult[], sessionId?: string): void;

Full reference

`AxAIMetricsInstruments`

TypeScript interface exported by @ax-llm/ax. See the fields and full reference below.

Field	Value
Kind	`interface`
Form	`AxAIMetricsInstruments`
Source	source

Full reference

`AxAIMistralEmbedModels`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIMistralEmbedModels`
Source	source

Full reference

`AxAIMistralModel`

TypeScript enumeration exported by @ax-llm/ax. See the full reference for complete details.

Field	Value
Kind	`enumeration`
Form	`AxAIMistralModel`
Source	source

Full reference

Full Reference

Open the full TypeScript reference. This page highlights the ai symbols most relevant to everyday use.