瀏覽代碼

Add Azure configuration doc (#1035)

* Add Azure configuration doc

* Add link to Azure doc.
Engel Nyst 1 年之前
父節點
當前提交
32ba0e7f7e
共有 2 個文件被更改,包括 37 次插入1 次删除
  1. 3 1
      README.md
  2. 34 0
      docs/documentation/AZURE_LLM_GUIDE.md

+ 3 - 1
README.md

@@ -157,6 +157,8 @@ For a full list of the LM providers and models available, please consult the [li
 
 There is also [documentation for running with local models using ollama](./docs/documentation/LOCAL_LLM_GUIDE.md).
 
+We are working on a [guide for running OpenDevin with Azure](./docs/documentation/AZURE_LLM_GUIDE.md).
+
 ### 4. Run the Application
 
 - **Run the Application:** Once the setup is complete, launching OpenDevin is as simple as running a single command. This command starts both the backend and frontend servers seamlessly, allowing you to interact with OpenDevin without any hassle.
@@ -222,7 +224,7 @@ For details, please check [this document](./CONTRIBUTING.md).
 
 ## 🤖 Join Our Community
 
-Now we have both Slack workspace for the collaboration on building OpenDevin and Discord server for discussion about anything related, e.g., this project, LLM, agent, etc. 
+Now we have both Slack workspace for the collaboration on building OpenDevin and Discord server for discussion about anything related, e.g., this project, LLM, agent, etc.
 
 * [Slack workspace](https://join.slack.com/t/opendevin/shared_invite/zt-2etftj1dd-X1fDL2PYIVpsmJZkqEYANw)
 * [Discord server](https://discord.gg/mBuDGRzzES)

+ 34 - 0
docs/documentation/AZURE_LLM_GUIDE.md

@@ -0,0 +1,34 @@
+# Azure OpenAI LLM Guide
+
+## 1. Completion
+
+OpenDevin uses LiteLLM for completion calls. You can find their documentation on Azure [here](https://docs.litellm.ai/docs/providers/azure)
+
+# azure openai configs
+
+During installation of OpenDevin, you can set up the following parameters:
+LLM_BASE_URL="<azure-api-base-url>"   # e.g. "https://openai-gpt-4-test-v-1.openai.azure.com/"
+LLM_API_KEY="<azure-api-key>"
+LLM_MODEL="azure/<your-gpt-deployment-name>"
+
+They will be saved in the `config.toml` file in the `OpenDevin` directory. You can add or edit them manually in the file after installation.
+
+In addition, you need to set the following environment variable, which is used by the LiteLLM library to make requests to the Azure API:
+AZURE_API_VERSION = "<api-version>"   # e.g. "2024-02-15-preview"
+
+You can set the environment variable in your terminal or in an `.env` file in the `OpenDevin` directory.
+
+Alternatively, you can add all these in .env, however in that case make sure to check the LiteLLM documentation for the correct variables.
+
+## 2. Embeddings
+
+OpenDevin uses llama-index for embeddings. You can find their documentation on Azure [here](https://docs.llamaindex.ai/en/stable/api_reference/embeddings/azure_openai/)
+
+# azure openai configs
+
+The model used for Azure OpenAI embeddings is "text-embedding-ada-002". You need the correct deployment name for this model in your account.
+
+During installation of OpenDevin, you can set the following parameters used for embeddings, when prompted by the makefile:
+LLM_EMBEDDING_MODEL="azureopenai"
+DEPLOYMENT_NAME = "<your-embedding-deployment-name>"  # e.g. "TextEmbedding...<etc>"
+LLM_API_VERSION = "<api-version>"  # e.g. "2024-02-15-preview"