coze-loop

English | 中文

What is Coze Loop

Coze Loop is a developer-oriented, platform-level solution focused on the development and operation of AI agents. It addresses various challenges faced during the AI agent development process, providing full lifecycle management capabilities from development, debugging, evaluation, to monitoring.

Based on the commercial version, Coze Loop introduces an open-source edition that offers developers free access to core foundational feature modules. By sharing its core technology framework in an open-source model, developers can customize and extend according to business needs, facilitating community co-construction, sharing, and exchange, helping developers participate in AI agent exploration and practice with zero barriers.

What can Coze Loop do?

Coze Loop helps developers develop and operate AI Agent more efficiently by providing full lifecycle management capabilities. Whether it is prompt engineering, AI Agent evaluation, or monitoring and optimization after deployment, Coze Loop provides powerful tools and intelligent support, greatly simplifying the development process of AI Agents and enhancing their operational performance and stability.

• Prompt development: The Prompt development module of Coze Loop provides developers with end-to-end support for writing, debugging, optimizing, and version management. Through a visual Playground, it enables real-time interactive testing of prompts, allowing developers to intuitively compare the output of different LLMs.
• Evaluation: The Coze Loop evaluation module provides developers with systematic evaluation capabilities, enabling automated multi-dimensional testing of prompts and Coze agents' output, such as accuracy, conciseness, compliance, and more.
• Observability: Coze Loop provides developers with observability for the entire execution process, fully recording every stage from user input to AI output, including key stages such as prompt parsing, model invocation, and tool execution, and automatically capturing intermediate results and exceptions.

Feature list

Feature	Functional points
Prompt debugging	Playground debugging and comparison Prompt version management
Evaluation	Manage evaluation sets Management evaluator Manage experiments
Observation	SDK trace reporting * Trace data observation
Model	Support integration with OpenAI, Volcengine Ark, and other models

Quick Start

Refer to Quick Start to learn in detail how to install and deploy the latest version of Coze Loop.

Deployment method 1: Docker deployment (Docker Compose)

Please install and start Docker Engine before you start.

Procedure:

1. Clone the source code. Run the following command to obtain the latest version of the Coze Loop source code.

   # Clone the code
   git clone https://github.com/coze-dev/coze-loop.git
   
   # Enter the coze-loop directory
   cd coze-loop
   

2. Configure a model.

   1. Enter the coze-loop directory.
   2. Edit the file release/deployment/docker-compose/conf/model_config.yaml.
   3. Modify the api_key and model fields. Take Volcengine Ark as an example:
      • api_key: Volcengine Ark API Key. Users in China can refer to the Volcengine Ark documentation, while users outside China can refer to the BytePlus ModelArk documentation.
      • model: The Endpoint ID of the Volcengine Ark model access point. Users within China can refer to the Volcengine Ark documentation; users outside China can refer to the BytePlus ModelArk documentation.

3. Start the service. Run the following commands to quickly deploy the open-source version of Coze Loop using Docker Compose.

   # Start the service (default: development mode)
   # Run in the coze-loop/ directory
   make compose-up
   

4. Access the Coze Loop open-source version through your browser http://localhost:8082.

Deployment method 2: Kubernetes deployment using Helm Chart

• The Kubernetes cluster has been prepared, the Nginx Ingress add-ons have been enabled, and the Kubectl and Helm tools have been installed.
• To quickly try it out locally, you can deploy a Kubernetes cluster using Minikube. For detailed steps, refer to Quick Start.

Procedure:

1. Run the following command to obtain the Helm Chart package.

   helm pull oci://docker.io/cozedev/coze-loop --version 1.0.0-helm
   tar -zxvf coze-loop-1.0.0-helm.tgz && cd coze-loop && rm -f ../coze-loop-1.0.0-helm.tgz
   

This is the beginning of the README. Read the rest at the original. Read the full README ↗