diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/ai/settings.md | 41 |
1 files changed, 29 insertions, 12 deletions
diff --git a/docs/docs/ai/settings.md b/docs/docs/ai/settings.md index ad7c7af7..83b6bf63 100644 --- a/docs/docs/ai/settings.md +++ b/docs/docs/ai/settings.md @@ -8,6 +8,35 @@ Default: `false` Whether or not the AI feature are enabled. When set to `false`, the question mark keybinding will output a message with instructions to run `atuin setup` to enable the feature. +### endpoint + +Default: `null` + +The address of the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. + +### api_token + +Default: `null` + +The API token for the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. + +## Capabilities + +Settings that control what capabilities are sent to the LLM. These are specified under `[ai.capabilities]`. + +### enable_history_search + +Default: `true` + +Whether or not to include the "history search" capability in the context sent to the LLM. This allows the AI to request to search your command history for relevant commands when generating suggestions or answering questions. + +**Example config** + +```toml +[ai.capabilities] +enable_history_search = false +``` + ## Opening context Settings that control what context is sent in the opening AI request. These are specified under `[ai.opening]`. @@ -37,15 +66,3 @@ Whether or not to send your previous command as context in the initial request, [ai.opening] send_last_command = true ``` - -### endpoint - -Default: `null` - -The address of the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. - -### api_token - -Default: `null` - -The API token for the Atuin AI endpoint. Used for AI features like command generation. Most users will not need this setting; it is only necessary for custom AI endpoints. |