diff --git a/config/config.yaml b/config/config.yaml deleted file mode 100644 index 6dff55b4e..000000000 --- a/config/config.yaml +++ /dev/null @@ -1,144 +0,0 @@ -# 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 - -#### Project Path Setting -# WORKSPACE_PATH: "Path for placing output files" - -#### if OpenAI -## The official OPENAI_BASE_URL is https://api.openai.com/v1 -## If the official OPENAI_BASE_URL 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_BASE_URL. -OPENAI_BASE_URL: "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 -TIMEOUT: 60 # Timeout for llm invocation -#DEFAULT_PROVIDER: openai - -#### 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 -#OPENAI_API_TYPE: "azure" -#OPENAI_BASE_URL: "YOUR_AZURE_ENDPOINT" -#OPENAI_API_KEY: "YOUR_AZURE_API_KEY" -#OPENAI_API_VERSION: "YOUR_AZURE_API_VERSION" -#DEPLOYMENT_NAME: "YOUR_DEPLOYMENT_NAME" - -#### 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 Google Gemini from `https://ai.google.dev/` and API_KEY from `https://makersuite.google.com/app/apikey`. -#### You can set here or export GOOGLE_API_KEY="YOUR_API_KEY" -# GEMINI_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 - -#### if use self-host open llm model by ollama -# OLLAMA_API_BASE: http://127.0.0.1:11434/api -# OLLAMA_API_MODEL: llama2 - -#### 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" - -# DISABLE_LLM_PROVIDER_CHECK: false diff --git a/config/config2.yaml.example b/config/config2.yaml.example index 2c655f881..35575e5a5 100644 --- a/config/config2.yaml.example +++ b/config/config2.yaml.example @@ -1,33 +1,20 @@ llm: - gpt3t: - base_url: "YOUR_BASE_URL" - api_key: "YOUR_API_KEY" - model: "gpt-3.5-turbo-1106" # or gpt-4-1106-preview - azure-gpt3t: - api_type: "azure" - base_url: "YOUR_BASE_URL" - api_key: "YOUR_API_KEY" - model: "gpt35turbo" - -search: - serpapi: - api_type: "serpapi" - api_key: "YOUR_API_KEY" - google: - api_type: "google" - api_key: "YOUR_API_KEY" - cse_id: "YOUR_CSE_ID" - serper: - api_type: "serper" - api_key: "YOUR_API_KEY" - -mermaid: - pyppeteer: - engine: "pyppeteer" - path: "/Applications/Google Chrome.app" + api_type: "openai" + base_url: "YOUR_BASE_URL" + api_key: "YOUR_API_KEY" + model: "gpt-3.5-turbo-1106" # or gpt-4-1106-preview proxy: "YOUR_PROXY" +search: + api_type: "google" + api_key: "YOUR_API_KEY" + cse_id: "YOUR_CSE_ID" + +mermaid: + engine: "pyppeteer" + path: "/Applications/Google Chrome.app" + redis: host: "YOUR_HOST" port: 32582 @@ -36,7 +23,7 @@ redis: s3: access_key: "YOUR_ACCESS_KEY" - secret_key: "YOUR_SECRET_KEY + secret_key: "YOUR_SECRET_KEY" endpoint: "YOUR_ENDPOINT" secure: false bucket: "test" diff --git a/config/config2.yaml.mock b/config/config2.yaml.mock deleted file mode 100644 index 2c655f881..000000000 --- a/config/config2.yaml.mock +++ /dev/null @@ -1,55 +0,0 @@ -llm: - gpt3t: - base_url: "YOUR_BASE_URL" - api_key: "YOUR_API_KEY" - model: "gpt-3.5-turbo-1106" # or gpt-4-1106-preview - azure-gpt3t: - api_type: "azure" - base_url: "YOUR_BASE_URL" - api_key: "YOUR_API_KEY" - model: "gpt35turbo" - -search: - serpapi: - api_type: "serpapi" - api_key: "YOUR_API_KEY" - google: - api_type: "google" - api_key: "YOUR_API_KEY" - cse_id: "YOUR_CSE_ID" - serper: - api_type: "serper" - api_key: "YOUR_API_KEY" - -mermaid: - pyppeteer: - engine: "pyppeteer" - path: "/Applications/Google Chrome.app" - -proxy: "YOUR_PROXY" - -redis: - host: "YOUR_HOST" - port: 32582 - password: "YOUR_PASSWORD" - db: "0" - -s3: - access_key: "YOUR_ACCESS_KEY" - secret_key: "YOUR_SECRET_KEY - endpoint: "YOUR_ENDPOINT" - secure: false - bucket: "test" - - -AZURE_TTS_SUBSCRIPTION_KEY: "YOUR_SUBSCRIPTION_KEY" -AZURE_TTS_REGION: "eastus" - -IFLYTEK_APP_ID: "YOUR_APP_ID" -IFLYTEK_API_KEY: "YOUR_API_KEY" -IFLYTEK_API_SECRET: "YOUR_API_SECRET" - -METAGPT_TEXT_TO_IMAGE_MODEL_URL: "YOUR_MODEL_URL" - -PYPPETEER_EXECUTABLE_PATH: "/Applications/Google Chrome.app" - diff --git a/metagpt/config.py b/metagpt/config.py deleted file mode 100644 index 952ccc962..000000000 --- a/metagpt/config.py +++ /dev/null @@ -1,270 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -""" -Provide configuration, singleton -@Modified By: mashenquan, 2023/11/27. - 1. According to Section 2.2.3.11 of RFC 135, add git repository support. - 2. Add the parameter `src_workspace` for the old version project path. -""" -import datetime -import json -import os -import warnings -from copy import deepcopy -from pathlib import Path -from typing import Any -from uuid import uuid4 - -import yaml - -from metagpt.configs.llm_config import LLMType -from metagpt.const import DEFAULT_WORKSPACE_ROOT, METAGPT_ROOT, OPTIONS -from metagpt.logs import logger -from metagpt.tools import SearchEngineType, WebBrowserEngineType -from metagpt.utils.common import require_python_version -from metagpt.utils.cost_manager import CostManager -from metagpt.utils.singleton import Singleton - - -class NotConfiguredException(Exception): - """Exception raised for errors in the configuration. - - Attributes: - message -- explanation of the error - """ - - def __init__(self, message="The required configuration is not set"): - self.message = message - super().__init__(self.message) - - -class Config(metaclass=Singleton): - """ - Regular usage method: - config = Config("config.yaml") - secret_key = config.get_key("MY_SECRET_KEY") - print("Secret key:", secret_key) - """ - - _instance = None - home_yaml_file = Path.home() / ".metagpt/config.yaml" - key_yaml_file = METAGPT_ROOT / "config/key.yaml" - default_yaml_file = METAGPT_ROOT / "config/config.yaml" - - def __init__(self, yaml_file=default_yaml_file, cost_data=""): - global_options = OPTIONS.get() - # cli paras - self.project_path = "" - self.project_name = "" - self.inc = False - self.reqa_file = "" - self.max_auto_summarize_code = 0 - self.git_reinit = False - - self._init_with_config_files_and_env(yaml_file) - # The agent needs to be billed per user, so billing information cannot be destroyed when the session ends. - self.cost_manager = CostManager(**json.loads(cost_data)) if cost_data else CostManager() - self._update() - global_options.update(OPTIONS.get()) - logger.debug("Config loading done.") - - def get_default_llm_provider_enum(self) -> LLMType: - """Get first valid LLM provider enum""" - mappings = { - LLMType.OPENAI: bool( - self._is_valid_llm_key(self.OPENAI_API_KEY) and not self.OPENAI_API_TYPE and self.OPENAI_API_MODEL - ), - LLMType.ANTHROPIC: self._is_valid_llm_key(self.ANTHROPIC_API_KEY), - LLMType.ZHIPUAI: self._is_valid_llm_key(self.ZHIPUAI_API_KEY), - LLMType.FIREWORKS: self._is_valid_llm_key(self.FIREWORKS_API_KEY), - LLMType.OPEN_LLM: self._is_valid_llm_key(self.OPEN_LLM_API_BASE), - LLMType.GEMINI: self._is_valid_llm_key(self.GEMINI_API_KEY), - LLMType.METAGPT: bool(self._is_valid_llm_key(self.OPENAI_API_KEY) and self.OPENAI_API_TYPE == "metagpt"), - LLMType.AZURE: bool( - self._is_valid_llm_key(self.OPENAI_API_KEY) - and self.OPENAI_API_TYPE == "azure" - and self.DEPLOYMENT_NAME - and self.OPENAI_API_VERSION - ), - LLMType.OLLAMA: self._is_valid_llm_key(self.OLLAMA_API_BASE), - } - provider = None - for k, v in mappings.items(): - if v: - provider = k - break - if provider is None: - if self.DEFAULT_PROVIDER: - provider = LLMType(self.DEFAULT_PROVIDER) - else: - raise NotConfiguredException("You should config a LLM configuration first") - - if provider is LLMType.GEMINI and not require_python_version(req_version=(3, 10)): - warnings.warn("Use Gemini requires Python >= 3.10") - model_name = self.get_model_name(provider=provider) - if model_name: - logger.info(f"{provider} Model: {model_name}") - if provider: - logger.info(f"API: {provider}") - return provider - - def get_model_name(self, provider=None) -> str: - provider = provider or self.get_default_llm_provider_enum() - model_mappings = { - LLMType.OPENAI: self.OPENAI_API_MODEL, - LLMType.AZURE: self.DEPLOYMENT_NAME, - } - return model_mappings.get(provider, "") - - @staticmethod - def _is_valid_llm_key(k: str) -> bool: - return bool(k and k != "YOUR_API_KEY") - - def _update(self): - self.global_proxy = self._get("GLOBAL_PROXY") - - self.openai_api_key = self._get("OPENAI_API_KEY") - self.anthropic_api_key = self._get("ANTHROPIC_API_KEY") - self.zhipuai_api_key = self._get("ZHIPUAI_API_KEY") - self.open_llm_api_base = self._get("OPEN_LLM_API_BASE") - self.open_llm_api_model = self._get("OPEN_LLM_API_MODEL") - self.fireworks_api_key = self._get("FIREWORKS_API_KEY") - self.gemini_api_key = self._get("GEMINI_API_KEY") - self.ollama_api_base = self._get("OLLAMA_API_BASE") - self.ollama_api_model = self._get("OLLAMA_API_MODEL") - - # if not self._get("DISABLE_LLM_PROVIDER_CHECK"): - # _ = self.get_default_llm_provider_enum() - - self.openai_base_url = self._get("OPENAI_BASE_URL") - self.openai_proxy = self._get("OPENAI_PROXY") or self.global_proxy - self.openai_api_type = self._get("OPENAI_API_TYPE") - self.openai_api_version = self._get("OPENAI_API_VERSION") - self.openai_api_rpm = self._get("RPM", 3) - self.openai_api_model = self._get("OPENAI_API_MODEL", "gpt-4-1106-preview") - self.max_tokens_rsp = self._get("MAX_TOKENS", 2048) - self.deployment_name = self._get("DEPLOYMENT_NAME", "gpt-4") - - self.spark_appid = self._get("SPARK_APPID") - self.spark_api_secret = self._get("SPARK_API_SECRET") - self.spark_api_key = self._get("SPARK_API_KEY") - self.domain = self._get("DOMAIN") - self.spark_url = self._get("SPARK_URL") - - self.fireworks_api_base = self._get("FIREWORKS_API_BASE") - self.fireworks_api_model = self._get("FIREWORKS_API_MODEL") - - self.claude_api_key = self._get("ANTHROPIC_API_KEY") - - self.serpapi_api_key = self._get("SERPAPI_API_KEY") - self.serper_api_key = self._get("SERPER_API_KEY") - self.google_api_key = self._get("GOOGLE_API_KEY") - self.google_cse_id = self._get("GOOGLE_CSE_ID") - self.search_engine = SearchEngineType(self._get("SEARCH_ENGINE", SearchEngineType.SERPAPI_GOOGLE)) - self.web_browser_engine = WebBrowserEngineType(self._get("WEB_BROWSER_ENGINE", WebBrowserEngineType.PLAYWRIGHT)) - self.playwright_browser_type = self._get("PLAYWRIGHT_BROWSER_TYPE", "chromium") - self.selenium_browser_type = self._get("SELENIUM_BROWSER_TYPE", "chrome") - - self.long_term_memory = self._get("LONG_TERM_MEMORY", False) - if self.long_term_memory: - logger.warning("LONG_TERM_MEMORY is True") - self.cost_manager.max_budget = self._get("MAX_BUDGET", 10.0) - self.code_review_k_times = 2 - - self.puppeteer_config = self._get("PUPPETEER_CONFIG", "") - self.mmdc = self._get("MMDC", "mmdc") - self.calc_usage = self._get("CALC_USAGE", True) - self.model_for_researcher_summary = self._get("MODEL_FOR_RESEARCHER_SUMMARY") - self.model_for_researcher_report = self._get("MODEL_FOR_RESEARCHER_REPORT") - self.mermaid_engine = self._get("MERMAID_ENGINE", "nodejs") - self.pyppeteer_executable_path = self._get("PYPPETEER_EXECUTABLE_PATH", "") - - workspace_uid = ( - self._get("WORKSPACE_UID") or f"{datetime.datetime.now().strftime('%Y%m%d%H%M%S')}-{uuid4().hex[-8:]}" - ) - self.repair_llm_output = self._get("REPAIR_LLM_OUTPUT", False) - self.prompt_schema = self._get("PROMPT_FORMAT", "json") - self.workspace_path = Path(self._get("WORKSPACE_PATH", DEFAULT_WORKSPACE_ROOT)) - val = self._get("WORKSPACE_PATH_WITH_UID") - if val and val.lower() == "true": # for agent - self.workspace_path = self.workspace_path / workspace_uid - self._ensure_workspace_exists() - self.max_auto_summarize_code = self.max_auto_summarize_code or self._get("MAX_AUTO_SUMMARIZE_CODE", 1) - self.timeout = int(self._get("TIMEOUT", 60)) - - def update_via_cli(self, project_path, project_name, inc, reqa_file, max_auto_summarize_code): - """update config via cli""" - - # Use in the PrepareDocuments action according to Section 2.2.3.5.1 of RFC 135. - if project_path: - inc = True - project_name = project_name or Path(project_path).name - self.project_path = project_path - self.project_name = project_name - self.inc = inc - self.reqa_file = reqa_file - self.max_auto_summarize_code = max_auto_summarize_code - - def _ensure_workspace_exists(self): - self.workspace_path.mkdir(parents=True, exist_ok=True) - logger.debug(f"WORKSPACE_PATH set to {self.workspace_path}") - - def _init_with_config_files_and_env(self, yaml_file): - """Load from config/key.yaml, config/config.yaml, and env in decreasing order of priority""" - configs = dict(os.environ) - - for _yaml_file in [yaml_file, self.key_yaml_file, self.home_yaml_file]: - if not _yaml_file.exists(): - continue - - # Load local YAML file - with open(_yaml_file, "r", encoding="utf-8") as file: - yaml_data = yaml.safe_load(file) - if not yaml_data: - continue - configs.update(yaml_data) - OPTIONS.set(configs) - - @staticmethod - def _get(*args, **kwargs): - i = OPTIONS.get() - return i.get(*args, **kwargs) - - def get(self, key, *args, **kwargs): - """Retrieve values from config/key.yaml, config/config.yaml, and environment variables. - Throw an error if not found.""" - value = self._get(key, *args, **kwargs) - if value is None: - raise ValueError(f"Key '{key}' not found in environment variables or in the YAML file") - return value - - def __setattr__(self, name: str, value: Any) -> None: - OPTIONS.get()[name] = value - - def __getattr__(self, name: str) -> Any: - i = OPTIONS.get() - return i.get(name) - - def set_context(self, options: dict): - """Update current config""" - if not options: - return - opts = deepcopy(OPTIONS.get()) - opts.update(options) - OPTIONS.set(opts) - self._update() - - @property - def options(self): - """Return all key-values""" - return OPTIONS.get() - - def new_environ(self): - """Return a new os.environ object""" - env = os.environ.copy() - i = self.options - env.update({k: v for k, v in i.items() if isinstance(v, str)}) - return env - - -CONFIG = Config() diff --git a/tests/metagpt/utils/test_config.py b/tests/metagpt/utils/test_config.py deleted file mode 100644 index 4ca7a225c..000000000 --- a/tests/metagpt/utils/test_config.py +++ /dev/null @@ -1,38 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -""" -@Time : 2023/5/1 11:19 -@Author : alexanderwu -@File : test_config.py -@Modified By: mashenquan, 2013/8/20, Add `test_options`; remove global configuration `CONFIG`, enable configuration support for business isolation. -""" -from pathlib import Path - -import pytest - -from metagpt.config import Config - - -def test_config_class_get_key_exception(): - with pytest.raises(Exception) as exc_info: - config = Config() - config.get("wtf") - assert str(exc_info.value) == "Key 'wtf' not found in environment variables or in the YAML file" - - -def test_config_yaml_file_not_exists(): - # FIXME: 由于这里是单例，所以会导致Config重新创建失效。后续要将Config改为非单例模式。 - _ = Config("wtf.yaml") - # with pytest.raises(Exception) as exc_info: - # config.get("OPENAI_BASE_URL") - # assert str(exc_info.value) == "Set OPENAI_API_KEY or Anthropic_API_KEY first" - - -def test_options(): - filename = Path(__file__).resolve().parent.parent.parent.parent / "config/config.yaml" - config = Config(filename) - assert config.options - - -if __name__ == "__main__": - test_options()