Skip to content

Commit fdeea31

Browse files
committed
docs: document slash-format model strings and update model table
1 parent 676f0bb commit fdeea31

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,26 @@ const m = mission('research').goal('Research {topic}').planner({ strategy: 'adap
231231

232232
Auto-detection: OpenAI → Anthropic → OpenRouter → Gemini → Groq → Together → Mistral → xAI → CLI → Ollama
233233

234+
### Model String Formats
235+
236+
Three ways to specify a model:
237+
238+
```ts
239+
// 1. Separate fields (recommended)
240+
generateText({ provider: 'anthropic', model: 'claude-sonnet-4-20250514', prompt: '...' });
241+
242+
// 2. Colon format (canonical combined string)
243+
generateText({ model: 'anthropic:claude-sonnet-4-20250514', prompt: '...' });
244+
245+
// 3. Slash format (also supported for known providers)
246+
generateText({ model: 'anthropic/claude-sonnet-4-20250514', prompt: '...' });
247+
248+
// Auto-detect (omit both provider and model)
249+
generateText({ prompt: '...' }); // uses first available provider
250+
```
251+
252+
The slash format only splits on known provider prefixes (`openai`, `anthropic`, `openrouter`, etc.). Unknown prefixes like `meta-llama/llama-3.1-8b` pass through as a plain model name to the auto-detected provider.
253+
234254
---
235255

236256
## API Reference

0 commit comments

Comments
 (0)