ai() API

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

Most Used

`ai`

Create a provider client from a provider name and options.

Field	Value
Kind	`function`
Ax concept	`ai`
API section	AxAI
Form	`ai(provider, options)`
Returns	AxResult

Important Options

api key
model
api URL
headers
transport

Examples

Rust

let client = ai("openai", json!({"apiKey": std::env::var("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	`OpenAICompatibleClient / ai(provider, 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	`OpenAIResponsesClient / ai(provider, 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	`GoogleGeminiClient / ai(provider, 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	`AnthropicClient / ai(provider, options)`
Returns	provider client

Important Options

api key
model
thinking
cache control

Full reference

`AxBalancer`

Retry and route requests across multiple provider services, with opt-in adaptive cost, reliability, and deadline routing.

Field	Value
Kind	`type`
Ax concept	`AxBalancer`
API section	AxAI
Form	`AxBalancer`
Returns	AI service

Important Options

services
retry policy
capability requirements
adaptive strategy

Full reference

`MultiServiceRouter`

Choose a service by capability or model routing policy.

Field	Value
Kind	`type`
Ax concept	`MultiServiceRouter`
API section	AxAI
Form	`MultiServiceRouter`
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	`ProviderRouter`
Returns	AI service

Important Options

providers
routing
processing

Full reference

Advanced / internals / full reference

`AxUsageContext`

Application attribution merged from service defaults and per-call overrides.

Field	Value
Kind	`type`
Ax concept	`AxUsageContext`
API section	AxAI
Form	`AxUsageContext`
Returns	usage context

Important Options

tenant
user
request
run
feature
attributes

Full reference

`AxUsageEvent`

Normalized token usage and correlation data for one completed chat or embedding operation.

Field	Value
Kind	`type`
Ax concept	`AxUsageEvent`
API section	AxAI
Form	`AxUsageEvent`
Returns	usage event

Important Options

provider
model
tokens
context
correlation IDs
streaming

Full reference

`AxUsageObserver`

Best-effort process-wide callback for normalized usage events.

Field	Value
Kind	`interface`
Ax concept	`AxUsageObserver`
API section	AxAI
Form	`AxUsageObserver`
Returns	usage observer

Important Options

fail-open delivery
synchronous enqueue

Full reference

`set_usage_observer`

Field	Value
Kind	`function`
Ax concept	`set_usage_observer`
API section	AxAI
Form	`set_usage_observer(observer)`
Returns	void

Important Options

observer
clear

Examples

Rust

set_usage_observer(Some(Arc::new(move |event| events.lock().unwrap().push(event))));

Full reference

`AxBalancerAdaptiveStrategy`

Configure adaptive provider routing without changing the ordered default.

Field	Value
Kind	`type`
Ax concept	`AxBalancerAdaptiveStrategy`
API section	AxAI
Form	`AxBalancerAdaptiveStrategy`
Returns	adaptive strategy

Important Options

deadline
bad outcome cost
expected tokens
stable route keys
slice
stats store
routing events

Full reference

`AxBalancerStatsStore`

Store shared adaptive decision state with atomic observations.

Field	Value
Kind	`interface`
Ax concept	`AxBalancerStatsStore`
API section	AxAI
Form	`AxBalancerStatsStore`
Returns	stats store

Important Options

get
observe

Full reference

`AxInMemoryBalancerStatsStore`

Thread-safe in-memory adaptive stats store.

Field	Value
Kind	`type`
Ax concept	`AxInMemoryBalancerStatsStore`
API section	AxAI
Form	`AxInMemoryBalancerStatsStore`
Returns	stats store

Full reference

`create_balancer_route_stats`

Create neutral adaptive route statistics.

Field	Value
Kind	`function`
Ax concept	`create_balancer_route_stats`
API section	AxAI
Form	`create_balancer_route_stats`
Returns	route stats

Full reference

`update_balancer_route_stats`

Purely reduce one success or failure observation into route statistics.

Field	Value
Kind	`function`
Ax concept	`update_balancer_route_stats`
API section	AxAI
Form	`update_balancer_route_stats`
Returns	route stats

Important Options

current stats
observation

Full reference

`sample_balancer_route_health`

Sample failure and deadline-miss probability for adaptive exploration.

Field	Value
Kind	`function`
Ax concept	`sample_balancer_route_health`
API section	AxAI
Form	`sample_balancer_route_health`
Returns	sampled health

Important Options

route stats
deadline

Full reference

Full Reference

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