FoloToy AI Conversation Program

https://docs.folotoy.com
Admin
This program is designed to provide users with an easy way to deploy the FoloToy AI conversation...
Tokens:45,994
Snippets:482
Trust Score:8.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Aliyun ASR Configuration Example

Source: https://docs.folotoy.com/docs/configuration/stt/aliyun-asr

This JSON configuration defines settings for a specific role, including the start text, a prompt for the AI's persona, the STT type set to 'aliyun-asr', and the necessary Aliyun ASR credentials.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "stt_type": "aliyun-asr",
     "stt_config": {
       "app_key": "7xxxxxxxx904N7CNG",
       "access_key_id": "xxxx",
       "access_key_secret": "xxxx"
     }
 }
}

```

--------------------------------

### Example fly.toml Configuration

Source: https://docs.folotoy.com/docs/installation/flyio

This is an example of a fully configured `fly.toml` file for an application named 'folotoy-server-test'. It includes build settings, environment variables, and service configurations.

```toml
# fly.toml app configuration file generated for folotoy-server-test on 2023-12-13T18:33:02+08:00  
#  
# See https://fly.io/docs/reference/configuration/ for information about how to use this file.  
#  
  
app = "folotoy-server-test"  
primary_region = "nrt"  
  
[build]  
  
[env]  
  API_SERVER = "true"  
  API_SERVER_BIND_ADDRESS = "0.0.0.0"  
  API_SERVER_PORT = "8082"  
  AUDIO_DOWNLOAD_URL = "http://folotoy-server-test.fly.dev:8082"  
  AUDIO_SAVE_PATH = "/audio"  
  LLM_TYPE = "openai"  
  LOG_LEVEL = "DEBUG"  
  LOG_OUTPUT = "stderr"  
  MQTT_BROKER_HOST = "127.0.0.1"  
  MQTT_BROKER_PORT = "1883"  
  MQTT_CLIENT_ID = "folotoy"  
  MQTT_USERNAME = "folotoy"  
  OPENAI_TTS_MODEL = "tts-1"  
  OPENAI_WHISPER_MODEL = "whisper-1"  
  ROLES_FILE_PATH = "/config/roles.json"  
  SPEECH_UDP_SERVER_BIND_ADDRESS = "fly-global-services"  
  SPEECH_UDP_SERVER_HOST = "folotoy-server-test.fly.dev"  
  SPEECH_UDP_SERVER_PORT = "8085"  
  STT_TYPE = "openai-whisper"  
  TTS_TYPE = "edge-tts"  
  TZ = "Asia/Shanghai"  
  
[[services]]  
  protocol = "udp"  
  internal_port = 8085  
  
  [[services.ports]]  
    port = 8085  
  
[[services]]  
  protocol = "tcp"  
  internal_port = 8082  
  
  [[services.ports]]  
    port = 8082  
  
[[services]]  
  protocol = "tcp"  
  internal_port = 1883  
  
  [[services.ports]]  
    port = 1883  
  

```

--------------------------------

### Start FoloToy Docker Container

Source: https://docs.folotoy.com/docs/installation/docker

Command to start the FoloToy Docker container. Add the -d flag to run in the background.

```bash
docker compose up -d
```

--------------------------------

### Dashscope Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/dashscope

Example JSON configuration for setting up a role with Dashscope LLM parameters. Includes API key, model, and generation settings.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心",
     "llm_type": "dashscope",
     "llm_config": {
         "key": "TAAAAAAAAAAAAa",
         "model": "qwen-turbo",
         "max_tokens": 1024,
         "temperature": 0.7,
         "enable_search": true
     }
 }
}

```

--------------------------------

### Dify STT Configuration Example

Source: https://docs.folotoy.com/docs/configuration/stt/dify-stt

This JSON configuration demonstrates how to set up Dify's STT service within a roles.json file. It includes parameters for the API base URL, API key, and role-specific settings like start text and prompts.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "stt_type": "dify-stt",
     "stt_config": {
       "api_base": "https://api.dify.ai/v1",
       "key": "app-aaaaaaaaaaaaaaaaaaaaaaaaa"
     }
 }
}

```

--------------------------------

### Zhipu AI Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/zhipu

Example JSON configuration for setting up a Zhipu AI persona with specific roles and LLM parameters.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心",
     "llm_type": "zhipu",
     "llm_config": {
         "key": "sk-ant-api-TESTAAAAAAAAAAAAa",
         "model": "glm-3-turbo",
         "max_tokens": 1024,
         "temperature": 0.7
     }
 }
}

```

