xiaogpt

https://github.com/yihong0618/xiaogpt
Admin
xiaogpt allows users to integrate ChatGPT and other Large Language Models with Xiaomi AI Speakers,...
Tokens:4,094
Snippets:66
Trust Score:10
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Copy Example Configuration File

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

To start, copy the example configuration file to a new file named 'xiao_config.yaml' and then run the application.

```shell
cp xiao_config.yaml.example xiao_config.yaml
python3 xiaogpt.py
```

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

### Run XiaoGPT with Specific Parameters

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Example of running the Docker container with specific Xiaomi account, password, hardware details, and enabling the ChatGPT API.

```shell
docker run -e OPENAI_API_KEY=<your-openapi-key> yihong0618/xiaogpt --account=<your-xiaomi-account> --password=<your-xiaomi-password> --hardware=<your-xiaomi-hardware> --use_chatgpt_api
```

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

### Run XiaoGPT with Fish-TTS

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Example command to run XiaoGPT using the Fish-TTS service. Requires API key and voice key obtained from Fish-TTS. Other parameters like `--mute_xiaoai` and `--stream` are also shown.

```shell
python3 xiaogpt.py --hardware LX06 --account xxxx --password xxxxx --use_chatgpt_api --mute_xiaoai --stream --tts fish --fish_api_key xxxxx --fish_voice_key xxxxx
```

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

### Install Xiaogpt

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Install Xiaogpt with the locked extra for dependency management.

```shell
pip install -U --force-reinstall xiaogpt[locked]
```

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

### Build Docker Image with國內源

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Build the Docker image using a specified Python package index URL to speed up dependency installation. This is useful for faster builds or when facing network issues with the default index.

```shell
docker build --build-arg PIP_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple -t xiaogpt .
```

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

### Run XiaoGPT with Configuration File

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Mount a local directory containing your configuration file to `/config` within the container and specify the config path using the `--config` argument.

```shell
docker run -v <your-config-dir>:/config yihong0618/xiaogpt --config=/config/config.yaml
```

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

### Run Xiaogpt with Qwen API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Integrate with Alibaba's Qwen model. Requires a Qwen API key.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_qwen --qwen_key ${qwen_key}
```

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

### Run Xiaogpt from Source with Account and Password

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source by providing Xiaomi account and password.

```shell
python3 xiaogpt.py --hardware LX06 --account ${your_xiaomi_account} --password ${your_password} --use_chatgpt_api
```

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

### Run Xiaogpt with LangChain and SerpApi

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Enable web searching and other local services via LangChain. Requires OpenAI and SerpApi keys. Currently only supports stream mode.

```shell
export OPENAI_API_KEY=${your_api_key}
export SERPAPI_API_KEY=${your_serpapi_key}
xiaogpt --hardware Lx06 --use_langchain --mute_xiaoai --stream --openai_key ${your_api_key} --serpapi_api_key ${your_serpapi_key}
```

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

### Run Xiaogpt from Source with Qwen API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source using Alibaba's Qwen API. Requires a Qwen key.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_qwen --qwen_key ${qwen_key}
```

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

### Run Xiaogpt from Source with Default Settings

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt directly using Python from the cloned repository with default configurations.

```shell
export OPENAI_API_KEY=${your_api_key}
python3 xiaogpt.py --hardware LX06
```

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

### Run XiaoGPT with a Configuration File

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Specify a custom configuration file using the --config argument. The configuration file must be in valid YAML or JSON format. Command-line arguments take precedence over default and config file settings.

```shell
python3 xiaogpt.py --config xiao_config.yaml
```

```shell
xiaogpt --config xiao_config.yaml
```

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

### Run Xiaogpt with Yi API (01.ai)

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Integrate with the Yi API from 01.ai. Requires a TI API key.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_yi_api --ti_api_key ${yi_api_key}
```

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

### Run Xiaogpt from Source with LangChain and SerpApi

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source with LangChain and SerpApi for web search capabilities. Requires API keys and supports stream mode.

```shell
export OPENAI_API_KEY=${your_api_key}
export SERPAPI_API_KEY=${your_serpapi_key}
python3 xiaogpt.py --hardware Lx06 --use_langchain --mute_xiaoai --stream --openai_key ${your_api_key} --serpapi_api_key ${your_serpapi_key}
```

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

### Run Xiaogpt from Source with Cookie

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source using cookie authentication.

```shell
python3 xiaogpt.py --hardware LX06 --cookie ${cookie}
```

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

### Run Xiaogpt from Source with ChatGLM API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Integrate with ChatGLM API. Requires a GLM key.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_glm --glm_key ${glm_key}
```

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

### Run XiaoGPT with Docker

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Basic command to run the XiaoGPT Docker image. Replace `<your-openapi-key>` with your OpenAI API key and `<命令行参数>` with your desired command-line arguments.

```shell
docker run -e OPENAI_API_KEY=<your-openapi-key> yihong0618/xiaogpt <命令行参数>
```

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

