Add settings field documentation to recipe guides (#3809)

This commit is contained in:
Rizel Scarlett
2025-08-03 00:12:10 -04:00
committed by GitHub
parent f775cd9a47
commit c850ac20f4
2 changed files with 50 additions and 1 deletions
@@ -79,6 +79,7 @@ Goose automatically adds metadata fields to recipes saved from the Desktop app.
| `prompt` | String | A template prompt that can include parameter substitutions; required in headless (non-interactive) mode |
| `parameters` | Array | List of parameter definitions |
| `extensions` | Array | List of extension configurations |
| `settings` | Object | Configuration for model provider, model name, and other settings |
| `sub_recipes` | Array | List of sub-recipes |
| `response` | Object | Configuration for structured output validation |
| `retry` | Object | Configuration for automated retry logic with success validation |
@@ -165,6 +166,38 @@ extensions:
description: "For searching logs using Presidio"
```
## Settings
The `settings` field allows you to configure the AI model and provider settings for the recipe. This overrides the default configuration when the recipe is executed.
### Settings Fields
| Field | Type | Description |
|-------|------|-------------|
| `goose_provider` | String | (Optional) The AI provider to use (e.g., "anthropic", "openai") |
| `goose_model` | String | (Optional) The specific model name to use |
| `temperature` | Number | (Optional) The temperature setting for the model (typically 0.0-1.0) |
### Example Settings Configuration
```yaml
settings:
goose_provider: "anthropic"
goose_model: "claude-3-5-sonnet-latest"
temperature: 0.7
```
```yaml
settings:
goose_provider: "openai"
goose_model: "gpt-4o"
temperature: 0.3
```
:::note
Settings specified in a recipe will override your default Goose configuration when that recipe is executed. If no settings are specified, Goose will use your configured defaults.
:::
## Sub-Recipes
The `sub_recipes` field specifies the [sub-recipes](/docs/guides/recipes/sub-recipes) that the main recipe calls to perform specific tasks. Each sub-recipe in the array has the following structure:
@@ -379,6 +412,11 @@ extensions:
bundled: true
description: "Query codesearch directly from goose"
settings:
goose_provider: "anthropic"
goose_model: "claude-3-5-sonnet-latest"
temperature: 0.7
retry:
max_retries: 3
timeout_seconds: 30