--------------------------------

### Create FoloToy Server Directory

Source: https://docs.folotoy.com/docs/installation/docker

Use these commands to create the necessary directories for the FoloToy server installation.

```bash
cd ~
mkdir folotoy-server
mkdir folotoy-server/config

# Or
# mkdir -p folotoy-server/config
```

--------------------------------

### Complete roles.json Configuration Example

Source: https://docs.folotoy.com/docs/configuration/roles_config

This example shows the structure for defining 7 distinct roles in roles.json, including their startup text, prompts, and context message limits. Adjust max_message_count to enable context, but be mindful of model token limits.

```json
{
   "1": {
      "start_text": "Hello, I'm Companion Bunny. Is there anything I can help you with?",
      "prompt": "You play the role of a child's companion named Companion Bunny. You have a friendly and lively personality, full of love for children. You often praise and encourage children, providing interesting and innovative answers in language that 5-year-old children can easily understand. Each response should ask for her opinion on the chat topic to stimulate her thinking and curiosity.",
      "max_message_count": 0
   },
   "2": {
      "start_text": "Hello, I'm Northeast Bunny. Is there anything I can help you with?",
      "prompt": "You are a knowledgeable and helpful AI named Northeast Bunny. Your task is to chat with me. Please use brief dialogue in Chinese to speak a sentence. Each response should not exceed 50 characters!",
      "max_message_count": 0
   },
   "3": {
      "start_text": "Hi, I'm Wimi. Nice to meet you.",
      "prompt": "You're a knowledgeable and helpful AI named \"Wimi\". Your task is to chat with me. Please respond in English, keeping your answers brief – no more than 50 words each time!",
      "max_message_count": 0
   },
   "4": {
      "start_text": "Hello, I'm Compliment Bunny. Is there anything I can help you with?",
      "prompt": "Compliment me",
      "max_message_count": 0
   },
   "5": {
      "start_text": "Hello, I'm Mental Arithmetic Bunny. Shall we play a mental arithmetic game together?",
      "prompt": "I'm a 6-year-old child, and you're playing a mental arithmetic game with me. You ask questions, and I'll answer them. If I answer correctly, you say 'Great!' If I answer incorrectly, you tell me the correct answer and encourage me. You ask one question at a time, and I'll answer them one by one. Do you understand?",
      "max_message_count": 0
   },
   "6": {
      "start_text": "Hello, I'm Taiwan Bunny. Is there anything I can help you with?",
      "prompt": "You are a knowledgeable and helpful AI named Taiwan Bunny. Your task is to chat with me. Please use brief dialogue in Chinese to speak a sentence. Each response should not exceed 50 characters!",
      "max_message_count": 0
   },
   "7": {
      "start_text": "Hello, I'm Little Bunny. Is there anything I can help you with?",
      "prompt": "You are a knowledgeable and helpful AI named Little Bunny. Your task is to chat with me. Please use brief dialogue in Chinese to speak a sentence. Each response should not exceed 50 characters!",
      "max_message_count": 0
   }
}
```

--------------------------------

### Dify Roles Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/dify

Example of a roles.json file for Dify, specifying role details, prompts, and LLM configuration including API base and key for a custom role.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "llm_type": "dify",
     "llm_config": {
         "api_base": "http://192.168.52.164/v1",
         "key": "app-AAAAAAAAAAAAAAAAAAa"
     }
 }
}

```

--------------------------------

### Groq Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/groq

Example JSON configuration for defining roles and LLM settings, specifying Groq as the LLM type and its associated API base and model.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心",
     "llm_type": "groq",
     "llm_config": {
         "api_base": "https://api.groq.com/openai/v1",
         "model": "mixtral-8x7b-32768"
     }
 }
}

```

--------------------------------

### Install FoloToy OpenClaw Plugin

Source: https://docs.folotoy.com/docs/integrations/openclaw

Run this command in the terminal to install the official FoloToy plugin for OpenClaw. Ensure OpenClaw is running in your environment.

```bash
npx -y @folotoy/folotoy-openclaw-plugin install  
```

--------------------------------

### Xiaodu LLM Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/xiaodu

Example JSON configuration for a Xiaodu LLM role, specifying client ID, secret, max tokens, and role-playing instructions.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心",
     "llm_type": "xiaodu",
     "llm_config": {
         "client_id": "TESTbbbbbbbbbbbb",
         "secret": "TESTAAAAAAAAAAAAa",
         "max_tokens": 800
     }
 }
}

