diff --git a/docs/core/models/gemini.md b/docs/core/models/gemini.md new file mode 100644 index 000000000..b0ed04e0b --- /dev/null +++ b/docs/core/models/gemini.md @@ -0,0 +1,48 @@ +--- +title: "Gemini" +description: "This guide walks you through setting up your Google Gemini API key within Eigent to enable the Gemini model for your AI workforce." +--- + +### Prerequisites + +- **Get your API Key:** If you haven't already, generate a key at [Google AI Studio](https://aistudio.google.com/). +- **Copy the Key:** Keep your API key ready to paste. + +### Configuration Steps + +**1. Access Application Settings** + +- Launch Eigent and navigate to the **Home Page**. +- Click on the **Settings** tab (usually located in the sidebar or top navigation). + +![Gemini 1 Pn](/docs/images/gemini_1.png) + +**2. Locate Model Configuration** + +- In the Settings menu, find and select the **Models** section. +- Scroll down to the **Custom Model** area. +- Look for the **Gemini Config** card. +- +![Gemini 2 Pn](/docs/images/gemini_2.png) + +**3. Enter API Details** Click on the Gemini Config card and fill in the following fields: + +- **API Key:** Paste the key you generated from Google AI Studio. +- **API Host:** Enter the appropriate API endpoint host (e.g., `generativelanguage.googleapis.com`). +- **Model Type:** Enter the specific model version you wish to use. + - _Example:_ `gemini-3-pro-preview` +- **Save:** Click the **Save** button to apply your changes. + +![Gemini 3 Pn](/docs/images/gemini_3.png) + +**4. Set as Default & Verify** + +- Once saved, the **"Set as Default"** button on the Gemini Config card will be selected/active. +- **You are ready to go.** Your Eigent agents can now utilize the Gemini model. + +![Gemini 4 Pn](/docs/images/gemini_4.png) + +--- + +> **Video Tutorial:** Prefer a visual guide? [Watch the full configuration video here](https://www.youtube.com/watch?v=1fMU02kvshM) +> \ No newline at end of file diff --git a/docs/core/models.md b/docs/core/models/local-model.md similarity index 57% rename from docs/core/models.md rename to docs/core/models/local-model.md index 3a66a9994..21024bee4 100644 --- a/docs/core/models.md +++ b/docs/core/models/local-model.md @@ -1,33 +1,9 @@ --- -title: Models -description: Configure and deploy your preferred LLM models with Eigent. -icon: server +title: "Models (Local Model)" +description: "Configure and deploy your preferred LLM models with Eigent." +icon: "server" --- -Eigent supports flexible integration and deployment of top LLMs and multimodal models. You can follow the steps below to set up your preferred LLM models. - -1. Click Settings - -![click_settings](/docs/images/models_settings.png) - -2. Close Eigent Cloud Version - -![close_eigent](/docs/images/models_close.png) - -3. Configure your APIKEY and Model Type - -![configure_api](/docs/images/models_configure_models.png) - -4. Configure the Google Search toolkit - -![configure_searchtools](/docs/images/models_configure_tools.png) - -![configure_searchtoolsapi](/docs/images/models_configure_tools_key.png) - -You can refer to the following document for detailed information on how to configure **GOOGLE_API_KEY** and **SEARCH_ENGINE_ID :** https://developers.google.com/custom-search/v1/overview - -Now，start enjoying Eigent！ - ## **Self-Host Model** 1. Configure your self-host model @@ -71,8 +47,7 @@ ollama pull qwen2.5:7b ![configure_searchtools](/docs/images/models_configure_tools.png) -![configure_searchtoolsapi](/docs/images/models_configure_tools_key.png) -You can refer to the following document for detailed information on how to configure **GOOGLE_API_KEY** and **SEARCH_ENGINE_ID :** https://developers.google.com/custom-search/v1/overview +configure_searchtoolsapi You can refer to the following document for detailed information on how to configure **GOOGLE_API_KEY** and **SEARCH_ENGINE_ID :** https://developers.google.com/custom-search/v1/overview ## **API KEY Reference** diff --git a/docs/docs.json b/docs/docs.json index 2c48f9978..7da1ed62f 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -47,24 +47,35 @@ "groups": [ { "group": "Get Started", + "icon": "rocket", "pages": [ "/get_started/welcome", - "/get_started/installation", + "/get_started/installation", "/get_started/quick_start" ] }, { "group": "Core", + "icon": "key", "pages": [ "/core/concepts", "/core/workforce", - "/core/models", + { + "group": "Models", + "icon": "brain", + "expanded": true, + "pages": [ + "/core/models/gemini", + "/core/models/local-model" + ] + }, "/core/tools", "/core/workers" ] }, { "group": "Troubleshooting", + "icon": "question-circle", "pages": [ "/troubleshooting/support", "/troubleshooting/bug" diff --git a/docs/images/gemini_1.png b/docs/images/gemini_1.png new file mode 100644 index 000000000..82c822493 Binary files /dev/null and b/docs/images/gemini_1.png differ diff --git a/docs/images/gemini_2.png b/docs/images/gemini_2.png new file mode 100644 index 000000000..66ba5d75f Binary files /dev/null and b/docs/images/gemini_2.png differ diff --git a/docs/images/gemini_3.png b/docs/images/gemini_3.png new file mode 100644 index 000000000..5acdc4d95 Binary files /dev/null and b/docs/images/gemini_3.png differ diff --git a/docs/images/gemini_4.png b/docs/images/gemini_4.png new file mode 100644 index 000000000..2975f2e68 Binary files /dev/null and b/docs/images/gemini_4.png differ diff --git a/package.json b/package.json index b5ec5c802..2c72eff85 100644 --- a/package.json +++ b/package.json @@ -133,4 +133,4 @@ "engines": { "node": ">=18.0.0 <23.0.0" } -} +} \ No newline at end of file