mirror of
https://github.com/FoundationAgents/MetaGPT.git
synced 2026-04-25 16:56:26 +02:00
133 lines
4.7 KiB
YAML
133 lines
4.7 KiB
YAML
# DO NOT MODIFY THIS FILE, create a new key.yaml, define OPENAI_API_KEY.
|
||
# The configuration of key.yaml has a higher priority and will not enter git
|
||
|
||
#### if OpenAI
|
||
## The official OPENAI_API_BASE is https://api.openai.com/v1
|
||
## If the official OPENAI_API_BASE is not available, we recommend using the [openai-forward](https://github.com/beidongjiedeguang/openai-forward).
|
||
## Or, you can configure OPENAI_PROXY to access official OPENAI_API_BASE.
|
||
OPENAI_API_BASE: "https://api.openai.com/v1"
|
||
#OPENAI_PROXY: "http://127.0.0.1:8118"
|
||
#OPENAI_API_KEY: "YOUR_API_KEY" # set the value to sk-xxx if you host the openai interface for open llm model
|
||
OPENAI_API_MODEL: "gpt-4-1106-preview"
|
||
MAX_TOKENS: 4096
|
||
RPM: 10
|
||
LLM_TYPE: OpenAI # Except for these three major models – OpenAI, MetaGPT LLM, and Azure – other large models can be distinguished based on the validity of the key.
|
||
|
||
#### if Spark
|
||
#SPARK_APPID : "YOUR_APPID"
|
||
#SPARK_API_SECRET : "YOUR_APISecret"
|
||
#SPARK_API_KEY : "YOUR_APIKey"
|
||
#DOMAIN : "generalv2"
|
||
#SPARK_URL : "ws://spark-api.xf-yun.com/v2.1/chat"
|
||
|
||
#### if Anthropic
|
||
#Anthropic_API_KEY: "YOUR_API_KEY"
|
||
|
||
#### if AZURE, check https://github.com/openai/openai-cookbook/blob/main/examples/azure/chat.ipynb
|
||
#### You can use ENGINE or DEPLOYMENT mode
|
||
#OPENAI_API_TYPE: "azure"
|
||
#OPENAI_API_BASE: "YOUR_AZURE_ENDPOINT"
|
||
#OPENAI_API_KEY: "YOUR_AZURE_API_KEY"
|
||
#OPENAI_API_VERSION: "YOUR_AZURE_API_VERSION"
|
||
#DEPLOYMENT_NAME: "YOUR_DEPLOYMENT_NAME"
|
||
#DEPLOYMENT_ID: "YOUR_DEPLOYMENT_ID"
|
||
|
||
#### if zhipuai from `https://open.bigmodel.cn`. You can set here or export API_KEY="YOUR_API_KEY"
|
||
# ZHIPUAI_API_KEY: "YOUR_API_KEY"
|
||
|
||
#### if use self-host open llm model with openai-compatible interface
|
||
#OPEN_LLM_API_BASE: "http://127.0.0.1:8000/v1"
|
||
#OPEN_LLM_API_MODEL: "llama2-13b"
|
||
#
|
||
##### if use Fireworks api
|
||
#FIREWORKS_API_KEY: "YOUR_API_KEY"
|
||
#FIREWORKS_API_BASE: "https://api.fireworks.ai/inference/v1"
|
||
#FIREWORKS_API_MODEL: "YOUR_LLM_MODEL" # example, accounts/fireworks/models/llama-v2-13b-chat
|
||
|
||
#### for Search
|
||
|
||
## Supported values: serpapi/google/serper/ddg
|
||
#SEARCH_ENGINE: serpapi
|
||
|
||
## Visit https://serpapi.com/ to get key.
|
||
#SERPAPI_API_KEY: "YOUR_API_KEY"
|
||
|
||
## Visit https://console.cloud.google.com/apis/credentials to get key.
|
||
#GOOGLE_API_KEY: "YOUR_API_KEY"
|
||
## Visit https://programmablesearchengine.google.com/controlpanel/create to get id.
|
||
#GOOGLE_CSE_ID: "YOUR_CSE_ID"
|
||
|
||
## Visit https://serper.dev/ to get key.
|
||
#SERPER_API_KEY: "YOUR_API_KEY"
|
||
|
||
#### for web access
|
||
|
||
## Supported values: playwright/selenium
|
||
#WEB_BROWSER_ENGINE: playwright
|
||
|
||
## Supported values: chromium/firefox/webkit, visit https://playwright.dev/python/docs/api/class-browsertype
|
||
##PLAYWRIGHT_BROWSER_TYPE: chromium
|
||
|
||
## Supported values: chrome/firefox/edge/ie, visit https://www.selenium.dev/documentation/webdriver/browsers/
|
||
# SELENIUM_BROWSER_TYPE: chrome
|
||
|
||
#### for TTS
|
||
|
||
#AZURE_TTS_SUBSCRIPTION_KEY: "YOUR_API_KEY"
|
||
#AZURE_TTS_REGION: "eastus"
|
||
|
||
#### for Stable Diffusion
|
||
## Use SD service, based on https://github.com/AUTOMATIC1111/stable-diffusion-webui
|
||
#SD_URL: "YOUR_SD_URL"
|
||
#SD_T2I_API: "/sdapi/v1/txt2img"
|
||
|
||
#### for Execution
|
||
#LONG_TERM_MEMORY: false
|
||
|
||
#### for Mermaid CLI
|
||
## If you installed mmdc (Mermaid CLI) only for metagpt then enable the following configuration.
|
||
#PUPPETEER_CONFIG: "./config/puppeteer-config.json"
|
||
#MMDC: "./node_modules/.bin/mmdc"
|
||
|
||
|
||
### for calc_usage
|
||
# CALC_USAGE: false
|
||
|
||
### for Research
|
||
# MODEL_FOR_RESEARCHER_SUMMARY: gpt-3.5-turbo
|
||
# MODEL_FOR_RESEARCHER_REPORT: gpt-3.5-turbo-16k
|
||
|
||
### choose the engine for mermaid conversion,
|
||
# default is nodejs, you can change it to playwright,pyppeteer or ink
|
||
# MERMAID_ENGINE: nodejs
|
||
|
||
### browser path for pyppeteer engine, support Chrome, Chromium,MS Edge
|
||
#PYPPETEER_EXECUTABLE_PATH: "/usr/bin/google-chrome-stable"
|
||
|
||
### for repair non-openai LLM's output when parse json-text if PROMPT_FORMAT=json
|
||
### due to non-openai LLM's output will not always follow the instruction, so here activate a post-process
|
||
### repair operation on the content extracted from LLM's raw output. Warning, it improves the result but not fix all cases.
|
||
# REPAIR_LLM_OUTPUT: false
|
||
|
||
# PROMPT_FORMAT: json #json or markdown
|
||
|
||
### Agent configurations
|
||
# RAISE_NOT_CONFIG_ERROR: true # "true" if the LLM key is not configured, throw a NotConfiguredException, else "false".
|
||
# WORKSPACE_PATH_WITH_UID: false # "true" if using `{workspace}/{uid}` as the workspace path; "false" use `{workspace}`.
|
||
|
||
### Meta Models
|
||
#METAGPT_TEXT_TO_IMAGE_MODEL: MODEL_URL
|
||
|
||
### S3 config
|
||
#S3_ACCESS_KEY: "YOUR_S3_ACCESS_KEY"
|
||
#S3_SECRET_KEY: "YOUR_S3_SECRET_KEY"
|
||
#S3_ENDPOINT_URL: "YOUR_S3_ENDPOINT_URL"
|
||
#S3_SECURE: true # true/false
|
||
#S3_BUCKET: "YOUR_S3_BUCKET"
|
||
|
||
### Redis config
|
||
#REDIS_HOST: "YOUR_REDIS_HOST"
|
||
#REDIS_PORT: "YOUR_REDIS_PORT"
|
||
#REDIS_PASSWORD: "YOUR_REDIS_PASSWORD"
|
||
#REDIS_DB: "YOUR_REDIS_DB_INDEX, str, 0-based"
|
||
|