```

--------------------------------

### Example passwd File Content

Source: https://docs.folotoy.com/docs/installation/flyio

Configure the `passwd` file with your MQTT service account credentials and toy's SN and key. Each toy should have its own line. Ensure there are no empty lines.

```text
folotoy:Ev6****cDB  
F234103026:JvRjTtz5brsN  

```

--------------------------------

### Volcengine ASR Configuration Example

Source: https://docs.folotoy.com/docs/configuration/stt/volcengine-asr

This JSON structure defines a role with specific ASR configurations for Volcengine. It includes prompt, start text, STT type, and detailed STT configuration parameters like app_id, cluster_id, and access_token.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "stt_type": "volcengine-asr",
     "stt_config": {
       "app_id": "4556821315",
       "cluster_id": "volcengine_input_common",
       "access_token": "U5joq1ow-Goyxxxxxxxxxxxxxx"
     }
 }
}

```

--------------------------------

### Install esptool using Python 3

Source: https://docs.folotoy.com/docs/esp-tool

Installs the esptool package within a Python virtual environment. Ensure Python 3 is installed and activated before running.

```bash
python3 -m venv venv 
. venv/bin/activate 
pip install esptool
```

--------------------------------

### Coze LLM Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/coze

Configure Coze LLM with specific settings like start text, prompt, LLM type, and detailed LLM configuration including API base, token, and timeout. This is useful for defining custom chatbot behaviors.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "llm_type": "coze",
     "llm_config": {
       "personal_access_token": "aaaaaaaaaaa",
       "bot_id": "xxxxxx",
       "custom_variables": {},
       "api_base": "https://api.coze.cn/open_api/v2",
       "timeout": 15
 }
 }
}

```

--------------------------------

### Configure Recording Start Prompt Sound

Source: https://docs.folotoy.com/docs/at-command

Enable or disable the sound played at the beginning of a recording. Use 0 for disable and 1 for enable.

```bash
at+config=common,record_begin_audio_type,<value>
```

--------------------------------

### Azure OpenAI Role Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/azure-openai

Example JSON structure for configuring roles with Azure OpenAI, specifying model parameters and persona details.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "llm_type": "azure-openai",
     "llm_config": {
         "model": "gpt-35-turbo",
         "key": "aaaaaaaaaaaaaaaaaaaaaaaa",
         "api_version": "2023-05-15",
         "temperature": 0.7,
         "max_tokens": 800,
         "top_p": 0.95,
         "frequency_penalty": 0,
         "presence_penalty": 0
     }
 }
}

```

--------------------------------

### Azure TTS Configuration Example

Source: https://docs.folotoy.com/docs/configuration/tts/azure-tts

Example JSON configuration for Azure Text to Speech, specifying text, prompt, TTS type, and authentication details.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "tts_type": "azure-tts",
     "tts_config": {
       "key": "aaaaaaaaaaaa",
       "service_region": "asiaeast",
       "voice_name": "zh-CN-YunyangNeura"
     }
 }
}

```

--------------------------------

### Elevenlabs TTS Configuration Example

Source: https://docs.folotoy.com/docs/configuration/tts/elevenlabs

Example JSON configuration for Elevenlabs Text to Sound, specifying role details, prompt, and TTS settings including key, model, and voice ID.

```json
    {
    "1": {
        "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
        "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
        "tts_type": "elevenlabs",
        "tts_config": {
          "key": "aaaaaaaaaaaa",
          "model": "eleven_multilingual_v2",
          "voice_id": "c8Vkv3mdER2fkhJdEIPK"
        }
    }
  }
```

--------------------------------

### Ollama Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/ollama

Example JSON configuration for setting up an Ollama LLM with custom roles, prompts, and model details. Ensure the 'llm_type' is set to 'ollama' and specify 'api_base' and 'model' within 'llm_config'.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心",
     "llm_type": "ollama",
     "llm_config": {
         "api_base": "http://localhost:11434",
         "model": "gemma:7b"
     }
 }
}

```

--------------------------------

### Example Role Configuration

Source: https://docs.folotoy.com/docs/configuration/roles_config

This JSON object demonstrates the structure for configuring a single role with specific STT, TTS, and LLM settings. Note that configurations vary based on the selected engine type.

