chaplus_ros

ROS package for mebo: https://mebo.work/

Tutorials

1. optional) If you want to get new agent, please reference https://qiita.com/maKunugi/items/14f1b82a2c0b6fa5c202

2. For JSK Users, please download the apikey.json

3. Please start the sample launch with the following command.

  $ roslaunch chaplus_ros google_example.launch chaplus_apikey_file:=${HOME}/Downloads/apikey.json
  

This sample subscribes /speech_to_text [speech_recognition_msgs/SpeechRecognitionCandidates] and publishes /robotsound_jp [sound_play/SoundRequest]

1. You can try several conversations using rostopic pub command. Here is an example of sending “おはよう”.

  $ rostopic pub -1 /speech_to_text speech_recognition_msgs/SpeechRecognitionCandidates "transcript:
  - 'おはよう'
  confidence:
  - 0"
  

The reply from the bot can be checked using rostopic echo command.

  $ roopic echo --filter "print(m.arg)" /robotsound_jp
  or
  $ rostopic echo /robotsound_jp | ascii2uni -a U -q
  

Here is an example of conversations.

  # terminal 1
  $ rostopic pub -1 /speech_to_text speech_recognition_msgs/SpeechRecognitionCandidates "transcript:
  - 'おはよう'
  confidence:
  - 0"

  $ rostopic pub -1 /speech_to_text speech_recognition_msgs/SpeechRecognitionCandidates "transcript:
  - 'お話しよう'
  confidence:
  - 0"

  $ rostopic pub -1 /speech_to_text speech_recognition_msgs/SpeechRecognitionCandidates "transcript:
  - '何色が好き？'
  confidence:
  - 0"

  $ rostopic pub -1 /speech_to_text speech_recognition_msgs/SpeechRecognitionCandidates "transcript:
  - '良いですね。私は白が好きです。'
  confidence:
  - 0"
  

  # termial 2
  $ roopic echo --filter "print(m.arg)" /robotsound_jp
  おはようございます！
  あー、久しぶりにおしゃべりしたいですね。楽しみにしています。
  私の好きな色は緑です。気持ちが落ち着きますよね。
  私も好きです。気持ちが落ち着く気がしますから。
  

Interface

Subscribing Topics

• request (std_msgs/String)

  Input text data for chaplus bot system.

Publishing Topics

• response (std_msgs/String)

  Response text data from chaplus bot system.

Parameters

• ~chaplus_apikey_file (String: default: rospack find chaplus_ros/apikey.json

  Path to json file stores chaplus API key.

• ~communication_sample_file (String: default: rospack find chaplus_ros/communication_sample.json

  Path to json file of decided responses.

  If you do not want to use this, please set the parameter as use_sample:=false when roslaunch.

Sample Code

1) sample/julius_example.launch

Example to listen from your mic and respond from speakers, This demo uses Julius for speech to text engine, which requires vocabulary list. You need to change following line of the julius_example.launch to let system recognize your talk. Note that julius needs 20-30 seconds to update it’s vocabulary list, so please be patient after you send the list from your command line.

  <!-- julius needs vocabulary list -->
  <node pkg="rosservice" type="rosservice" name="update_vocabulary_list"
        args='call --wait /speech_recognition "{vocabulary: {words: ["こんにちは", "おはよう"]}}"' />

2) sample/google_example.launch

Example with google speech recognition. This demo requires google_cloud_credentials_json, and update following line of the google_example.launch

  <param name="/speech_recognition/google_cloud_credentials_json"
         value="/home/k-okada/Downloads/eternal-byte-236613-4bc6962824d1.json" />

Use other chat API

A3RT

If you want to use A3RT 1) Get A3RT APIKey Please access https://a3rt.recruit.co.jp/product/talkAPI/registered/ and enter your information.

2) Write A3RT API key in json file under `rospack find chaplus_ros`/apikey.json

{"apikey": "0123456789",
 "apikey_a3rt": "abcdefgh"}

3) raunch with A3RT option

roslaunch chaplus_ros google_example.launch chatbot_engine:=A3RT

Chaplus

Reference: https://www.chaplus.jp/. Note that support ends on August 31, 2022.

1) Obtain API keys for chaplus service, go to https://www.chaplus.jp/api

You can also create account via https://chaplus.work and reqeust beta program

2) Put API key as json file under `rospack find chaplus_ros`/apikey.json

   {"apikey": "0123456789"}
   

Changelog for package chaplus_ros

2.1.31 (2025-05-13)

2.1.30 (2025-05-10)

2.1.29 (2025-01-05)

2.1.28 (2023-07-24)

2.1.27 (2023-06-24)

2.1.26 (2023-06-14)

