itongbanChatBI

Itongban ChatBI

• Author: guojingi
• Version: 0.0.1
• Type: tool

Overview

The itongban ChatBI platform can quickly access data sources and large models, and with the help of semantic engines and assistant management functions, achieve intelligent data collection. The itongban ChatBI plugin can efficiently obtain data by calling the ChatBI assistant.

Core Functionality

• Data source access: Supports creating multiple types of database connections, compatible with mainstream databases such as MySql, PG, and Dameng.
• Large model access: It can be configured and connected to multiple large model connections, supporting the access requirements of multiple protocol types for large models.
• Semantic engine: capable of quickly configuring dataset models based on data sources.
• Agent Assistant: Create an intelligent query assistant based on data models, with multi scenario configurations such as natural language queries, multi round session rewriting, and data result interpretation.

The itongban ChatBI plugin includes two tools: ChatBI-Text2Data and ChatBI-Text2Data-dev, both of which can access your data through natural language dialogue. The only difference is that the two tools have different ways of obtaining dify user email addresses. Please refer to the "3.Use tools" for details.

The following will introduce how to configure and demonstrate examples.

1. Apply for a tongban access token

If you don't have a itongban account yet, please apply for registration on the itongban. See Application For Registration for details.

Log on itongban. Click on "Manage">"Access Tokens">"Add Access Token" to create a new token and obtain its value.

If you have a itongban private deployment environment, you can obtain access tokens in the private environment.

2. Obtain itongban ChatBI plugin from dify plugin Marketplace and complete configuration verification

Find and install the itongban ChatBI plugin from the dify Marketplace, click the "API Key Authorization Configuration" button, open the authorization page, fill in the base url (Bash URL) and access token. If you have a itongban private deployment environment, you can configure the base url of the private deployment environment.

3.Complete the data modeling and configuration work of ChatBI assistant among itongban, see Itongban Operation Manual for details

4.Use tools

itongban ChatBI includes two tools: ChatBI-Text2Data and ChatBI-Text2Data-dev

ChatBI-Text2Data

1. Introducing ChatBI-Text2Data tool
2. Complete basic parameter configuration

Name	Type	Required	Description
assistant_name	string	Yes	ChatBI assistant name configured in tongban
query	string	Yes	Natural language for querying data content
user_email	string	No	User email

If you want to use permission management and data isolation in itongban, you need to pass on the user's email to the itongban and perform data matching and association through the email. The parameter value of user_imail can be manually filled in as a fixed value, or it can be dynamically obtained by adding a pre node in the workflow using other tools.

Example

Output Example

{
  "text": "| daily_power_generation |\n|:---:|\n| 4.760533 |\n"
  "files": [],
  "json": [
    {
      "queryResults": [{"daily_power_generation": 4.760533}],
      "textResult": "| daily_power_generation |\n|:---:|\n| 4.760533 |\n"
    }
  ],
  "status": "success"
}

ChatBI-Text2Data-dev

1. Introducing ChatBI-Text2Data-dev tool
2. Complete basic parameter configuration

Name	Type	Required	Description
assistant_name	string	Yes	ChatBI assistant name configured in tongban
query	string	Yes	Natural language for querying data content
db_type	select	Yes	Database type(MySQL/PostgreSQL)
db_host	string	Yes	Database host address
db_port	number	Yes	Database port
db_username	string	Yes	Database username
db_password	secret-input	Yes	Database password
db_name	string	Yes	Database name
query_sql	string	Yes	Query SQL for dify user name or email

If you want to use permission management and data isolation in itongban, you need to pass on the user's email to the itongban and perform data matching and association through the email. db_type,db_host,db_port,db_username,db_password,db_name, These parameters are used to configure the database connection in the dify environment, and query_stql is used to configure the query of dify user email. If the SQL statement is a dynamic query, obtaining the user's email is dynamic, for example : select email from accounts where id = 'sys.user_id'

3. Example

Output Example

