From f9e7efd41c475519d8f7a01c539d9ee4a3d56208 Mon Sep 17 00:00:00 2001
From: sigoden <sigoden@gmail.com>
Date: Sun, 23 Jun 2024 22:09:47 +0800
Subject: refactor: reorder config items (#639)

---
 config.example.yaml | 41 +++++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 20 deletions(-)

(limited to 'config.example.yaml')

diff --git a/config.example.yaml b/config.example.yaml
index 90c480d..0c3d985 100644
--- a/config.example.yaml
+++ b/config.example.yaml
@@ -1,23 +1,14 @@
 # ---- llm ----
-model: openai:gpt-3.5-turbo      # Specify the language model to use
-temperature: null                # Set default temperature parameter, range (0, 2)
+model: openai:gpt-4o             # Specify the LLM to use
+temperature: null                # Set default temperature parameter
 top_p: null                      # Set default top-p parameter, range (0, 1)
 
-# ---- apperence ----
-highlight: true                  # Controls syntax highlighting
-light_theme: false               # Activates a light color theme when true. ENV: AICHAT_LIGHT_THEME
-# Custom REPL prompt, see https://github.com/sigoden/aichat/wiki/Custom-REPL-Prompt for more detils
-left_prompt:
-  '{color.green}{?session {?agent {agent}>}{session}{?role /}}{!session {?agent {agent}>}}{role}{?rag @{rag}}{color.cyan}{?session )}{!session >}{color.reset} '
-right_prompt:
-  '{color.purple}{?session {?consume_tokens {consume_tokens}({consume_percent}%)}{!consume_tokens {consume_tokens}}}{color.reset}'
-
 # ---- behavior ----
 save: true                       # Indicates whether to persist the message
+keybindings: emacs               # Choose keybinding style (emacs, vi)
+buffer_editor: null              # Command used to edit the current input with ctrl+o, env: EDITOR
 wrap: no                         # Controls text wrapping (no, auto, <max-width>)
 wrap_code: false                 # Enables or disables wrapping of code blocks
-keybindings: emacs               # Choose keybinding style (emacs, vi)
-buffer_editor: null              # Command used to edit the current input with Ctrl+O
 
 # ---- prelude ----
 prelude: null                    # Set a default role or session to start with (e.g. role:<name>, session:<name>)
@@ -34,13 +25,14 @@ summarize_prompt: 'Summarize the discussion briefly in 200 words or less to use
 # Text prompt used for including the summary of the entire session
 summary_prompt: 'This is a summary of the chat history as a recap: '
 
-# ---- function-calling ----
+# ---- function-calling & agent ----
 # Controls the function calling feature. For setup instructions, visit https://github.com/sigoden/llm-functions
 function_calling: false
-# Regex for seletecting dangerous functions.
-# User confirmation is required when executing these functions. 
+# Regex for seletecting dangerous functions
+# User confirmation is required when executing these functions
 # e.g. 'execute_command|execute_js_code' 'execute_.*'
 dangerously_functions_filter: null
+# Per-Agent configuration
 agents:
   - name: todo-sh
     model: null
@@ -48,12 +40,12 @@ agents:
     top_p: null
     dangerously_functions_filter: null
 
-# ---- rag ----
+# ---- RAG ----
 rag_embedding_model: null         # Specifies the embedding model to use
 rag_rerank_model: null            # Specifies the rerank model to use
+rag_top_k: 4                      # Specifies the number of documents to retrieve
 rag_chunk_size: null              # Specifies the chunk size
 rag_chunk_overlap: null           # Specifies the chunk overlap
-rag_top_k: 4                      # Specifies the number of documents to retrieve
 rag_min_score_vector_search: 0    # Specifies the minimum relevance score for vector-based searching
 rag_min_score_keyword_search: 0   # Specifies the minimum relevance score for keyword-based searching
 rag_min_score_rerank: 0           # Specifies the minimum relevance score for reranking
@@ -73,7 +65,16 @@ rag_template: |
   Given the context information, answer the query.
   Query: __INPUT__
 
-# ---- client ----
+# ---- apperence ----
+highlight: true                  # Controls syntax highlighting
+light_theme: false               # Activates a light color theme when true. env: AICHAT_LIGHT_THEME
+# Custom REPL prompt, see https://github.com/sigoden/aichat/wiki/Custom-REPL-Prompt for more details
+left_prompt:
+  '{color.green}{?session {?agent {agent}>}{session}{?role /}}{!session {?agent {agent}>}}{role}{?rag @{rag}}{color.cyan}{?session )}{!session >}{color.reset} '
+right_prompt:
+  '{color.purple}{?session {?consume_tokens {consume_tokens}({consume_percent}%)}{!consume_tokens {consume_tokens}}}{color.reset}'
+
+# ---- clients ----
 clients:
   # All clients have the following configuration:
   # - type: xxxx
@@ -106,7 +107,7 @@ clients:
 
   # For any platform compatible with OpenAI's API
   - type: openai-compatible
-    name: localai
+    name: local
     api_base: http://localhost:8080/v1                # ENV: {client}_API_BASE
     api_key: xxx                                      # ENV: {client}_API_KEY
     chat_endpoint: /chat/completions                  # Optional
-- 
cgit v1.2.3