• add LICENSE files (#476)
• Contributors: Kei Okada

2.1.25 (2023-06-08)

• [chaplus_ros] support mebo (#374)
• [chaplus_ros] change a3rt urls (#360)
• .github/workflow: integrate all yaml to one (#338)
• Fix for noetic (#332)
  • [chaplus_ros][switchbot_ros]fix exec_depend in ros noetic
  • [chaplus_ros]support installation of python3-requests
• Contributors: Kei Okada, Miyabi Tanemoto, Shingo Kitagawa, Yoshiki Obinata, Ayaka Fujii

2.1.24 (2021-07-26)

2.1.23 (2021-07-21)

• add sample_json (#264)
• Contributors: Ayaka Fujii

2.1.22 (2021-06-10)

• add chat agent interface for ros (#252)
  • add A3RT chat engine
  • add chaplus ros interface see README.md for more information
• Contributors: Ayaka Fujii

2.1.21 (2020-08-19)

2.1.20 (2020-08-07)

2.1.19 (2020-07-21)

2.1.18 (2020-07-20)

2.1.17 (2020-04-16 21:51)

2.1.16 (2020-04-16 15:21)

2.1.15 (2019-12-12)

2.1.14 (2019-11-21)

2.1.13 (2019-07-10)

2.1.12 (2019-05-25)

2.1.11 (2018-08-29)

2.1.10 (2018-04-25)

2.1.9 (2018-04-24)

2.1.8 (2018-04-17)

2.1.7 (2018-04-09)

2.1.6 (2017-11-21)

2.1.5 (2017-11-20)

2.1.4 (2017-07-16)

2.1.3 (2017-07-07)

2.1.2 (2017-07-06)

2.1.1 (2017-07-05)

2.1.0 (2017-07-02)

2.0.20 (2017-05-09)

2.0.19 (2017-02-22)

2.0.18 (2016-10-28)

2.0.17 (2016-10-22)

2.0.16 (2016-10-17)

2.0.15 (2016-10-16)

2.0.14 (2016-03-20)

2.0.13 (2015-12-15)

2.0.12 (2015-11-26)

2.0.11 (2015-10-07 14:16)

2.0.10 (2015-10-07 12:47)

2.0.9 (2015-09-26)

2.0.8 (2015-09-15)

2.0.7 (2015-09-14)

2.0.6 (2015-09-08)

2.0.5 (2015-08-23)

2.0.4 (2015-08-18)

2.0.3 (2015-08-01)

2.0.2 (2015-06-29)

2.0.1 (2015-06-19 21:21)

2.0.0 (2015-06-19 10:41)

1.0.71 (2015-05-17)

1.0.70 (2015-05-08)

1.0.69 (2015-05-05 12:28)

1.0.68 (2015-05-05 09:49)

1.0.67 (2015-05-03)

1.0.66 (2015-04-03)

1.0.65 (2015-04-02)

1.0.64 (2015-03-29)

1.0.63 (2015-02-19)

1.0.62 (2015-02-17)

1.0.61 (2015-02-11)

1.0.60 (2015-02-03 10:12)

1.0.59 (2015-02-03 04:05)

1.0.58 (2015-01-07)

1.0.57 (2014-12-23)

1.0.56 (2014-12-17)

1.0.55 (2014-12-09)

1.0.54 (2014-11-15)

1.0.53 (2014-11-01)

1.0.52 (2014-10-23)

1.0.51 (2014-10-20 16:01)

1.0.50 (2014-10-20 01:50)

1.0.49 (2014-10-13)

1.0.48 (2014-10-12)

1.0.47 (2014-10-08)

1.0.46 (2014-10-03)

1.0.45 (2014-09-29)

1.0.44 (2014-09-26 09:17)

1.0.43 (2014-09-26 01:08)

1.0.42 (2014-09-25)

1.0.41 (2014-09-23)

1.0.40 (2014-09-19)

1.0.39 (2014-09-17)

1.0.38 (2014-09-13)

1.0.37 (2014-09-08)

1.0.36 (2014-09-01)

1.0.35 (2014-08-16)

1.0.34 (2014-08-14)

1.0.33 (2014-07-28)

1.0.32 (2014-07-26)

1.0.31 (2014-07-23)

1.0.30 (2014-07-15)

1.0.29 (2014-07-02)

1.0.28 (2014-06-24)

1.0.27 (2014-06-10)

1.0.26 (2014-05-30)

1.0.25 (2014-05-26)

1.0.24 (2014-05-24)

1.0.23 (2014-05-23)

1.0.22 (2014-05-22)

1.0.21 (2014-05-20)

1.0.20 (2014-05-09)

1.0.19 (2014-05-06)

1.0.18 (2014-05-04)

1.0.17 (2014-04-20)

1.0.16 (2014-04-19 23:29)

1.0.15 (2014-04-19 20:19)

1.0.14 (2014-04-19 12:52)

1.0.13 (2014-04-19 11:06)

1.0.12 (2014-04-18 16:58)

1.0.11 (2014-04-18 08:18)

1.0.10 (2014-04-17)

1.0.9 (2014-04-12)

1.0.8 (2014-04-11)

1.0.7 (2014-04-10)

1.0.6 (2014-04-07)

1.0.5 (2014-03-31)

1.0.4 (2014-03-29)

1.0.3 (2014-03-19)

1.0.2 (2014-03-12)

1.0.1 (2014-03-07)

1.0.0 (2014-03-05)