From c783766f15135cbaca413542be06f36c89aab930 Mon Sep 17 00:00:00 2001
From: Ivan Gabriele <ivangabriele@users.noreply.github.com>
Date: Tue, 17 Oct 2023 01:47:05 +0000
Subject: [PATCH] docs(config): clean & prepare for Functionary integration

---
 env.sample.jsonc | 49 ++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 45 insertions(+), 4 deletions(-)

diff --git a/env.sample.jsonc b/env.sample.jsonc
index bfeae1a..f236d6b 100644
--- a/env.sample.jsonc
+++ b/env.sample.jsonc
@@ -1,19 +1,31 @@
 {
+  // ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
   // Brave Search API Key
+
   // Used by agent function `search_web()` which agents can use to help with their task
   // https://brave.com/search/api/ (there is a free plan)
   // "Data for AI" plan is prefered over "Data for Search" since it includes some useful additional props
   "brave_search_api_key": "[BRAVE_SEARCH_API_KEY]",
 
+  // ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+  // Current Model
+
   // Selected `model` that agents must use in the list of OpenAI API endpoints
-  "current_model": "gpt-4-32k",
+  "current_model": "Open-Orca/Mistral-7B-OpenOrca",
+
+  // ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+  // Project Description
 
   // Description of the program you want the agents to develop
-  // You can also set it to `null` if you want the Product Owner agent to prompt you each time you run OADS.
-  "initial_project_description": "Quickly develop and run a basic CLI snake game in Python.",
+  // You can also set it to `null` if you want the Product Owner agent
+  // to prompt you for your project desciption each time you run OADS.
+  "initial_project_description": "Create a \"guess the number\" CLI game in Python.",
+
+  // ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+  // List of OpenAI-Compatible API endpoints
 
-  // List of OpenAI API endpoints
   // The `model` key must be unique.
+  // https://microsoft.github.io/FLAML/docs/reference/autogen/oai/completion/#create
   "models": [
     // Any model using Azure OpenAI API
     {
@@ -41,6 +53,35 @@
     {
       "model": "gpt-4-32k",
       "api_key": "[OPEN_AI_API_KEY]"
+    },
+
+    // Open-source LLM deployment using "Text Generation Web UI" with `OpenAI` extension enabled:
+    // https://github.com/ivangabriele/openai-autogen-dev-studio#open-source-llms
+    // https://github.com/oobabooga/text-generation-webui/tree/main/extensions/openai#an-openedai-api-openai-like
+
+    // !!! FUNCTION CALLING IS NOT SUPPORTED BY Text Generation Web UI !!!
+
+    // This can be also be any inference endpoint compatible following OpenAI API specs,
+    // regardless of the model you use behind it.
+    {
+      "model": "Open-Orca/Mistral-7B-OpenOrca",
+      "api_base": "https://[YOUR_CONTAINER_ID]-5001.proxy.runpod.net", // or your local/public endpoint
+      // Unless you have setup your endpoint with an API key, you can leave this dummy value:
+      "api_key": "sk-111111111111111111111111111111111111111111111111",
+      "api_type": "open_ai"
     }
   ]
+
+  // ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
+  // Funtionary LLM API Endpoint Configuration
+
+  // This must be a secondary deployment. Don't use this endpoint in your models.
+  // You can deploy it in one click using this Github repository:
+  // https://github.com/ivangabriele/docker-functionary
+  // "functionary_model": {
+  //   "model": "musabgultekin/functionary-7b-v1",
+  //   "api_base": "https://eoefr8r4dxwu0n-8000.proxy.runpod.net//v1",
+  //   "api_key": "functionary",
+  //   "api_type": "open_ai"
+  // }
 }