0_index.md

User Guide

---

Table of Contents

1. Getting Started

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

2. Principle Introduction

• 2.1 Framework Principles
• 2.2 Domain Components
  • 2.2.1 Agent
    • 2.2.1.1 Create And Use
    • 2.2.1.2 Related Domain Objects
  • 2.2.2 LLM
    • 2.2.2.1 Define And Use
    • 2.2.2.2 Related Domain Objects
  • 2.2.3 Tool
    • 2.2.3.1 Create And Use
    • 2.2.3.2 Related Domain Objects
  • 2.2.4 Knowledge
    • 2.2.4.1 Define And Use
    • 2.2.4.2 Related Domain Objects
  • 2.2.5 Memory
    • 2.2.5.1 Define And Use
    • 2.2.5.2 Related Domain Objects
  • 2.2.6 Planner
    • 2.2.5.1 Define And Use
    • 2.2.5.2 Related Domain Objects
• 2.3 Technical Components
  • 2.3.1 RAG
    • 2.3.1.1 How To Build A RAG Agent
• 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.1.4 Service Information Storage
  • 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
    • 2.4.5.1 Monitor Module
  • 2.4.6 Data Autonomous
    • 2.4.6.1 Data Autonomous Agent

3. Component Reference Manual

• 3.1 Domain Components
  • 3.1.1 List of Agents
  • 3.1.2 List of LLMs
    • 3.1.2.1 OpenAI Usage Instructions
    • 3.1.2.2 Qwen Usage Instructions
    • 3.1.2.3 WenXin Usage Instructions
    • 3.1.2.4 Kimi Usage Instructions
    • 3.1.2.5 BaiChuan Usage Instructions
    • 3.1.2.6 Claude Usage Instructions
    • 3.1.2.7 Ollama Usage Instructions
    • 3.1.2.8 DeepSeek Usage Instructions
    • 3.1.2.9 GLM Usage Instructions
    • 3.1.2.10 General OpenAI Protocol Style Wrapper
  • 3.1.3 List of Tools
    • 3.1.3.1 Integration Tool Details
    • 3.1.3.2 LangChain Tool Wrapper
  • 3.1.4 List of Knowledge
  • 3.1.5 List of Memories
  • 3.1.6 List of Planners
• 3.2 Technical Components
  • 3.2.1 RPC
    • 3.2.1.1 gRPC
  • 3.2.2 Store
    • 3.2.2.1 SQLDBWrapper
    • 3.2.2.2 Milvus
    • 3.2.2.3 ChromaDB
    • 3.2.2.4 Sqlite
  • 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. Use Cases

• 6.1 RAG-Type Agent Examples
  • 6.1.1 Legal Consultation Agent v2
• 6.2 ReAct-Type Agent Examples
  • 6.2.1 Python Code Generation and Execution Agent
• 6.3 Discussion Group Based on Multi-Turn Multi-Agent Mode
• 6.4 PEER Multi-Agent Cooperation Examples
  • 6.4.1 Financial Event Analysis Case
• 6.5 Andrew Ng's Reflexive Workflow Translation Agent Replication

7.Product Platform

• 7.1 [Quick Use](./10_1_1_Product Platform Quick Start.md)
• 7.2 Advancement Guide

8. Series of Articles

9. Frequently Asked Questions (FAQ)

10.Citation

11. Contact Us