0_index.md

User Guide

---

Table of Contents

1. Getting Started

• 1.1 Introduction
• 1.2 Installation
• 1.3 Quick Start
• 1.4 ApplicationStructure

2. Principle Introduction

• 2.1 Framework Principles
• 2.2 Domain Components
  • 2.2.1 Agent
  • 2.2.2 LLM
  • 2.2.3 Tool
  • 2.2.4 Knowledge
  • 2.2.5 Memory
  • 2.2.6 Planner
• 2.3 Technical Components
• 2.4 Others
  • 2.4.1 Service
    • 2.4.1.1 Registration and Usage
    • 2.4.1.2 Web Server
    • 2.4.1.3 Web API
  • 2.4.2 Prompt Management
  • 2.4.3 Multi-turn Dialogue
  • 2.4.4 Logging
    • 2.4.4.1 Logging Component
  • 2.4.5 Data Collection

3. Component Reference Manual

• 3.1 Domain Components
  • 3.1.1 Agent
  • 3.1.2 LLM
  • 3.1.3 Tool
  • 3.1.4 Knowledge
  • 3.1.5 Memory
  • 3.1.6 Planner
• 3.2 Technical Components
  • 3.2.1 RPC
    • 3.2.1.1 gRPC
  • 3.2.2 Store
  • 3.2.3 Msg
  • 3.2.4 Logging
    • 3.2.4.1 Alibaba Cloud SLS

4. API Reference Manual

5. Best Practices

• 5.1 Operations and Deployment
  • 5.1.1 Docker Containerization Solution
  • 5.1.2 K8S Solution

6. Series of Articles

7. Frequently Asked Questions (FAQ)

8. Contact Us