{
  "text": "| 数据日期 | 日发电量 |\n|:---:|:---:|\n| 2024-12-01 | 4.760533 |\n| 2024-12-02 | 5.977562 |\n| 2024-12-03 | 6.556473 |\n| 2024-12-04 | 7.774941 |\n| 2024-12-05 | 7.715627 |\n| 2024-12-06 | 7.622435 |\n| 2024-12-07 | 4.423754 |\n| 2024-12-08 | 5.316723 |\n| 2024-12-09 | 5.30591 |\n| 2024-12-10 | 2.643272 |\n| 2024-12-11 | 6.691127 |\n| 2024-12-12 | 7.552532 |\n| 2024-12-13 | 5.277958 |\n| 2024-12-14 | 3.705609 |\n| 2024-12-15 | 3.738823 |\n| 2024-12-16 | 6.030723 |\n| 2024-12-17 | 6.359641 |\n| 2024-12-18 | 6.556663 |\n| 2024-12-19 | 7.339836 |\n| 2024-12-20 | 1.723461 |\n| 2024-12-21 | 5.122004 |\n| 2024-12-22 | 3.636538 |\n| 2024-12-23 | 7.994277 |\n| 2024-12-24 | 6.048009 |\n| 2024-12-25 | 6.963684 |\n| 2024-12-26 | 5.877913 |\n| 2024-12-27 | 7.007194 |\n| 2024-12-28 | 3.65698 |\n| 2024-12-29 | 4.439459 |\n| 2024-12-30 | 1.827672 |\n| 2024-12-31 | 7.768858 |\n",
  "files": [],
  "json": [
    {
      "queryResults": [
        {"statistical_date": "2024-12-01","日发电量": 4.760533},{"statistical_date": "2024-12-02","日发电量": 5.977562},{"statistical_date": "2024-12-03","日发电量": 6.556473},{"statistical_date": "2024-12-04","日发电量": 7.774941},{"statistical_date": "2024-12-05","日发电量": 7.715627},{"statistical_date": "2024-12-06","日发电量": 7.622435},{"statistical_date": "2024-12-07","日发电量": 4.423754},{"statistical_date": "2024-12-08","日发电量": 5.316723},{"statistical_date": "2024-12-09","日发电量": 5.30591},{"statistical_date": "2024-12-10","日发电量": 2.643272},{"statistical_date": "2024-12-11","日发电量": 6.691127},{"statistical_date": "2024-12-12","日发电量": 7.552532},{"statistical_date": "2024-12-13","日发电量": 5.277958},{"statistical_date": "2024-12-14","日发电量": 3.705609},{"statistical_date": "2024-12-15","日发电量": 3.738823},{"statistical_date": "2024-12-16","日发电量": 6.030723},{"statistical_date": "2024-12-17","日发电量": 6.359641},{"statistical_date": "2024-12-18","日发电量": 6.556663},{"statistical_date": "2024-12-19","日发电量": 7.339836},{"statistical_date": "2024-12-20","日发电量": 1.723461},{"statistical_date": "2024-12-21","日发电量": 5.122004},{"statistical_date": "2024-12-22","日发电量": 3.636538},{"statistical_date": "2024-12-23","日发电量": 7.994277},{"statistical_date": "2024-12-24","日发电量": 6.048009},{"statistical_date": "2024-12-25","日发电量": 6.963684},{"statistical_date": "2024-12-26","日发电量": 5.877913},{"statistical_date": "2024-12-27","日发电量": 7.007194},{"statistical_date": "2024-12-28","日发电量": 3.65698},{"statistical_date": "2024-12-29","日发电量": 4.439459},{"statistical_date": "2024-12-30","日发电量": 1.827672},{"statistical_date": "2024-12-31","日发电量": 7.768858}],
      "textResult": "| 数据日期 | 日发电量 |\n|:---:|:---:|\n| 2024-12-01 | 4.760533 |\n| 2024-12-02 | 5.977562 |\n| 2024-12-03 | 6.556473 |\n| 2024-12-04 | 7.774941 |\n| 2024-12-05 | 7.715627 |\n| 2024-12-06 | 7.622435 |\n| 2024-12-07 | 4.423754 |\n| 2024-12-08 | 5.316723 |\n| 2024-12-09 | 5.30591 |\n| 2024-12-10 | 2.643272 |\n| 2024-12-11 | 6.691127 |\n| 2024-12-12 | 7.552532 |\n| 2024-12-13 | 5.277958 |\n| 2024-12-14 | 3.705609 |\n| 2024-12-15 | 3.738823 |\n| 2024-12-16 | 6.030723 |\n| 2024-12-17 | 6.359641 |\n| 2024-12-18 | 6.556663 |\n| 2024-12-19 | 7.339836 |\n| 2024-12-20 | 1.723461 |\n| 2024-12-21 | 5.122004 |\n| 2024-12-22 | 3.636538 |\n| 2024-12-23 | 7.994277 |\n| 2024-12-24 | 6.048009 |\n| 2024-12-25 | 6.963684 |\n| 2024-12-26 | 5.877913 |\n| 2024-12-27 | 7.007194 |\n| 2024-12-28 | 3.65698 |\n| 2024-12-29 | 4.439459 |\n| 2024-12-30 | 1.827672 |\n| 2024-12-31 | 7.768858 |\n"
    }
  ],
  "status": "success"
}

Developer Information

• Author: guojingi
• Email: 569706787@qq.com
• Support: Through Dify platform and GitHub Issues