From e9dc19d50857ed0c2f2c3c53813da3d6a2a740b6 Mon Sep 17 00:00:00 2001 From: vyokky <7678676@qq.com> Date: Fri, 28 Jun 2024 20:26:06 +0800 Subject: [PATCH] doc --- documents/docs/supported_models/azure_openai.md | 14 +++++++------- documents/docs/supported_models/ollama.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/documents/docs/supported_models/azure_openai.md b/documents/docs/supported_models/azure_openai.md index 20c11a1d..964f9c38 100644 --- a/documents/docs/supported_models/azure_openai.md +++ b/documents/docs/supported_models/azure_openai.md @@ -7,13 +7,13 @@ To use the Azure OpenAI API, you need to create an account on the [Azure OpenAI After obtaining the API key, you can configure the `HOST_AGENT` and `APP_AGENT` in the `config.yaml` file (rename the `config_template.yaml` file to `config.yaml`) to use the Azure OpenAI API. The following is an example configuration for the Azure OpenAI API: ```yaml - VISUAL_MODE: True, # Whether to use visual mode to understand screenshots and take actions - API_TYPE: "aoai" , # The API type, "openai" for the OpenAI API, "aoai" for the AOAI API, 'azure_ad' for the ad authority of the AOAI API. - API_BASE: "YOUR_ENDPOINT", # The AOAI API address. Format: https://{your-resource-name}.openai.azure.com - API_KEY: "YOUR_KEY", # The aoai API key - API_VERSION: "2024-02-15-preview", # The version of the API, "2024-02-15-preview" by default - API_MODEL: "gpt-4-vision-preview", # The OpenAI model name, "gpt-4-vision-preview" by default. You may also use "gpt-4o" for using the GPT-4O model. - API_DEPLOYMENT_ID: "YOUR_AOAI_DEPLOYMENT", # The deployment id for the AOAI API +VISUAL_MODE: True, # Whether to use visual mode to understand screenshots and take actions +API_TYPE: "aoai" , # The API type, "openai" for the OpenAI API, "aoai" for the AOAI API, 'azure_ad' for the ad authority of the AOAI API. +API_BASE: "YOUR_ENDPOINT", # The AOAI API address. Format: https://{your-resource-name}.openai.azure.com +API_KEY: "YOUR_KEY", # The aoai API key +API_VERSION: "2024-02-15-preview", # The version of the API, "2024-02-15-preview" by default +API_MODEL: "gpt-4-vision-preview", # The OpenAI model name, "gpt-4-vision-preview" by default. You may also use "gpt-4o" for using the GPT-4O model. +API_DEPLOYMENT_ID: "YOUR_AOAI_DEPLOYMENT", # The deployment id for the AOAI API ``` If you want to use AAD for authentication, you should also set the following configuration: diff --git a/documents/docs/supported_models/ollama.md b/documents/docs/supported_models/ollama.md index 603080a1..04781679 100644 --- a/documents/docs/supported_models/ollama.md +++ b/documents/docs/supported_models/ollama.md @@ -18,7 +18,7 @@ ollama run YOUR_MODEL ``` !!!info - info When serving LLMs via Ollama, it will by default start a server at `http://localhost:11434`, which will later be used as the API base in `config.yaml`. + When serving LLMs via Ollama, it will by default start a server at `http://localhost:11434`, which will later be used as the API base in `config.yaml`. ## Step 3 After obtaining the API key, you can configure the `HOST_AGENT` and `APP_AGENT` in the `config.yaml` file (rename the `config_template.yaml` file to `config.yaml`) to use the Ollama API. The following is an example configuration for the Ollama API: