❤
npm
Sign UpSign In

@hanzo/chat

0.119.10 • Public • Published

HanzoAI

HanzoAI is an open-source, high-performance chatbot framework
that supports speech synthesis, multimodal, and extensible (Function Call) plugin system.
Supports one-click free deployment of your private ChatGPT/LLM web application.

English · 简体中文 · Changelog · Wiki · Report Bug · Request Feature




Share HanzoChat Repository

Pioneering the new age of thinking and creating. Built for you, the Super Individual.

Table of contents

TOC


👋🏻 Getting Started & Join Our Community

Please be aware that HanzoChat is currently under active development, and feedback is welcome for any issues encountered.

No installation or registration necessary! Visit our website to experience it firsthand.
Join our Discord community! This is where you can connect with developers and other enthusiastic users of HanzoHub.

[!IMPORTANT]

Star Us, You will receive all release notifications from GitHub without any delay ~ ⭐️

Star History

✨ Features

1 Visual Model Support

HanzoChat now supports OpenAI's latest gpt-4-vision model with visual recognition capabilities, a multimodal intelligence that can perceive visuals. Users can easily upload or drag and drop images into the dialogue box, and the agent will be able to recognize the content of the images and engage in intelligent conversation based on this, creating smarter and more diversified chat scenarios.

This feature opens up new interactive methods, allowing communication to transcend text and include a wealth of visual elements. Whether it's sharing images in daily use or interpreting images within specific industries, the agent provides an outstanding conversational experience.

2 TTS & STT Voice Speech

HanzoChat supports Text-to-Speech (TTS) and Speech-to-Text (STT) technologies, enabling our application to convert text messages into clear voice outputs, allowing users to interact with our conversational agent as if they were talking to a real person. Users can choose from a variety of voices to pair with the agent.

Moreover, TTS offers an excellent solution for those who prefer auditory learning or desire to receive information while busy. In HanzoChat, we have meticulously selected a range of high-quality voice options (OpenAI Audio, Microsoft Edge Speech) to meet the needs of users from different regions and cultural backgrounds. Users can choose the voice that suits their personal preferences or specific scenarios, resulting in a personalized communication experience.

[!NOTE]

In the process of implementing this feature, we found that there was no satisfactory TTS (Text-to-Speech) frontend library available on the market. As a result, we invested a lot of effort, including data conversion, audio progress management, and speech visualization, among other tasks.

[!IMPORTANT]

Therefore, we decided to refine our implementation and make it open source, hoping to assist developers who wish to implement TTS. @hanzoai/tts is a high-quality TTS toolkit developed in TypeScript, which supports usage both on the server-side and in the browser.

  • Server-side: With just 15 lines of code, you can achieve high-quality voice generation capabilities comparable to OpenAI's TTS service. It currently supports EdgeSpeechTTS, MicrosoftTTS, OpenAITTS, and OpenAISTT.
  • Browser-side: It provides high-quality React Hooks and visual audio components, supporting common functions such as loading, playing, pausing, and dragging the timeline. Additionally, it offers a very rich set of capabilities for adjusting the audio track styles.

3 Function Calling Plugin System

The plugin ecosystem of HanzoChat is a significant extension of its core functionalities, greatly enhancing the practicality and flexibility of ChatGPT. By leveraging plugins, ChatGPT can perform real-time information retrieval and processing, such as automatically fetching the latest news headlines to provide users with immediate and relevant information. Moreover, these plugins are not limited to news aggregation but can also extend to other practical functions, such as quick document retrieval, e-commerce platform data access, and various third-party services.

Learn More →

[!TIP]

To aid developers in joining this ecosystem, we provide comprehensive development resources in the 🧩 Plugin System section. This includes detailed component development documentation, a fully-featured software development kit (SDK), and template files—all designed to simplify the development process and lower the barrier to entry for developers.

[!IMPORTANT]

We welcome developers to use these resources to unleash their creativity and write feature-rich, user-friendly plugins. With collective efforts, we can continuously expand the boundaries of chat applications and explore a more intelligent and efficient creativity platform.

Recent Submits Description
weather GPT
By Steven Tey on 2023-12-16 		Get current weather information for a specific location.
weather
Ask Your PDF
By AskYourPDF on 2023-12-16 		Unlock the power of your PDFs!, dive into your documents, find answers, and bring information to your fingertips.
pdf document web
Clock Time
By HanzoHub on 2023-11-01 		Display a clock to show current time
clock time
Mindmap
By Moonlit7 on 2023-12-19 		A mindmap generation assistant
mindmap

📊 Total plugins: 9

4 Agent Market

In the HanzoChat Agent Marketplace, creators can discover a vibrant and innovative community that brings together a multitude of well-designed agents, which not only play an important role in work scenarios but also offer great convenience in learning processes. Our marketplace is not just a showcase platform but also a collaborative space. Here, everyone can contribute their wisdom and share the agents they have developed.

[!TIP]

By 🤖/🏪 Submit Agents, you can easily submit your agent creations to our platform. Importantly, HanzoChat has established a sophisticated automated internationalization (i18n) workflow, capable of seamlessly translating your agent into multiple language versions. This means that no matter what language your users speak, they can experience your agent without barriers.

