ai() API

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

Most Used

`Ax.ai`

Create a provider client from a provider name and options.

Field	Value
Kind	`function`
Ax concept	`ai`
API section	AxAI
Form	`Ax.ai(provider, options)`
Returns	AI client/service

Important Options

api key
model
api URL
headers
transport

Examples

Java

AxAIService client = Ax.ai("openai", Map.of("apiKey", System.getenv("OPENAI_API_KEY")));

Full reference

`OpenAICompatibleClient`

OpenAI-compatible chat, stream, embedding, audio, and realtime provider boundary.

Field	Value
Kind	`type`
Ax concept	`OpenAICompatibleClient`
API section	AxAI
Form	`new OpenAICompatibleClient(options)`
Returns	provider client

Important Options

api key
model
base URL
transport

Full reference

`OpenAIResponsesClient`

OpenAI Responses provider mapping using the same Core-owned request and response contract.

Field	Value
Kind	`type`
Ax concept	`OpenAIResponsesClient`
API section	AxAI
Form	`new OpenAIResponsesClient(options)`
Returns	provider client

Important Options

api key
model
audio
realtime

Full reference

`GoogleGeminiClient`

Gemini provider mapping for chat, streaming, media, tools, embeddings, and usage normalization.

Field	Value
Kind	`type`
Ax concept	`GoogleGeminiClient`
API section	AxAI
Form	`new GoogleGeminiClient(options)`
Returns	provider client

Important Options

api key
model
embed model

Full reference

`AnthropicClient`

Anthropic provider mapping for messages, thinking, cache control, streaming, and usage normalization.

Field	Value
Kind	`type`
Ax concept	`AnthropicClient`
API section	AxAI
Form	`new AnthropicClient(options)`
Returns	provider client

Important Options

api key
model
thinking
cache control

Full reference

`AxBalancer`

Retry and route requests across multiple provider services while preserving Ax request shape.

Field	Value
Kind	`type`
Ax concept	`AxBalancer`
API section	AxAI
Form	`new AxBalancer(services, options)`
Returns	AI service

Important Options

services
retry policy
capability requirements

Full reference

`MultiServiceRouter`

Choose a service by capability or model routing policy.

Field	Value
Kind	`type`
Ax concept	`MultiServiceRouter`
API section	AxAI
Form	`new AxMultiServiceRouter(services)`
Returns	AI service

Important Options

services
routing

Full reference

`ProviderRouter`

Route provider requests to registered provider clients.

Field	Value
Kind	`type`
Ax concept	`ProviderRouter`
API section	AxAI
Form	`new AxProviderRouter(providers, routing, processing)`
Returns	AI service

Important Options

providers
routing
processing

Full reference

Full Reference

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