aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2025-12-17 05:54:26 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
a74548d3cd1ff57bdca13afd5d5281bf972d566c
Auto-GPT/docs/content/AutoGPT/configuration/options.md
Krzysztof Czerwinski a74548d3cd feat(agent): Component-based Agents (#7054) 
This incremental re-architecture unifies Agent code and plugins, so everything is component-based.

## Breaking changes

- Removed command categories and `DISABLED_COMMAND_CATEGORIES` environment variable. Use `DISABLED_COMMANDS` environment variable to disable individual commands.
- Changed `command` decorator; old-style commands are no longer supported. Implement `CommandProvider` on components instead.
- Removed `CommandRegistry`, now all commands are provided by components implementing `CommandProvider`.
- Removed `prompt_config` from `AgentSettings`.
- Removed plugin support: old plugins will no longer be loaded and executed.
- Removed `PromptScratchpad`, it was used by plugins and is no longer needed.
- Changed `ThoughtProcessOutput` from tuple to pydantic `BaseModel`.

## Other changes

- Created `AgentComponent`, protocols and logic to execute them.
- `BaseAgent` and `Agent` is now composed of components.
- Moved some logic from `BaseAgent` to `Agent`.
- Moved agent features and commands to components.
- Removed check if the same operation is about to be executed twice in a row.
- Removed file logging from `FileManagerComponent` (formerly `AgentFileManagerMixin`)
- Updated tests
- Added docs

See [Introduction](https://github.com/kcze/AutoGPT/blob/kpczerwinski/open-440-modular-agents/docs/content/AutoGPT/component%20agent/introduction.md) for more information.
2024-04-22 19:20:01 +02:00

5.0 KiB
Raw Blame History

Configuration

Configuration is controlled through the Config object. You can set configuration variables via the .env file. If you don't have a .env file, create a copy of .env.template in your AutoGPT folder and name it .env.

Environment Variables

  • AI_SETTINGS_FILE: Location of the AI Settings file relative to the AutoGPT root directory. Default: ai_settings.yaml
  • AUDIO_TO_TEXT_PROVIDER: Audio To Text Provider. Only option currently is huggingface. Default: huggingface
  • AUTHORISE_COMMAND_KEY: Key response accepted when authorising commands. Default: y
  • AZURE_CONFIG_FILE: Location of the Azure Config file relative to the AutoGPT root directory. Default: azure.yaml
  • BROWSE_CHUNK_MAX_LENGTH: When browsing website, define the length of chunks to summarize. Default: 3000
  • BROWSE_SPACY_LANGUAGE_MODEL: spaCy language model to use when creating chunks. Default: en_core_web_sm
  • CHAT_MESSAGES_ENABLED: Enable chat messages. Optional
  • DISABLED_COMMANDS: Commands to disable. Use comma separated names of commands. See the list of commands from built-in components here. Default: None
  • ELEVENLABS_API_KEY: ElevenLabs API Key. Optional.
  • ELEVENLABS_VOICE_ID: ElevenLabs Voice ID. Optional.
  • EMBEDDING_MODEL: LLM Model to use for embedding tasks. Default: text-embedding-3-small
  • EXECUTE_LOCAL_COMMANDS: If shell commands should be executed locally. Default: False
  • EXIT_KEY: Exit key accepted to exit. Default: n
  • FAST_LLM: LLM Model to use for most tasks. Default: gpt-3.5-turbo-0125
  • GITHUB_API_KEY: Github API Key. Optional.
  • GITHUB_USERNAME: GitHub Username. Optional.
  • GOOGLE_API_KEY: Google API key. Optional.
  • GOOGLE_CUSTOM_SEARCH_ENGINE_ID: Google custom search engine ID. Optional.
  • HEADLESS_BROWSER: Use a headless browser while AutoGPT uses a web browser. Setting to False will allow you to see AutoGPT operate the browser. Default: True
  • HUGGINGFACE_API_TOKEN: HuggingFace API, to be used for both image generation and audio to text. Optional.
  • HUGGINGFACE_AUDIO_TO_TEXT_MODEL: HuggingFace audio to text model. Default: CompVis/stable-diffusion-v1-4
  • HUGGINGFACE_IMAGE_MODEL: HuggingFace model to use for image generation. Default: CompVis/stable-diffusion-v1-4
  • IMAGE_PROVIDER: Image provider. Options are dalle, huggingface, and sdwebui. Default: dalle
  • IMAGE_SIZE: Default size of image to generate. Default: 256
  • MEMORY_BACKEND: Memory back-end to use. Currently json_file is the only supported and enabled backend. Default: json_file
  • MEMORY_INDEX: Value used in the Memory backend for scoping, naming, or indexing. Default: auto-gpt
  • OPENAI_API_KEY: REQUIRED- Your OpenAI API Key.
  • OPENAI_ORGANIZATION: Organization ID in OpenAI. Optional.
  • PLAIN_OUTPUT: Plain output, which disables the spinner. Default: False
  • PLUGINS_CONFIG_FILE: Path of the Plugins Config file relative to the AutoGPT root directory. Default: plugins_config.yaml
  • PROMPT_SETTINGS_FILE: Location of the Prompt Settings file relative to the AutoGPT root directory. Default: prompt_settings.yaml
  • REDIS_HOST: Redis Host. Default: localhost
  • REDIS_PASSWORD: Redis Password. Optional. Default:
  • REDIS_PORT: Redis Port. Default: 6379
  • RESTRICT_TO_WORKSPACE: The restrict file reading and writing to the workspace directory. Default: True
  • SD_WEBUI_AUTH: Stable Diffusion Web UI username:password pair. Optional.
  • SD_WEBUI_URL: Stable Diffusion Web UI URL. Default: http://localhost:7860
  • SHELL_ALLOWLIST: List of shell commands that ARE allowed to be executed by AutoGPT. Only applies if SHELL_COMMAND_CONTROL is set to allowlist. Default: None
  • SHELL_COMMAND_CONTROL: Whether to use allowlist or denylist to determine what shell commands can be executed (Default: denylist)
  • SHELL_DENYLIST: List of shell commands that ARE NOT allowed to be executed by AutoGPT. Only applies if SHELL_COMMAND_CONTROL is set to denylist. Default: sudo,su
  • SMART_LLM: LLM Model to use for "smart" tasks. Default: gpt-4-turbo-preview
  • STREAMELEMENTS_VOICE: StreamElements voice to use. Default: Brian
  • TEMPERATURE: Value of temperature given to OpenAI. Value from 0 to 2. Lower is more deterministic, higher is more random. See https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature
  • TEXT_TO_SPEECH_PROVIDER: Text to Speech Provider. Options are gtts, macos, elevenlabs, and streamelements. Default: gtts
  • USER_AGENT: User-Agent given when browsing websites. Default: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.97 Safari/537.36"
  • USE_AZURE: Use Azure's LLM Default: False
  • USE_WEB_BROWSER: Which web browser to use. Options are chrome, firefox, safari or edge Default: chrome
  • WIPE_REDIS_ON_START: Wipes data / index on start. Default: True