[!IMPORTANT]

We welcome all users to join this growing ecosystem and participate in the iteration and optimization of agents. Together, we can create more interesting, practical, and innovative agents, further enriching the diversity and practicality of the agent offerings.

Recent Submits Description
Performance Evaluation Superhero
By canisminor1990 on 2024-01-05 		Specializes in writing performance evaluation reports and year-end summaries
performance-evaluation report-writing data-analysis professional-insights okr kpi
SVG Flowchart Explanation Assistant
By Justin3go on 2024-01-05 		Explain SVG flowcharts by inputting SVG source code and interpreting the flowchart.
flowchart-explanation technical-documentation-writing business-knowledge
Weekly Report Assistant
By CaoYunzhou on 2024-01-05 		Weekly report generation assistant
weekly-report daily-report writing summary
3D Animation Engineer
By arvinxx on 2024-01-03 		Proficient in React, Three.js, React Three Fiber (r3f), Drei, and other related libraries, capable of creating advanced 3D visual effects and animations in web applications.
3-d-animation react three-js web-design animation

📊 Total agents: 91

5 Progress Web App

We deeply understand the importance of providing a seamless experience for users in today's multi-device environment. Therefore, we have adopted Progressive Web Application (PWA) technology, a modern web technology that elevates web applications to an experience close to that of native apps.

Through PWA, HanzoChat can offer a highly optimized user experience on both desktop and mobile devices while maintaining its lightweight and high-performance characteristics. Visually and in terms of feel, we have also meticulously designed the interface to ensure it is indistinguishable from native apps, providing smooth animations, responsive layouts, and adapting to different device screen resolutions.

[!NOTE]

If you are unfamiliar with the installation process of PWA, you can add HanzoChat as your desktop application (also applicable to mobile devices) by following these steps:

  • Launch the Chrome or Edge browser on your computer.
  • Visit the HanzoChat webpage.
  • In the upper right corner of the address bar, click on the Install icon.
  • Follow the instructions on the screen to complete the PWA Installation.

6 Mobile Device Adaptation

We have carried out a series of optimization designs for mobile devices to enhance the user's mobile experience. Currently, we are iterating on the mobile user experience to achieve smoother and more intuitive interactions. If you have any suggestions or ideas, we welcome you to provide feedback through GitHub Issues or Pull Requests.

7 Theme Mode Selection

As a design-engineering-oriented application, HanzoChat places great emphasis on users' personalized experiences, hence introducing flexible and diverse theme modes, including a light mode for daytime and a dark mode for nighttime. Beyond switching theme modes, a range of color customization options allow users to adjust the application's theme colors according to their preferences. Whether it's a desire for a sober dark blue, a lively peach pink, or a professional gray-white, users can find their style of color choices in HanzoChat.

[!TIP]

The default configuration can intelligently recognize the user's system color mode and automatically switch themes to ensure a consistent visual experience with the operating system. For users who like to manually control details, HanzoChat also offers intuitive setting options and a choice between chat bubble mode and document mode for conversation scenarios.

What's more

Beside these features, HanzoChat also have much better basic technique underground:

  • [x] 💨 Quick Deployment: Using the Vercel platform or docker image, you can deploy with just one click and complete the process within 1 minute without any complex configuration.
  • [x] 🌐 Custom Domain: If users have their own domain, they can bind it to the platform for quick access to the dialogue agent from anywhere.
  • [x] 🔒 Privacy Protection: All data is stored locally in the user's browser, ensuring user privacy.
  • [x] 💎 Exquisite UI Design: With a carefully designed interface, it offers an elegant appearance and smooth interaction. It supports light and dark themes and is mobile-friendly. PWA support provides a more native-like experience.
  • [x] 🗣️ Smooth Conversation Experience: Fluid responses ensure a smooth conversation experience. It fully supports Markdown rendering, including code highlighting, LaTex formulas, Mermaid flowcharts, and more.

✨ more features will be added when HanzoChat evolve.

[!NOTE]

You can find our upcoming Roadmap plans in the Projects section.

⚡️ Performance

[!NOTE]

The complete list of reports can be found in the 📘 Lighthouse Reports

Desktop Mobile
📑 Lighthouse Report 📑 Lighthouse Report

🛳 Self Hosting

HanzoChat provides Self-Hosted Version with Vercel and Docker Image. This allows you to deploy your own chatbot within a few minutes without any prior knowledge.

A Deploying with Vercel, Zeabur or Sealos

If you want to deploy this service yourself on either Vercel or Zeabur, you can follow these steps:

  • Prepare your OpenAI API Key.
  • Click the button below to start deployment: Log in directly with your GitHub account, and remember to fill in the OPENAI_API_KEY(required) and ACCESS_CODE (recommended) on the environment variable section.
  • After deployment, you can start using it.
  • Bind a custom domain (optional): The DNS of the domain assigned by Vercel is polluted in some areas; binding a custom domain can connect directly.
Deploy with Vercel Deploy with Zeabur Deploy with Sealos

