Spaces:
Paused
Paused
frdel commited on
Commit ·
e0de2e7
1
Parent(s): c9da527
.md update
Browse files- docs/installation.md +1 -2
- docs/usage.md +2 -13
docs/installation.md
CHANGED
|
@@ -89,7 +89,6 @@ The following user guide provides instructions for installing and running Agent
|
|
| 89 |
- `/knowledge` - Knowledge base
|
| 90 |
- `/instruments` - Instruments and functions
|
| 91 |
- `/prompts` - Prompt files
|
| 92 |
-
- `/work_dir` - Working directory
|
| 93 |
- `.env` - Your API keys
|
| 94 |
- `/tmp/settings.json` - Your Agent Zero settings
|
| 95 |
|
|
@@ -164,7 +163,7 @@ Agent Zero provides a comprehensive settings interface to customize various aspe
|
|
| 164 |
### Chat Model Settings
|
| 165 |
- **Provider:** Select the chat model provider (e.g., Ollama)
|
| 166 |
- **Model Name:** Choose the specific model (e.g., llama3.2)
|
| 167 |
-
- **
|
| 168 |
- **Context Length:** Set the maximum token limit for context window
|
| 169 |
- **Context Window Space:** Configure how much of the context window is dedicated to chat history
|
| 170 |
|
|
|
|
| 89 |
- `/knowledge` - Knowledge base
|
| 90 |
- `/instruments` - Instruments and functions
|
| 91 |
- `/prompts` - Prompt files
|
|
|
|
| 92 |
- `.env` - Your API keys
|
| 93 |
- `/tmp/settings.json` - Your Agent Zero settings
|
| 94 |
|
|
|
|
| 163 |
### Chat Model Settings
|
| 164 |
- **Provider:** Select the chat model provider (e.g., Ollama)
|
| 165 |
- **Model Name:** Choose the specific model (e.g., llama3.2)
|
| 166 |
+
- **API URL:** URL of the API endpoint for the chat model - only needed for custom providers like Ollama, Azure, etc.
|
| 167 |
- **Context Length:** Set the maximum token limit for context window
|
| 168 |
- **Context Window Space:** Configure how much of the context window is dedicated to chat history
|
| 169 |
|
docs/usage.md
CHANGED
|
@@ -112,7 +112,7 @@ Agent Zero might then:
|
|
| 112 |
1. Use the `search_engine` and `document_query_tool` to query a reliable source for the Bitcoin price and for the news about cryptocurrency as prompted.
|
| 113 |
2. Extract the price from the search results and save the news, extracting their dates and possible impact on the price.
|
| 114 |
3. Use the `code_execution_tool` to execute a Python script that performs the graph creation and key points highlighting, using the extracted data and the news dates as inputs.
|
| 115 |
-
4.
|
| 116 |
|
| 117 |
> [!NOTE]
|
| 118 |
> The first run of `code_execution_tool` may take a while as it downloads and builds the Agent Zero Docker image. Subsequent runs will be faster.
|
|
@@ -145,6 +145,7 @@ Enable voice responses from agents:
|
|
| 145 |
* Toggle the "Speech" switch in the Preferences section of the sidebar
|
| 146 |
* Agents will use your system's built-in voice synthesizer to speak their messages
|
| 147 |
* Click the "Stop Speech" button above the input area to immediately stop any ongoing speech
|
|
|
|
| 148 |
|
| 149 |

|
| 150 |
|
|
@@ -188,18 +189,6 @@ Configure STT settings in the Settings page:
|
|
| 188 |
> ensuring that no data is transmitted to external servers or OpenAI APIs. This
|
| 189 |
> enhances user privacy while maintaining functionality.
|
| 190 |
|
| 191 |
-
### Mathematical Expressions
|
| 192 |
-
Agent Zero supports KaTeX for beautiful mathematical typesetting:
|
| 193 |
-
|
| 194 |
-
* **Inline Math:** Use single dollars `$...$` for inline expressions
|
| 195 |
-
- Example: Type `The area of a circle is $A = πr^2$`
|
| 196 |
-
- Renders as: The area of a circle is $A = πr^2$
|
| 197 |
-
|
| 198 |
-
* **Display Math:** Use double dollars `$$...$$` for centered display equations
|
| 199 |
-
- Example: Type `$$F = G\frac{m_1m_2}{r^2}$$`
|
| 200 |
-
- Renders as a centered equation
|
| 201 |
-
|
| 202 |
-

|
| 203 |
|
| 204 |
* **Complex Mathematics:** Supports full KaTeX syntax for:
|
| 205 |
- Fractions, exponents, and roots
|
|
|
|
| 112 |
1. Use the `search_engine` and `document_query_tool` to query a reliable source for the Bitcoin price and for the news about cryptocurrency as prompted.
|
| 113 |
2. Extract the price from the search results and save the news, extracting their dates and possible impact on the price.
|
| 114 |
3. Use the `code_execution_tool` to execute a Python script that performs the graph creation and key points highlighting, using the extracted data and the news dates as inputs.
|
| 115 |
+
4. Save the final chart on disk inside the container and provide a link to it with the `response_tool`.
|
| 116 |
|
| 117 |
> [!NOTE]
|
| 118 |
> The first run of `code_execution_tool` may take a while as it downloads and builds the Agent Zero Docker image. Subsequent runs will be faster.
|
|
|
|
| 145 |
* Toggle the "Speech" switch in the Preferences section of the sidebar
|
| 146 |
* Agents will use your system's built-in voice synthesizer to speak their messages
|
| 147 |
* Click the "Stop Speech" button above the input area to immediately stop any ongoing speech
|
| 148 |
+
* You can also click the speech button when hovering over messages to speak individual messages or their parts
|
| 149 |
|
| 150 |

|
| 151 |
|
|
|
|
| 189 |
> ensuring that no data is transmitted to external servers or OpenAI APIs. This
|
| 190 |
> enhances user privacy while maintaining functionality.
|
| 191 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 192 |
|
| 193 |
* **Complex Mathematics:** Supports full KaTeX syntax for:
|
| 194 |
- Fractions, exponents, and roots
|