Agently

This version fixed a serious when making streaming request and this is a stable version to use for now.

Agently develop team will move on to develop brand-new version v2.0.0 and hope to release as soon as possible.

---

该版本修复了Streaming请求时会发生的严重错误，目前已经是一个相对稳定的版本，能够帮助大家理解Agently的理念，并进行面向Agent的开发，验证基于Agent的各种LLM协同想法。

目前Agently开发团队正在努力进行全新的v2.0.0版本开发，v2.0.0版本将提供更加层次清晰和健壮的框架主体以及支持社区生态共同定制开发的协作模式。

我们希望这个版本尽快和大家见面。祝大家玩得愉快。

What's New?

Do you know the full name of GPT is "Generatvie Pre-trained Transformer"? From "Pre-trained" we know, LLM is not that kind of model can keep up current news and events. As we all well-known that when GPT3.5 just born, its knowledge can just reach up to the year 2021. Because it's "Pre-trained", before its next training, it will stay to its status.

If we want LLM models to catch up in some areas, what can we do? One idea could be to equip the LLM-based agents with some skills.

In fact, to catch up is only a small thing that skills can enchane the agent. Just think, what can an agent do when it can browse webpages or write down some to-dos into the list for you for real.

Agently provides a convenient way to do that.

全新功能：使用技能（Skills）来增强你的Agent

HOW TO INSTALL?

npm：npm install agently

yarn：yarn add agently

---

HOW TO USE?

README：[English](https://github.com/Maplemx/Agently/blob/main/README.md) | [中文](https://github.com/Maplemx/Agently/blob/main/README_CN.md)

---

🤵 Agently is a framework helps developers to create amazing LLM based applications.

🎭 You can use it to create an LLM based agent instance with role set and memory easily.

⚙️ You can use Agently agent instance just like an async function and put it anywhere in your code.

🧩 With the easy-to-plug-in design, you can easily append new LLM API/private API/memory management methods/skills to your Agently agent instance.

⚠️ Notice: Agently is a node.js package only works on the server-side.

---

🥷 Author: Maplemx | 📧 Email: [maplemxgmail.com](mailto:maplemxgmail.com) | 💬 WeChat: moxinapp

⁉️ [Report bugs or post your ideas here](https://github.com/Maplemx/Agently/issues)

⭐️ Star this repo if you like it, thanks!

---

🤵 Agently是一个希望帮助大语言模型（LLM）应用开发者们制作出超棒的大语言模型应用（LLM Based Applications）的轻量级框架

🎭 你能够使用Agently快速而轻松地创建并管理基于大语言模型的Agent实例，并管理他们的人设和记忆，这将让客服机器人、角色扮演机器人、游戏用Agent的构造和管理更方便

⚙️ 你可以把Agently创建的Agent以及Session像一个异步函数（async function）一样使用，这将让基于大语言模型能力的自动化工作流构造更轻松，你甚至可以沿用原有的业务代码，在其中部分需要NLP算法、复杂推理或人工操作的环节，尝试把Agently提供的Agent和Session当做一个异步函数，几乎无缝地加入到代码的业务流程中

🧩 Agently在设计时考虑了对主要请求流程中节点部件的可更换性，你可以轻松地更换或定制它们，例如：添加新的LLM模型请求方法，更换私有/转发的模型请求API地址，调整Agent记忆管理方法，定制自己的模型消息解析方案等

🔀 Agently提供的独特的针对一次请求中的流式消息（Streaming Message）的消息分块及多下游分发管理方案，能够让你在接收流式消息时，一方面保留了大语言模型通过流式消息的方式带来的高速反馈敏捷性优点，另一方面又能在一次请求中做更多的事情

⚠️ 注意：Agently适用于Node.js的服务端而不是网页前端

---

🥷 作者: Maplemx | 📧 Email: [maplemxgmail.com](mailto:maplemxgmail.com) | 💬 微信: moxinapp

⁉️ [如果您发现了BUG，或者有好的点子，请在这里提交](https://github.com/Maplemx/Agently/issues)

⭐️ 如果您觉得这个项目对您有帮助，请给项目加星，感谢您的肯定和支持！

Version v0.0.1 of Agently is a tools I develop for speeding the feasibility tests of my language model based application idea. I did not think too much to make it work in product environment. So there still are many functions to work on like streaming the reply, better memory management, etc.

But I notice some people have already use this version through npm install...

Because the next version(v1.0.0) will be publish soon and totally changed. I hope that I can keep a version snapshot by release for those who have already use Agently v0.0.1.