ai() API
LLM provider, model, media, routing, and embedding APIs.
Most Used
axllm.NewAI
Create a provider client from a provider name and options.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | ai |
| API section | AxAI |
| Form | axllm.NewAI(provider, options) |
| Returns | AIClient |
Important Options
api keymodelapi URLheaderstransport
Examples
client := axllm.NewAI("openai", map[string]axllm.Value{"apiKey": os.Getenv("OPENAI_API_KEY")})axllm.OpenAICompatibleClient
OpenAI-compatible chat, stream, embedding, audio, and realtime provider boundary.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | OpenAICompatibleClient |
| API section | AxAI |
| Form | axllm.NewOpenAICompatibleClient(options) |
| Returns | provider client |
Important Options
api keymodelbase URLtransport
axllm.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 | axllm.NewOpenAIResponsesClient(options) |
| Returns | provider client |
Important Options
api keymodelaudiorealtime
axllm.GoogleGeminiClient
Gemini provider mapping for chat, streaming, media, tools, embeddings, and usage normalization.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | GoogleGeminiClient |
| API section | AxAI |
| Form | axllm.NewGoogleGeminiClient(options) |
| Returns | provider client |
Important Options
api keymodelembed model
axllm.AnthropicClient
Anthropic provider mapping for messages, thinking, cache control, streaming, and usage normalization.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | AnthropicClient |
| API section | AxAI |
| Form | axllm.NewAnthropicClient(options) |
| Returns | provider client |
Important Options
api keymodelthinkingcache control
axllm.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 | axllm.NewAxBalancer(services, options) |
| Returns | AI service |
Important Options
servicesretry policycapability requirementsadaptive strategy
axllm.MultiServiceRouter
Choose a service by capability or model routing policy.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | MultiServiceRouter |
| API section | AxAI |
| Form | axllm.MultiServiceRouter |
| Returns | AI service |
Important Options
servicesrouting
axllm.ProviderRouter
Route provider requests to registered provider clients.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | ProviderRouter |
| API section | AxAI |
| Form | axllm.ProviderRouter |
| Returns | AI service |
Important Options
providersroutingprocessing
Advanced / internals / full reference
axllm.AxUsageContext
Application attribution merged from service defaults and per-call overrides.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | AxUsageContext |
| API section | AxAI |
| Form | axllm.AxUsageContext |
| Returns | usage context |
Important Options
tenantuserrequestrunfeatureattributes
axllm.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 | axllm.AxUsageEvent |
| Returns | usage event |
Important Options
providermodeltokenscontextcorrelation IDsstreaming
axllm.AxUsageObserver
Best-effort process-wide callback for normalized usage events.
| Field | Value |
|---|---|
| Kind | interface |
| Ax concept | AxUsageObserver |
| API section | AxAI |
| Form | axllm.AxUsageObserver |
| Returns | usage observer |
Important Options
fail-open deliverysynchronous enqueue
axllm.SetUsageObserver
Register, replace, or clear the process-wide usage observer.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | set_usage_observer |
| API section | AxAI |
| Form | axllm.SetUsageObserver(observer) |
| Returns | void |
Important Options
observerclear
Examples
axllm.SetUsageObserver(func(event axllm.AxUsageEvent) { events = append(events, event) })axllm.AxBalancerAdaptiveStrategy
Configure adaptive provider routing without changing the ordered default.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | AxBalancerAdaptiveStrategy |
| API section | AxAI |
| Form | axllm.AxBalancerAdaptiveStrategy |
| Returns | adaptive strategy |
Important Options
deadlinebad outcome costexpected tokensstable route keysslicestats storerouting events
axllm.AxBalancerStatsStore
Store shared adaptive decision state with atomic observations.
| Field | Value |
|---|---|
| Kind | interface |
| Ax concept | AxBalancerStatsStore |
| API section | AxAI |
| Form | axllm.AxBalancerStatsStore |
| Returns | stats store |
Important Options
getobserve
axllm.AxInMemoryBalancerStatsStore
Thread-safe in-memory adaptive stats store.
| Field | Value |
|---|---|
| Kind | type |
| Ax concept | AxInMemoryBalancerStatsStore |
| API section | AxAI |
| Form | axllm.AxInMemoryBalancerStatsStore |
| Returns | stats store |
axllm.CreateBalancerRouteStats
Create neutral adaptive route statistics.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | create_balancer_route_stats |
| API section | AxAI |
| Form | axllm.CreateBalancerRouteStats |
| Returns | route stats |
axllm.UpdateBalancerRouteStats
Purely reduce one success or failure observation into route statistics.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | update_balancer_route_stats |
| API section | AxAI |
| Form | axllm.UpdateBalancerRouteStats |
| Returns | route stats |
Important Options
current statsobservation
axllm.SampleBalancerRouteHealth
Sample failure and deadline-miss probability for adaptive exploration.
| Field | Value |
|---|---|
| Kind | function |
| Ax concept | sample_balancer_route_health |
| API section | AxAI |
| Form | axllm.SampleBalancerRouteHealth |
| Returns | sampled health |
Important Options
route statsdeadline
Full Reference
Open the full Go reference. This page highlights the ai symbols most relevant to everyday use.