```json
{
   "start_text": "Hello, I\'m Wimi. Nice to meet you.",
   "prompt": "You\'re a knowledgeable and helpful AI named \"Wimi\". Your task is to chat with me. Please respond in English, keeping your answers brief – no more than 50 words each time!",
   "max_message_count": 20,
   "stt_type": "openai-whisper",
   "stt_config": {
      // Configuration varies depending on the selected stt_type. Below is an example for openai-whisper.
      "language": "en",
      "api_base": "https://api.openai.com/v1",
      "key": "sk-AAAAAAAAAAAAAAAAAAa",
      "model": "whisper-1"
   },
   "tts_type": "openai-tts",
   "tts_config": {
      // Configuration varies depending on the selected tts_type. Below is an example for openai-tts.
      "key": "sk-BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
      "api_base": "https://api.openai.com/v1",
      "model": "tts-1",
      "speed": 1.0,
      "voice_name": "alloy"
   },
   "llm_type": "openai",
   "llm_config": {
      // Configuration varies depending  

 on the selected llm_type. Below is an example for openai.  
      "api_base": "https://xxxx.ccc/v1",
      "key": "sk-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "model": "gpt-3.5-turbo",
      "temperature": 0.7,
      "max_tokens": 800,
      "top_p": 0.95,
      "frequency_penalty": 0,
      "presence_penalty": 0
   }
}

```

--------------------------------

### Start and Stop Dialogue

Source: https://docs.folotoy.com/docs/at-command

Manages the dialogue session based on the current recording mode. Use 'start' to enter a conversation and 'stop' to exit.

```bash
at+command=dialogue,start // enter conversation
```

```bash
at+command=dialogue,stop // exit conversation
```

--------------------------------

### Azure STT Configuration Example

Source: https://docs.folotoy.com/docs/configuration/stt/azure-stt

Example of a roles.json file configuring Azure STT with language, key, and service region. Ensure you use the correct BCP-47 language codes for Azure STT.

```json
{
  "1": {
    "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
    "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
    "stt_type": "azure-stt",
    "stt_config": {
      "language": "zh-CN",
      "key": "ef0f2781b5a24bbbbbbbbbbbbbbbbbbbb",
      "service_region": "eastus"
    }
  }
}

```

--------------------------------

### OpenAI TTS Configuration Example

Source: https://docs.folotoy.com/docs/configuration/tts/openai-tts

This JSON configuration demonstrates how to set up parameters for OpenAI's Text to Speech service, including API details, model selection, audio speed, and voice.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "tts_type": "openai-tts",
     "tts_config": {
       "api_base": "https://api.openai.com/v1",
       "key": "sk-AAAAA",
       "model": "tts-1",
       "speed": 1.0,
       "voice_name": "alloy"
     }
 }
}

