OpenAI API User Guide

This tutorial explains how to install different model services on Module LLM, LLM630 Compute Kit, and AI Pyramid, and how to access and invoke their model capabilities from a PC or other devices via the standard OpenAI API. Covered use cases include chat generation, speech recognition, and text-to-speech, helping you build efficient AI edge application systems.

1. Preparation

Before use, please refer to the software update tutorial for the corresponding device to complete the addition of M5Stack apt software source information and index updates.

• Module LLM Image & Software Upgrade Guide
• LLM630 Compute Kit Image & Software Upgrade Guide
• AI Pyramid Software Upgrade Guide

2. Dependency Updates

1. Access the device terminal via UART or SSH, and run the following command to update the apt software source index.

apt update

2. Update the device LLM base package.

apt install lib-llm

3. Update related dependency packages.

apt install llm-sys llm-llm llm-vlm llm-whisper llm-melotts llm-openai-api

4. After completing the installation of the above packages, reboot the device.

reboot

3. Python OpenAI

Configure the Python environment on your PC and install the official OpenAI Python library via pip. Subsequent examples will be based on this library to access the LLM device and invoke its model capabilities using the standard OpenAI API.

pip install openai

4. Function Index

• Model List
• Chat Completions
• Speech to Text
• Text to Speech
• Chatbox