copy dicts before modifying (#551)

* copy dicts before modifying * update notebooks * update notebooks * close #567
microsoft · Nov 6, 2023 · 306ac4d · 306ac4d
1 parent 8593807
commit 306ac4d
Show file tree

Hide file tree

Showing 16 changed files with 252 additions and 512 deletions.
diff --git a/autogen/oai/client.py b/autogen/oai/client.py
@@ -70,7 +70,8 @@ def __init__(self, *, config_list: List[Dict] = None, **base_config):
         if type(config_list) is list and len(config_list) == 0:
             logger.warning("openai client was provided with an empty config_list, which may not be intended.")
         if config_list:
-            self._clients = [self._client(config, openai_config) for config in config_list]
+            config_list = [config.copy() for config in config_list]  # make a copy before modifying
+            self._clients = [self._client(config, openai_config) for config in config_list]  # could modify the config
             self._config_list = [
                 {**extra_kwargs, **{k: v for k, v in config.items() if k not in self.openai_kwargs}}
                 for config in config_list
@@ -108,9 +109,9 @@ def _process_for_azure(self, config: Dict, extra_kwargs: Dict, segment: str = "d
             base_url = config.get("base_url")
             if base_url is None:
                 raise ValueError("to use azure openai api, base_url must be specified.")
-            suffix = f"openai/deployments/{model}"
+            suffix = f"/openai/deployments/{model}"
             if not base_url.endswith(suffix):
-                config["base_url"] += suffix
+                config["base_url"] += suffix[1:] if base_url.endswith("/") else suffix
 
     def _separate_openai_config(self, config):
         """Separate the config into openai_config and extra_kwargs."""

diff --git a/autogen/oai/openai_utils.py b/autogen/oai/openai_utils.py
@@ -83,26 +83,26 @@ def config_list_openai_aoai(
                 os.environ["OPENAI_API_KEY"] = key_file.read().strip()
         except FileNotFoundError:
             logging.info(
-                "To use OpenAI API, please set OPENAI_API_KEY in os.environ "
-                "or create key_openai.txt in the specified path, or specify the api_key in config_list."
+                "OPENAI_API_KEY is not found in os.environ "
+                "and key_openai.txt is not found in the specified path. You can specify the api_key in the config_list."
             )
     if "AZURE_OPENAI_API_KEY" not in os.environ and exclude != "aoai":
         try:
             with open(f"{key_file_path}/{aoai_api_key_file}") as key_file:
                 os.environ["AZURE_OPENAI_API_KEY"] = key_file.read().strip()
         except FileNotFoundError:
             logging.info(
-                "To use Azure OpenAI API, please set AZURE_OPENAI_API_KEY in os.environ "
-                "or create key_aoai.txt in the specified path, or specify the api_key in config_list."
+                "AZURE_OPENAI_API_KEY is not found in os.environ "
+                "and key_aoai.txt is not found in the specified path. You can specify the api_key in the config_list."
             )
     if "AZURE_OPENAI_API_BASE" not in os.environ and exclude != "aoai":
         try:
             with open(f"{key_file_path}/{aoai_api_base_file}") as key_file:
                 os.environ["AZURE_OPENAI_API_BASE"] = key_file.read().strip()
         except FileNotFoundError:
             logging.info(
-                "To use Azure OpenAI API, please set AZURE_OPENAI_API_BASE in os.environ "
-                "or create base_aoai.txt in the specified path, or specify the api_base in config_list."
+                "AZURE_OPENAI_API_BASE is not found in os.environ "
+                "and base_aoai.txt is not found in the specified path. You can specify the base_url in the config_list."
             )
     aoai_config = (
         get_config_list(
@@ -111,7 +111,7 @@ def config_list_openai_aoai(
             # Assuming Azure OpenAI api bases in os.environ["AZURE_OPENAI_API_BASE"], in separated lines
             base_urls=os.environ.get("AZURE_OPENAI_API_BASE", "").split("\n"),
             api_type="azure",
-            api_version="2023-07-01-preview",  # change if necessary
+            api_version="2023-08-01-preview",  # change if necessary
         )
         if exclude != "aoai"
         else []

diff --git a/autogen/version.py b/autogen/version.py
@@ -1 +1 @@
-__version__ = "0.2.0b1"
+__version__ = "0.2.0b2"
diff --git a/notebook/agentchat_auto_feedback_from_code_execution.ipynb b/notebook/agentchat_auto_feedback_from_code_execution.ipynb
@@ -45,7 +45,7 @@
    },
    "outputs": [],
    "source": [
-    "# %pip install pyautogen~=0.1.0"
+    "# %pip install pyautogen~=0.2.0b2"
    ]
   },
   {
@@ -105,9 +105,7 @@
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choose \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {

diff --git a/notebook/agentchat_chess.ipynb b/notebook/agentchat_chess.ipynb
@@ -35,7 +35,7 @@
    "outputs": [],
    "source": [
     "%%capture --no-stderr\n",
-    "# %pip install pyautogen~=0.1.0\n",
+    "# %pip install \"pyautogen~=0.2.0b2\"\n",
     "%pip install chess -U"
    ]
   },
@@ -119,9 +119,7 @@
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choosing \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {

diff --git a/notebook/agentchat_function_call.ipynb b/notebook/agentchat_function_call.ipynb
diff --git a/notebook/agentchat_groupchat.ipynb b/notebook/agentchat_groupchat.ipynb
@@ -35,7 +35,7 @@
    "outputs": [],
    "source": [
     "%%capture --no-stderr\n",
-    "# %pip install pyautogen~=0.1.0"
+    "# %pip install pyautogen~=0.2.0b2"
    ]
   },
   {
@@ -107,9 +107,7 @@
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choose \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {

diff --git a/notebook/agentchat_groupchat_RAG.ipynb b/notebook/agentchat_groupchat_RAG.ipynb
@@ -91,15 +91,13 @@
     "        \"model\": \"gpt-35-turbo-0631\",  # 0631 or newer is needed to use functions\n",
     "        \"base_url\": \"<your Azure OpenAI API base>\", \n",
     "        \"api_type\": \"azure\", \n",
-    "        \"api_version\": \"2023-07-01-preview\", # 2023-07-01-preview or newer is needed to use functions\n",
+    "        \"api_version\": \"2023-08-01-preview\", # 2023-07-01-preview or newer is needed to use functions\n",
     "        \"api_key\": \"<your Azure OpenAI API key>\"\n",
     "    }\n",
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choose \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {
@@ -424,6 +422,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -1087,6 +1086,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [

diff --git a/notebook/agentchat_groupchat_research.ipynb b/notebook/agentchat_groupchat_research.ipynb
@@ -33,7 +33,7 @@
    "outputs": [],
    "source": [
     "%%capture --no-stderr\n",
-    "# %pip install pyautogen~=0.1.0"
+    "# %pip install pyautogen~=0.2.0b2"
    ]
   },
   {
@@ -93,9 +93,7 @@
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choosing \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {

diff --git a/notebook/agentchat_groupchat_vis.ipynb b/notebook/agentchat_groupchat_vis.ipynb
@@ -33,7 +33,7 @@
    "outputs": [],
    "source": [
     "%%capture --no-stderr\n",
-    "# %pip install pyautogen~=0.1.0"
+    "# %pip install pyautogen~=0.2.0b2"
    ]
   },
   {
@@ -93,21 +93,19 @@
     "        'api_key': '<your Azure OpenAI API key here>',\n",
     "        'base_url': '<your Azure OpenAI API base here>',\n",
     "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
+    "        'api_version': '2023-08-01-preview',\n",
     "    },\n",
     "    {\n",
     "        'model': 'gpt-4-32k',\n",
     "        'api_key': '<your Azure OpenAI API key here>',\n",
     "        'base_url': '<your Azure OpenAI API base here>',\n",
     "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
+    "        'api_version': '2023-08-01-preview',\n",
     "    },\n",
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choose \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {
@@ -119,6 +117,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -1038,7 +1037,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.11.4"
   },
   "orig_nbformat": 4
  },

diff --git a/notebook/agentchat_human_feedback.ipynb b/notebook/agentchat_human_feedback.ipynb
@@ -45,7 +45,7 @@
    },
    "outputs": [],
    "source": [
-    "# %pip install pyautogen~=0.1.0"
+    "# %pip install pyautogen~=0.2.0b2"
    ]
   },
   {
@@ -74,53 +74,33 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "It first looks for environment variable \"OAI_CONFIG_LIST\" which needs to be a valid json string. If that variable is not found, it then looks for a json file named \"OAI_CONFIG_LIST\".\n",
+    "It first looks for environment variable \"OAI_CONFIG_LIST\" which needs to be a valid json string. If that variable is not found, it then looks for a json file named \"OAI_CONFIG_LIST\". It filters the configs by models (you can filter by other keys as well). Only the models with matching names are kept in the list based on the filter condition.\n",
     "\n",
     "The config list looks like the following:\n",
     "```python\n",
     "config_list = [\n",
     "    {\n",
     "        'model': 'gpt-4',\n",
     "        'api_key': '<your OpenAI API key here>',\n",
-    "    },  # OpenAI API endpoint for gpt-4\n",
-    "    {\n",
-    "        'model': 'gpt-4',\n",
-    "        'api_key': '<your first Azure OpenAI API key here>',\n",
-    "        'base_url': '<your first Azure OpenAI API base here>',\n",
-    "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
-    "    },  # Azure OpenAI API endpoint for gpt-4\n",
-    "    {\n",
-    "        'model': 'gpt-4',\n",
-    "        'api_key': '<your second Azure OpenAI API key here>',\n",
-    "        'base_url': '<your second Azure OpenAI API base here>',\n",
-    "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
-    "    },  # another Azure OpenAI API endpoint for gpt-4\n",
+    "    },\n",
     "    {\n",
     "        'model': 'gpt-3.5-turbo',\n",
-    "        'api_key': '<your OpenAI API key here>',\n",
-    "    },  # OpenAI API endpoint for gpt-3.5-turbo\n",
-    "    {\n",
-    "        'model': 'gpt-3.5-turbo',\n",
-    "        'api_key': '<your first Azure OpenAI API key here>',\n",
-    "        'base_url': '<your first Azure OpenAI API base here>',\n",
+    "        'api_key': '<your Azure OpenAI API key here>',\n",
+    "        'base_url': '<your Azure OpenAI API base here>',\n",
     "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
-    "    },  # Azure OpenAI API endpoint for gpt-3.5-turbo\n",
+    "        'api_version': '2023-08-01-preview',\n",
+    "    },\n",
     "    {\n",
-    "        'model': 'gpt-3.5-turbo',\n",
-    "        'api_key': '<your second Azure OpenAI API key here>',\n",
-    "        'base_url': '<your second Azure OpenAI API base here>',\n",
+    "        'model': 'gpt-3.5-turbo-16k',\n",
+    "        'api_key': '<your Azure OpenAI API key here>',\n",
+    "        'base_url': '<your Azure OpenAI API base here>',\n",
     "        'api_type': 'azure',\n",
-    "        'api_version': '2023-06-01-preview',\n",
-    "    },  # another Azure OpenAI API endpoint for gpt-3.5-turbo\n",
+    "        'api_version': '2023-08-01-preview',\n",
+    "    },\n",
     "]\n",
     "```\n",
     "\n",
-    "If you open this notebook in colab, you can upload your files by clicking the file icon on the left panel and then choosing \"upload file\" icon.\n",
-    "\n",
-    "You can set the value of config_list in other ways you prefer, e.g., loading from a YAML file."
+    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
    ]
   },
   {