```

--------------------------------

### FoloToy Service Log for Role Reload

Source: https://docs.folotoy.com/docs/configuration/advanced_roles_config

Example log messages indicating the reception of the configuration update request and the subsequent publish of the acknowledgement.

```log
2023-11-14 14:37:28,650 - Thread-5 (_thread_main) - folotoy_app.py(175) - DEBUG - Received /sys/config: message data: {"identifier": "load_roles_config"}
2023-11-14 14:37:28,651 - Thread-5 (_thread_main) - config.py(169) - INFO - Load roles config: {"1": {"start_text": "你好，我是陪伴兔，请问有什么我可以帮助你的吗？", "prompt": "你扮演一个孩子的小伙伴，名字叫陪伴兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心。"}, "2": {"start_text": "你好，俺是东北兔，请问有什么俺可以帮助你的吗？", "prompt": "你是一个知识渊博，乐于助人的智能机器人,你的名字叫“东北兔”，你的任务是陪我聊天，请用简短的对话方式，用中文讲一段话，每次回答不超过50个字！"}, "3": {"start_text": "Hi, I'm Fofo. Nice to meet you.", "prompt": "You're a knowledgeable and helpful AI named \"Fofo\". Your task is to chat with me. Please respond in English, keeping your answers brief – no more than 50 words each time!"}, "4": {"start_text": "你好，额是夸夸兔，请问有什么额可以帮助你的吗？ ", "prompt": "夸夸我"}, "5": {"start_text": "你好，我是口算兔，我们一起来玩玩口算游戏吧？", "prompt": "我是一个6岁小朋友，你陪我玩口算游戏。你出题，我回答结果。如果答对了你就说好棒，答错了你就告诉我正确答案，并且鼓励我。你一题一题的出，我一个个回答。不要有太多的解释说明。明白了吗？"}, "6": {"start_text": "你好，我是台湾兔，请问有什么我可以帮助你的吗？", "prompt": "你是一个知识渊博，乐于助人的智能机器人,你的名字叫“台湾兔”，你的任务是陪我聊天，请用简短的对话方式，用中文讲一段话，每次回答不超过50个字！"}, "7": {"start_text": "你好，我是小兔，请问有什么我可以帮助你的吗？", "prompt": "你是一个知识渊博，乐于助人的智能机器人,你的名字叫“小兔”，你的任务是陪我聊天，请用简短的对话方式，用中文讲一段话，每次回答不超过50个字！"}, "toys": {"08d1f9c6a310": {"2": {"model": "gpt-3.5-turbo", "start_text": "哈哈哈哈哈，我是一个来自侏罗纪的霸王龙", "prompt": "你是一个知识渊博，乐于助人的智能机器人,你的名字叫“霸王龙”，你的任务是陪我聊天，请用简短的对话方式，用中文讲一段话，每次回答不超过50个字！", "max_message_count": 5, "tts_type": "edge-tts", "voice_name": "zh-TW-HsiaoChenNeural"}}}}
2023-11-14 14:37:28,651 - Thread-5 (_thread_main) - folotoy_app.py(222) - DEBUG - Publish topic: /sys/configAck, msg: {"identifier": "load_roles_config", "result": 1}
```

--------------------------------

### View EMQX Server Logs

Source: https://docs.folotoy.com/docs/faq

Execute this command in the deployment directory to view EMQX server logs in real-time. Ensure Docker Compose is installed and configured.

```bash
sudo docker compose logs -f
```

--------------------------------

### Baidu Qianfan Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/qianfan

This JSON configuration is used to set up the Baidu Qianfan LLM, specifying API keys, model, and conversational parameters.

```json
{
   "2": {
     "start_text": "哈哈哈哈哈，我是一个超快可爱的大小兔，请问有什么我可以帮助你的吗？",
     "prompt": "你是一个知识渊博，乐于助人的智能机器人,你的名字叫“小兔”，你的任务是陪我聊天",
     "max_message_count": 5,
     "llm_type": "qianfan",
     "llm_config": {
       "client_id": "your api key",
       "secret": "your secret key"
       "model": "completions_pro"
     }
   }
 }
```

--------------------------------

### OpenAI Configuration Example

Source: https://docs.folotoy.com/docs/configuration/llm/openai

This JSON configuration defines a chat role with specific system prompts and OpenAI API parameters. It includes settings for the model, temperature, max tokens, and penalties.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "llm_type": "openai",
     "llm_config": {
         "model": "gpt-3.5-turbo",
         "temperature": 0.7,
         "max_tokens": 800,
         "top_p": 0.95,
         "frequency_penalty": 0,
         "presence_penalty": 0
     }
 }
}

```

--------------------------------

### Aliyun TTS Configuration Example

Source: https://docs.folotoy.com/docs/configuration/tts/aliyun-tts

This JSON configuration defines roles for text-to-speech, including Aliyun TTS specific settings. Ensure 'access_key_id' and 'access_key_secret' are correctly provided for authentication.

```json
{
 "1": {
     "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
     "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
     "tts_type": "aliyun-tts",
     "tts_config": {
       "app_key": "Lxxxxxxxx904N7XJN",
       "access_key_secret": "xxxx",
       "access_key_secret": "xxxx"
     }
 }
}

```

--------------------------------

### Configure Sound Thresholds

Source: https://docs.folotoy.com/docs/at-command

Sets the thresholds for voice detection. The start threshold ranges from 50dB-80dB. The end threshold defaults to the start threshold minus 5. Examples include setting the start threshold to 60dB and the end threshold to 55dB.

```bash
at+config=common,voice_start_threshold,<value> // at+config=common,voice_start_threshold,60
```

```bash
at+config=common,voice_end_threshold,<value> // at+config=common,voice_end_threshold,55
```

--------------------------------

### Update Git Repository and Build Release

Source: https://docs.folotoy.com/docs/upgrading

Fetch the latest changes from Git, checkout the newest tag, get production dependencies, install frontend assets, clean the build, and compile the release for production.

```bash
git pull
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

mix deps.get --only prod
npm install --prefix ./assets && npm run deploy --prefix ./assets

rm -rf _build
MIX_ENV=prod mix do phx.digest, release --overwrite
```

