AI Provider Codegen Rules (@ax-llm/ax)
This skill helps an LLM generate correct AI provider setup and configuration code using @ax-llm/ax. Use when the user asks about ai(), providers, models, presets, embeddings, batch audio with ai.transcribe() or ai.speak(), extended thinking, context caching, or mentions OpenAI/Anthropic/Google/Azure/DeepSeek/Mistral/Cohere/Reka/Grok with @ax-llm/ax.
Install
Install only this skill for TypeScript:
npx skills add https://ax-llm.github.io/ax/typescript/ --skill 'ax-ai'Published skill file: ax-ai/SKILL.md.
Source
- Source: src/ax/skills/ax-ai.md
- Version:
22.0.3
Skill Instructions
Use this skill to generate AI provider setup, configuration, and chat code. Prefer short, modern, copyable patterns. Do not write tutorial prose unless the user explicitly asks for explanation.
Quick Setup
import { ai } from '@ax-llm/ax';
const openai = ai({ name: 'openai', apiKey: 'sk-...' });
const claude = ai({ name: 'anthropic', apiKey: 'sk-ant-...' });
const gemini = ai({ name: 'google-gemini', apiKey: 'AIza...' });
const azure = ai({ name: 'azure-openai', apiKey: 'your-key', resourceName: 'your-resource', deploymentName: 'gpt-4' });
const deepseek = ai({ name: 'deepseek', apiKey: 'sk-...' });
const mistral = ai({ name: 'mistral', apiKey: 'your-key' });
const cohere = ai({ name: 'cohere', apiKey: 'your-key' });
const custom = ai({
name: 'openai',
apiKey: process.env.PROVIDER_API_KEY,
apiURL: 'https://example.com/v1',
config: { model: 'provider/model-name' },
});
const reka = ai({ name: 'reka', apiKey: 'your-key' });
const grok = ai({ name: 'grok', apiKey: 'your-key' });
const compatible = ai({ name: 'openai', apiKey: 'key', apiURL: 'https://api.example.com/v1', config: { model: 'provider/model' } });Model Presets
import { ai, AxAIGoogleGeminiModel } from '@ax-llm/ax';
const gemini = ai({
name: 'google-gemini',
apiKey: process.env.GOOGLE_APIKEY!,
config: { model: 'simple' },
models: [
{ key: 'tiny', model: AxAIGoogleGeminiModel.Gemini20FlashLite, description: 'Fast + cheap', config: { maxTokens: 1024, temperature: 0.3 } },
{ key: 'simple', model: AxAIGoogleGeminiModel.Gemini20Flash, description: 'Balanced', config: { temperature: 0.6 } },
],
});
await gemini.chat({ model: 'tiny', chatPrompt: [{ role: 'user', content: 'Hi' }] });Model Catalog
import { axGetSupportedAIModels } from '@ax-llm/ax';
const providers = axGetSupportedAIModels();
const openai = providers.find((provider) => provider.name === 'openai');
console.log(openai?.models[0]?.promptTokenCostPer1M);
const textProviders = axGetSupportedAIModels({ type: 'text' });
const embeddingProviders = axGetSupportedAIModels({ type: 'embeddings' });Use axGetSupportedAIModels() to build provider/model selectors before creating an ai(...) instance. It returns bundled static metadata: provider names, display names, default models, raw AxModelInfo pricing/details, model type ('text', 'embeddings', 'code', or 'audio'), and normalized capability flags for thinking, thoughts, structured outputs, audio, temperature, and top-p support. Provider groups and models are sorted cheapest to most expensive based on bundled input + output token pricing; unpriced models sort last.
Filter with { type: 'all' | 'text' | 'embeddings' | 'code' | 'audio' } or an array of those values. The 'text' filter includes code-capable models; use 'code' to show only code-first models.
Dynamic providers such as Azure OpenAI deployments are marked with isDynamic: true and may have an empty or static-limited model list.
Chat
const res = await llm.chat({
chatPrompt: [
{ role: 'system', content: 'You are concise.' },
{ role: 'user', content: 'Write a haiku about the ocean.' },
],
});
console.log(res.results[0]?.content);Batch Audio
Use ai.transcribe(...) for batch speech-to-text and ai.speak(...) for batch text-to-speech. These are separate from conversational .chat() audio config.
const transcript = await llm.transcribe({
audio: { data: base64Wav, format: 'wav' },
model: 'gpt-4o-mini-transcribe',
language: 'en',
});
const speech = await llm.speak({
text: transcript.text,
model: 'gpt-4o-mini-tts',
voice: 'alloy',
format: 'mp3',
});
console.log(transcript.text);
console.log(speech.data);Providers without the requested audio endpoint throw AxMediaNotSupportedError. Use speech forward options for signature audio artifacts and modelConfig.audio for conversational chat audio.
Common Options
stream(boolean): enable SSE; true by defaultthinkingTokenBudget:'minimal'|'low'|'medium'|'high'|'highest'|'none'showThoughts: include thoughts in outputfunctionCallMode:'auto'|'native'|'prompt'debug,logger,tracer,rateLimiter,timeout
Global Runtime Defaults
Use axGlobals when the app wants one live default for AI requests, generator runs, flows, or metrics:
import { ai, axGlobals, axCreateDefaultColorLogger } from '@ax-llm/ax';
import { trace } from '@opentelemetry/api';
axGlobals.tracer = trace.getTracer('my-app');
axGlobals.debug = true;
axGlobals.logger = axCreateDefaultColorLogger();
axGlobals.customLabels = { service: 'api' };
const llm = ai({ name: 'openai', apiKey: process.env.OPENAI_APIKEY! });Rules:
axGlobals.tracer,meter,logger,debug,abortSignal, andcustomLabelsare live runtime defaults; future calls read the current value even if the AI instance already exists.- Precedence is: per-call options, then explicit AI/service options, then current
axGlobals, then built-in defaults. customLabelsmerge from globals to service to call options; later sources override earlier keys.abortSignalvalues are merged, so either a global shutdown signal or a local request signal can cancel the request.
DeepSeek Notes
import { ai, AxAIDeepSeekModel } from '@ax-llm/ax';
const deepseek = ai({
name: 'deepseek',
apiKey: process.env.DEEPSEEK_APIKEY!,
config: { model: AxAIDeepSeekModel.DeepSeekV4Flash },
});DeepSeek’s current API models are deepseek-v4-flash and deepseek-v4-pro.
The deprecated deepseek-chat and deepseek-reasoner aliases are retained for
compatibility until DeepSeek removes them on 2026-07-24.
DeepSeek V4 supports thinking mode. Ax sends thinking: { type: "disabled" }
by default to preserve non-thinking behavior, and enables it when
thinkingTokenBudget is set. Ax maps lower budget levels to DeepSeek’s high
effort and maps highest to max. DeepSeek V4 thinking models support tools,
but reject the tool_choice request parameter, so Ax omits forced/auto tool
choice for deepseek-v4-pro, deepseek-v4-flash, and deepseek-reasoner
while still sending tool definitions.
Extended Thinking
import { ai, AxAIAnthropicModel } from '@ax-llm/ax';
const claude = ai({
name: 'anthropic',
apiKey: process.env.ANTHROPIC_APIKEY!,
config: { model: AxAIAnthropicModel.Claude48Opus },
});
const res = await claude.chat(
{ chatPrompt: [{ role: 'user', content: 'Solve step by step...' }] },
{ thinkingTokenBudget: 'medium', showThoughts: true },
);
console.log(res.results[0]?.thought);
console.log(res.results[0]?.content);Budget Levels
| Level | Anthropic (tokens) | Gemini (tokens) |
|---|---|---|
'none' | disabled | minimal |
'minimal' | 1,024 | 200 |
'low' | 5,000 | 800 |
'medium' | 10,000 | 5,000 |
'high' | 20,000 | 10,000 |
'highest' | 32,000 | 24,500 |
Anthropic Model-Specific Behavior
- Opus 4.8 and 4.7: adaptive thinking, effort levels including
'xhigh', no manualbudget_tokens, and notemperature/topP/topK. - Opus 4.6: adaptive thinking, effort levels
- Opus 4.5: budget_tokens + effort levels (capped at
'high') - Other thinking models: budget tokens only
Anthropic modelConfig.effort can be set directly on a request. Fast mode and
task budgets are Anthropic-only opt-ins; taskBudget.total must be at least
20,000 tokens.
const res = await claude.chat({
chatPrompt: [{ role: 'user', content: 'Review this migration plan.' }],
modelConfig: {
effort: 'xhigh',
speed: 'fast',
taskBudget: { type: 'tokens', total: 64_000 },
},
});Custom Thinking Levels
const claude = ai({
name: 'anthropic',
apiKey: '...',
config: {
model: AxAIAnthropicModel.Claude48Opus,
thinkingTokenBudgetLevels: {
minimal: 2048,
low: 8000,
medium: 16000,
high: 25000,
highest: 40000,
},
effortLevelMapping: {
minimal: 'low',
low: 'medium',
medium: 'high',
high: 'high',
highest: 'max',
},
},
});Embeddings
const { embeddings } = await llm.embed({
texts: ['hello', 'world'],
embedModel: 'text-embedding-005',
});Context Caching
const result = await gen.forward(llm, { code, language }, {
mem,
sessionId: 'code-review-session',
contextCache: {
ttlSeconds: 3600,
cacheBreakpoint: 'after-examples',
},
});Breakpoint values: 'system' | 'after-functions' | 'after-examples'
Provider behavior:
- Google Gemini: explicit caching with cache resource ID, auto TTL refresh
- Anthropic: implicit via
cache_controlmarkers
External Registry (serverless)
const registry: AxContextCacheRegistry = {
get: async (key) => { /* redis.get */ },
set: async (key, entry) => { /* redis.set */ },
};AWS Bedrock
import { AxAIBedrock, AxAIBedrockModel } from '@ax-llm/ax-ai-aws-bedrock';
const bedrock = new AxAIBedrock({
region: 'us-east-2',
fallbackRegions: ['us-west-2'],
config: { model: AxAIBedrockModel.ClaudeSonnet4 },
});Vercel AI SDK Integration
import { ai } from '@ax-llm/ax';
import { AxAIProvider } from '@ax-llm/ax-ai-sdk-provider';
import { generateText } from 'ai';
const axAI = ai({ name: 'openai', apiKey: process.env.OPENAI_APIKEY! });
const model = new AxAIProvider(axAI);
const result = await generateText({
model,
messages: [{ role: 'user', content: 'Hello!' }],
});MCP + AxJSRuntime
import { AxMCPClient } from '@ax-llm/ax';
import { axCreateMCPStdioTransport } from '@ax-llm/ax-tools';
const transport = axCreateMCPStdioTransport({
command: 'npx',
args: ['-y', '@anthropic/mcp-server-filesystem'],
});
const client = new AxMCPClient(transport);Critical Rules
- Use
ai()factory for all providers. - Provider names:
'openai','openai-responses','anthropic','google-gemini','azure-openai','mistral','cohere','deepseek','reka','grok' - Thinking constraints on Anthropic: Opus 4.8/4.7 omit
temperature,topP, andtopK; older thinking models ignoretemperatureandtopK, withtopPonly sent if >= 0.95. - Bedrock uses
new AxAIBedrock(), notai(). - Vercel AI SDK uses
AxAIProviderwrapper.
Examples
Fetch these for full working code:
- Embeddings — embedding generation
- Anthropic Thinking — extended thinking with functions
- Anthropic Thinking Separation — thinking separation
- Anthropic Web Search — Anthropic web search
- OpenAI Web Search — OpenAI web search
- OpenAI Responses — OpenAI responses API
- o3 Reasoning — o3 reasoning
- Gemini Context Cache — Gemini context caching
- Gemini Files — Gemini file handling
- Grok Live Search — Grok live search
- OpenAI-Compatible — custom OpenAI-compatible base URL
- Vertex AI Auth — Vertex AI authentication
- MCP Stdio — MCP stdio transport
- MCP HTTP — MCP HTTP transport
- Telemetry — OpenTelemetry tracing
- Multi-Modal — image handling
Do Not Generate
- Do not use
new AxAIOpenAI(...)or similar class constructors for standard providers; useai(). - Do not hardcode provider class names when
ai({ name: ... })covers the provider. - Do not mix
thinkingTokenBudgetwith explicittemperatureon Anthropic thinking models. - Do not use
ai()for AWS Bedrock; usenew AxAIBedrock(). - Do not omit
resourceNameanddeploymentNamefor Azure OpenAI.