aljaz/Auto-GPT
1
0
Fork 0
mirror of https://github.com/aljazceru/Auto-GPT.git synced 2026-01-01 21:34:27 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
abb397e442e84815876541b12bfcded027e31bab
Auto-GPT/docs/configuration/options.md
Luke K (pr-0f3t) abb397e442 Release v0.4.1 (#4686) 
Co-authored-by: Reinier van der Leer <github@pwuts.nl>
Co-authored-by: Nicholas Tindle <nick@ntindle.com>
Co-authored-by: Nicholas Tindle <nicktindle@outlook.com>
Co-authored-by: k-boikov <64261260+k-boikov@users.noreply.github.com>
Co-authored-by: merwanehamadi <merwanehamadi@gmail.com>
Co-authored-by: Merwane Hamadi <merwanehamadi@gmail.com>
Co-authored-by: Richard Beales <rich@richbeales.net>
Co-authored-by: Luke K <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Luke K (pr-0f3t) <2609441+lc0rp@users.noreply.github.com>
Co-authored-by: Erik Peterson <e@eriklp.com>
Co-authored-by: Auto-GPT-Bot <github-bot@agpt.co>
Co-authored-by: Benny van der Lans <49377421+bfalans@users.noreply.github.com>
Co-authored-by: Jan <jan-github@phobia.de>
Co-authored-by: Robin Richtsfeld <robin.richtsfeld@gmail.com>
Co-authored-by: Marc Bornträger <marc.borntraeger@gmail.com>
Co-authored-by: Stefan Ayala <stefanayala3266@gmail.com>
Co-authored-by: javableu <45064273+javableu@users.noreply.github.com>
Co-authored-by: DGdev91 <DGdev91@users.noreply.github.com>
Co-authored-by: Kinance <kinance@gmail.com>
Co-authored-by: digger yu <digger-yu@outlook.com>
Co-authored-by: David <scenaristeur@gmail.com>
Co-authored-by: gravelBridge <john.tian31@gmail.com>
Fix Python CI "update cassettes" step (#4591)
fix CI (#4596)
Fix inverted logic for deny_command (#4563)
fix current_score.json generation (#4601)
Fix duckduckgo rate limiting (#4592)
Fix debug code challenge (#4632)
Fix issues with information retrieval challenge a (#4622)
fix issues with env configuration and .env.template (#4630)
Fix prompt issue causing 'No Command' issues and challenge to fail (#4623)
Fix benchmark logs (#4653)
Fix typo in docs/setup.md (#4613)
Fix run.sh shebang (#4561)
Fix autogpt docker image not working because missing prompt_settings (#4680)
Fix execute_command coming from plugins (#4730)
2023-06-19 12:41:40 -04:00

4.8 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 Auto-GPT folder and name it .env.

Environment Variables

  • AI_SETTINGS_FILE: Location of AI Settings file. 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
  • 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_COMMAND_CATEGORIES: Command categories to disable. Command categories are Python module names, e.g. autogpt.commands.analyze_code. See the directory autogpt/commands in the source for all command modules. 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-ada-002
  • EXECUTE_LOCAL_COMMANDS: If shell commands should be executed locally. Default: False
  • EXIT_KEY: Exit key accepted to exit. Default: n
  • FAST_LLM_MODEL: LLM Model to use for most tasks. Default: gpt-3.5-turbo
  • 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 Auto-GPT uses a web browser. Setting to False will allow you to see Auto-GPT 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 plugins_config.yaml file. Default: plugins_config.yaml
  • PROMPT_SETTINGS_FILE: Location of Prompt Settings file. 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 Auto-GPT. 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 Auto-GPT. Only applies if SHELL_COMMAND_CONTROL is set to denylist. Default: sudo,su
  • SMART_LLM_MODEL: LLM Model to use for "smart" tasks. Default: gpt-3.5-turbo
  • 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