Skip to content

Commit 1b39337

Browse files
Updates docs
1 parent 620bf89 commit 1b39337

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

bluecast/ai/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,10 @@ class BlueCastAI:
6666
6767
:param api_key: API key for the LLM provider.
6868
:param provider: LLM provider: 'gemini', 'openai', or 'anthropic'.
69-
:param model: Provider-specific model name (e.g. 'gpt-4o', 'claude-sonnet-4-20250514').
70-
Uses a sensible default per provider if not specified.
69+
:param model: Provider-specific model name. Pass the exact string the provider
70+
expects (e.g. 'gemini-2.5-pro', 'gpt-4o-mini', 'claude-sonnet-4-20250514').
71+
Defaults per provider when not specified:
72+
gemini -> 'gemini-2.5-flash', openai -> 'gpt-4o', anthropic -> 'claude-sonnet-4-20250514'.
7173
:param enable_web_search: Whether agents can search the web for techniques.
7274
:param verbose: Whether to print progress to stdout.
7375
:param temperature: LLM temperature (0.0 = deterministic, 1.0 = creative).

bluecast/ai/config.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ class AIConfig:
1010
1111
:param api_key: API key for the LLM provider.
1212
:param provider: LLM provider to use.
13-
:param model: Provider-specific model name. If None, uses a sensible default.
13+
:param model: Provider-specific model name. Pass the exact string the provider
14+
expects (e.g. 'gemini-2.5-pro', 'gpt-4o-mini', 'claude-opus-4-20250514').
15+
Defaults: gemini -> 'gemini-2.5-flash', openai -> 'gpt-4o',
16+
anthropic -> 'claude-sonnet-4-20250514'.
1417
:param mode: Controls speed vs thoroughness trade-off.
1518
'fast' = skip FE, 1 iteration, basic config.
1619
'balanced' = targeted FE, 2-3 iterations.

examples/09_bluecast_ai.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -235,17 +235,26 @@ def make_credit_data(n=1500, seed=42):
235235
│ EXAMPLE 8: Choosing your LLM provider │
236236
└─────────────────────────────────────────────────────────────────────┘
237237
238-
# Google Gemini (default)
238+
# Google Gemini (default model: gemini-2.5-flash)
239239
ai = BlueCastAI(api_key="...", provider="gemini")
240240
241-
# Specific Gemini model
241+
# Choose a specific Gemini model
242242
ai = BlueCastAI(api_key="...", provider="gemini", model="gemini-2.5-pro")
243+
ai = BlueCastAI(api_key="...", provider="gemini", model="gemini-2.0-flash-lite")
243244
244-
# OpenAI GPT-4o
245-
ai = BlueCastAI(api_key="...", provider="openai", model="gpt-4o")
245+
# OpenAI (default model: gpt-4o)
246+
ai = BlueCastAI(api_key="...", provider="openai")
247+
ai = BlueCastAI(api_key="...", provider="openai", model="gpt-4o-mini")
246248
247-
# Anthropic Claude
248-
ai = BlueCastAI(api_key="...", provider="anthropic", model="claude-sonnet-4-20250514")
249+
# Anthropic (default model: claude-sonnet-4-20250514)
250+
ai = BlueCastAI(api_key="...", provider="anthropic")
251+
ai = BlueCastAI(api_key="...", provider="anthropic", model="claude-opus-4-20250514")
252+
253+
# The model= parameter accepts any model name your provider supports.
254+
# When omitted, defaults are:
255+
# gemini -> gemini-2.5-flash
256+
# openai -> gpt-4o
257+
# anthropic -> claude-sonnet-4-20250514
249258
250259
# Lower temperature for more deterministic results
251260
ai = BlueCastAI(api_key="...", provider="gemini", temperature=0.1)

0 commit comments

Comments
 (0)