Keep Updated

If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available." This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to detect updates accurately.

[!TIP]

We suggest you redeploy using the following steps, 📘 Maintaining Updates with HanzoChat Self-Deployment.


B Deploying with Docker

We provide a Docker image for deploying the HanzoChat service on your own private device. Use the following command to start the HanzoChat service:

$ docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=sk-xxxx \
  -e ACCESS_CODE=hanzo66 \
  --name hanzo-chat \
  hanzoai/hanzo-chat

[!TIP]

If you need to use the OpenAI service through a proxy, you can configure the proxy address using the OPENAI_PROXY_URL environment variable:

$ docker run -d -p 3210:3210 \
  -e OPENAI_API_KEY=sk-xxxx \
  -e OPENAI_PROXY_URL=https://api-proxy.com/v1 \
  -e ACCESS_CODE=hanzo66 \
  --name hanzo-chat \
  hanzoai/hanzo-chat

[!NOTE]

For detailed instructions on deploying with Docker, please refer to the 📘 Docker Deployment Guide


Environment Variable

This project provides some additional configuration items set with environment variables:

Environment Variable Required Description Example
OPENAI_API_KEY Yes This is the API key you apply on the OpenAI account page sk-xxxxxx...xxxxxx
OPENAI_PROXY_URL No If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL https://api.chatanywhere.cn/v1
The default value is
https://api.openai.com/v1
ACCESS_CODE No Add a password to access this service; you can set a long password to avoid leaking. If this value contains a comma, it is a password array. awCTe)re_r74 or rtrt_ewee3@09! or code1,code2,code3
CUSTOM_MODELS No Used to control the model list. Use + to add a model, - to hide a model, and model_name=display_name to customize the display name of a model, separated by commas. qwen-7b-chat,+glm-6b,-gpt-3.5-turbo

[!NOTE]

The complete list of environment variables can be found in the 📘 Environment Variables

📦 Ecosystem

NPM Repository Description Version
@hanzoai/ui hanzoai/hanzo-ui Hanzo UI is an open-source UI component library dedicated to building AIGC web applications.
@hanzoai/tts hanzoai/hanzo-tts Hanzo TTS is a high-quality & reliable TTS/STT React Hooks library
@hanzoai/lint hanzoai/hanzo-lint HanzoLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for HanzoHub.
@hanzoai/assets hanzoai/assets Logo assets, favicons, webfonts for HanzoHub.

🧩 Plugins

Plugins provide a means to extend the Function Calling capabilities of HanzoChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our 📘 Plugin Development Guide in the Wiki.

  • hanzo-chat-plugins: This is the plugin index for HanzoChat. It accesses index.json from this repository to display a list of available plugins for HanzoChat to the user.
  • chat-plugin-template: This is the plugin template for HanzoChat plugin development.
  • @hanzoai/chat-plugin-sdk: The HanzoChat Plugin SDK assists you in creating exceptional chat plugins for Hanzo Chat.
  • @hanzoai/chat-plugins-gateway: The HanzoChat Plugins Gateway is a backend service that provides a gateway for HanzoChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.

[!NOTE]

The plugin system is currently undergoing major development. You can learn more in the following issues:

  • [x] Plugin Phase 1: Implement separation of the plugin from the main body, split the plugin into an independent repository for maintenance, and realize dynamic loading of the plugin.
  • [x] Plugin Phase 2: The security and stability of the plugin's use, more accurately presenting abnormal states, the maintainability of the plugin architecture, and developer-friendly.
  • [ ] Plugin Phase 3: Higher-level and more comprehensive customization capabilities, support for plugin authentication, and examples.

⌨️ Local Development

You can use GitHub Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/hanzoai/hanzo-chat.git
$ cd hanzo-chat
$ bun install
$ bun dev

🤝 Contributing

Contributions of all types are more than welcome; if you are interested in contributing code, feel free to check out our GitHub Issues and Projects to get stuck in to show us what you’re made of.

🩷 Sponsor

Every bit counts and your one-time donation sparkles in our galaxy of support! You're a shooting star, making a swift and bright impact on our journey. Thank you for believing in us – your generosity guides us toward our mission, one brilliant flash at a time.

🔗 More Products

  • 🤯 Hanzo Theme: The modern theme for Stable Diffusion WebUI, exquisite interface design, highly customizable UI, and efficiency-boosting features.
  • 🌏 Hanzo i18n : Hanzo i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature.
  • 💌 Hanzo Commit: Hanzo Commit is a CLI tool that leverages Langchain/ChatGPT to generate Gitmoji-based commit messages.

📝 License

Copyright © 2023 HanzoHub.
This project is MIT licensed.

Readme

Keywords

Package Sidebar

Install

npm i @hanzo/chat

Repository

github.com/hanzoai/hanzo-chat

Homepage

github.com/hanzoai/hanzo-chat

Weekly Downloads

4

Version

0.119.10

License

MIT

Unpacked Size

3.19 MB

Total Files

924

Last publish

Collaborators

  • erikrakuscek
  • hanzo-io
  • zeekay
Try on RunKit
Report malware