```bash
git pull
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

mix deps.get --only prod
npm install --prefix ./assets && npm run deploy --prefix ./assets

rm -rf _build
export MIX_ENV=prod
mix do phx.digest, release --overwrite
```

--------------------------------

### View Configuration File

Source: https://docs.folotoy.com/docs/at-command

Use this command to view the current configuration file of the device.

```bash
at+config=?
```

--------------------------------

### Run Database Migrations with Environment Variables

Source: https://docs.folotoy.com/docs/upgrading

Run database migrations, including necessary environment variables for database connection and MQTT host. Adjust values as per your configuration.

```bash
DATABASE_USER=teslamate DATABASE_PASS=super_secret_password DATABASE_NAME=teslamate DATABASE_HOST=localhost MQTT_HOST=your_MQTT_host(HomeAssistant in my case) _build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```

```bash
DATABASE_USER=teslamate DATABASE_PASS=super_secret_password DATABASE_NAME=teslamate DATABASE_HOST=localhost MQTT_HOST=your_MQTT_host(HomeAssistant in my case) _build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```

--------------------------------

### Launch Fly.io app and deploy

Source: https://docs.folotoy.com/docs/installation/flyio

This command launches an existing Fly.io app, prompts for deployment region, and initiates the build and deployment process.

```bash
❯ fly launch --ha=false  
Creating app in /Users/lewang/Playground/flyio/folotoy-server-self-hosting/flyio/folotoy-server  
An existing fly.toml file was found for app folotoy-server-test  
? Would you like to copy its configuration to the new app? Yes  
Scanning source code  
Detected a Dockerfile app  
? Choose an app name (leaving blank will default to 'folotoy-server-test')  
? App folotoy-server-test already exists, do you want to launch into that app? Yes  
Some regions require a paid plan (bom, fra).  
See https://fly.io/plans to set up a plan.  
  
? Choose a region for deployment: Tokyo, Japan (nrt)  
App will use 'nrt' region as primary  
  
Admin URL: https://fly.io/apps/folotoy-server-test  
Hostname: folotoy-server-test.fly.dev  
? Would you like to set up a Postgresql database now? No  
? Would you like to set up an Upstash Redis database now? No  
Wrote config file fly.toml  
? Would you like to deploy now? Yes  
Validating /Users/lewang/Playground/flyio/folotoy-server-self-hosting/flyio/folotoy-server/fly.toml  
Platform: machines  
✓ Configuration is valid  
==> Building image  
Remote builder fly-builder-long-voice-4357 ready  
==> Building image with Docker  
--> docker host: 20.10.12 linux x86_64  
[+] Building 1.5s (16/16) FINISHED  
 => [internal] load build definition from Dockerfile                                                                                                                                                            0.5s  
 => => transferring dockerfile: 69B                                                                                                                                                                             0.4s  
 => [internal] load .dockerignore                                                                                                                                                                               0.4s  
 => => transferring context: 2B                                                                                                                                                                                 0.4s  
 => [internal] load metadata for docker.io/lewangdev/folotoy-server:23.49.1.2-beta                                                                                                                              0.5s  

```

--------------------------------

### OpenAI Whisper Configuration Example

Source: https://docs.folotoy.com/docs/configuration/stt/openai-whisper

Example of configuring OpenAI Whisper within a roles.json file. This includes setting the language to Chinese ('zh') and other API parameters.

```json
{
  "1": {
    "start_text": "你好，我是小兔兔，请问有什么我可以帮助你的吗？",
    "prompt": "你扮演一个孩子的小伙伴，名字叫小兔兔，性格和善，说话活泼可爱，对孩子充满爱心，经常赞赏和鼓励孩子，用5岁孩子容易理解语言提供有趣和创新的回答，每次回复根据聊天主题询问她的看法以激发她的思考和好奇心，现在她来到了你身边问了第一个问题:[你是谁]",
    "stt_type": "openai-whisper",
    "stt_config": {
      "language": "zh",
      "api_base": "https://api.openai.com/v1",
      "key": "sk-AAAAAAAAAAAAAAAAAAa",
      "model": "whisper-1",
      "prompt": "ok. Let's begin."
    }
  }
}

```

--------------------------------

### View Supported AT Commands

Source: https://docs.folotoy.com/docs/at-command

Lists all available AT commands supported by the device.

```bash
at+command=?
```
Tokens:
Raw