### Run Xiaogpt from Source with Google Gemini API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source using Google Gemini. Requires a Gemini key.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_gemini --gemini_key ${gemini_key}
```

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

### Run Xiaogpt with Account and Password

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Run Xiaogpt by providing your Xiaomi account and password directly.

```shell
xiaogpt --hardware LX06 --account ${your_xiaomi_account} --password ${your_password} --use_chatgpt_api
```

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

### Run Xiaogpt from Source with Llama API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source using the Llama API. Requires a Llama API key.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_llama --llama_api_key ${llama_api_key}
```

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

### Run Xiaogpt from Source with Doubao API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source using the Doubao API. Requires VolcAccessKey and VolcSecretKey. Supports stream mode.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_doubao --stream --volc_access_key xxxx --volc_secret_key xxx
```

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

### Run Xiaogpt with ChatGPT API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Basic command to run Xiaogpt with a specified hardware model and use the ChatGPT API. Ensure your OPENAI_API_KEY is set.

```shell
export OPENAI_API_KEY=${your_api_key}
xiaogpt --hardware LX06 --use_chatgpt_api
```

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

### Build XiaoGPT Docker Image Locally

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Build the Docker image for XiaoGPT from the current directory. The tag `xiaogpt` is applied.

```shell
docker build -t xiaogpt .
```

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

### Run Xiaogpt with Moonshot (Kimi) API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Use the Moonshot API, which powers Kimi Chat. Requires a Moonshot API key.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_moonshot_api --moonshot_api_key ${moonshot_api_key}
```

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

### Run Xiaogpt with Llama API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Configure Xiaogpt to use Llama models. Requires a Llama API key.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_llama --llama_api_key ${llama_api_key}
```

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

### Run Xiaogpt with Google Gemini API

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Configure Xiaogpt to use Google's Gemini model. Requires a Gemini API key.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_gemini --gemini_key ${gemini_key}
```

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

### Run Xiaogpt from Source with Stream Response

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source with streaming responses enabled for faster interaction.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --stream
```

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

### Build x86 Docker Image on Apple Silicon

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Build a Docker image for the `linux/amd64` platform on Apple M1/M2 machines using `docker buildx`. This allows running x86-compatible applications in a container on ARM hardware.

```shell
docker buildx build --platform=linux/amd64 -t xiaogpt-x86 .
```

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

### Run Xiaogpt with Cookie Authentication

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Run Xiaogpt using a captured cookie for authentication, suitable when direct login is not preferred.

```shell
xiaogpt --hardware LX06 --cookie ${cookie} --use_chatgpt_api
```

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

### Run XiaoGPT with Host Network

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Use the host network mode for the Docker container, which shares the host's network namespace. Requires mounting a configuration directory.

```shell
docker run -v <your-config-dir>:/config --network=host yihong0618/xiaogpt --config=/config/config.yaml
```

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

### Run Xiaogpt from Source with Muted Xiaoai

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Execute Xiaogpt from source, muting Xiaoai's default responses.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai
```

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

### Run Xiaogpt with Stream Response

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Enable streaming responses for faster perceived interaction. This is often used with muted Xiaoai.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --stream
```

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

### Run Xiaogpt with Custom Google Gemini Domain

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Use a custom API domain for Google Gemini, useful for self-hosted or specific regional endpoints.

```shell
python3 xiaogpt.py --hardware LX06  --mute_xiaoai --use_gemini --gemini_key ${gemini_key} --gemini_api_domain ${gemini_api_domain}
```

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

### Configure OpenAI Model Parameters

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Specify OpenAI model parameters such as temperature and top_p within the 'gpt_options' section of your config.yaml file. Refer to the OpenAI API documentation for parameter details.

```yaml
gpt_options:
  temperature: 0.9
  top_p: 0.9
```

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

### Run XiaoGPT with TTS Container Port Mapping

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Run the XiaoGPT Docker container, mapping port 9527 to the host and setting the `XIAOGPT_HOSTNAME` environment variable. This is necessary for TTS services like Edge TTS that run a local HTTP server within the container.

```shell
docker run -v <your-config-dir>:/config -p 9527:9527 -e XIAOGPT_HOSTNAME=<your ip> yihong0618/xiaogpt --config=/config/config.yaml
```

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

### Set Xiaoai Device ID

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Set the MI_DID environment variable after listing your device's DID using micli.

```shell
export MI_DID=xxx
```

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

### Configure Fish-TTS in YAML

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Configuration for Fish-TTS within the `config.yaml` file. Specifies the TTS engine and provides options for API key and voice selection.

```yaml
tts: fish 
tts_options:
    api_key: "xxxxx"
    voice: "xxxxxx"
```

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

### List Available Voices for edge-tts

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Command to list all available voices supported by the edge-tts library. Use this to select a voice for TTS output.

```shell
edge-tts --list-voices
```

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

### Mute Xiaoai's Response

Source: https://github.com/yihong0618/xiaogpt/blob/main/README.md

Run Xiaogpt while muting Xiaoai's default responses, useful for focusing on AI model output.

```shell
xiaogpt --hardware LX06  --mute_xiaoai --use_chatgpt_api
```
Tokens:
Raw