Package: converse-sfr
ConverseConverse is a flexible framework for building and deploying task-oriented chatbots.Table of ContentsGetting StartedLearn more about ConverseHow to contributeCiting ConverseGetting StartedRequirementspython >= 3.7Running the NLU (NER/Intent/Coreference) servicesPlease check outrunning NLU services in docker containerRunning the Demo - Quick StartIf you don't plan to edit the package code, we recommend using this method of running Converse because it is easier.InstallDocker.Create a Python 3.7 virtual environment usingCondaand activate it.Run the following command to install the pip package of Converse:pip install -i https://test.pypi.org/pypi/ --extra-index-url https://pypi.org/simple converse-test-command==0.2.16Installsvnon your computer. On Mac, run:brew install svnRunconverse-shellto test if the package is successfully installed.
If the command line output contains"Hello, Converse!", then you installed the package successfully.Runconverse-demoto interact with pre-built example bots, and follow the instructions in your terminal.
Note that first-time users can leave every required input empty to use the default value.
Open the link provided by the script using your favorite browser, then you should see the demo page (pictured below).
You can interact with the bot by typing in the chat box on the right and the tree visualization will change based on
your task progress. Remember that the example bots are not open-domain chatbots. Please checkTemplate Botsfor the details of the template bots before you run the demo.Runconverse-buildto configure your own bot. Follow the instructions in the terminal to set up the bot.
Note that first-time users can leave every required input empty to use the default value.
Open the link provided by the script using your favorite browser, then you should see the configuration page
(pictured below). To learn more about how to build your own bot, please refer toguide for building your first bot.Running the Demo After Modifying Files in ConverseClone this repo andcdinto theConversedirectorygit clone git@github.com:salesforce/Converse.git
cd ConverseCreate a Python 3.7 virtual environment usingConda.Install dependencies. All the necessary packages are listed inrequirements.txt. You can install all the
dependencies by running the following command:pip install -r requirements.txtAdd theConversefolder to yourPYTHONPATH.export PYTHONPATH=$PYTHONPATH:/your_directory/ConverseIn one terminal window, run the backend and check the log file converse.log:LOGLEVEL=[debug|info|warning|error|critical] python Converse/demo/dial_backend.pyYou may want to specify custom config files. Supply--helpoption to help you out. The default config files are
listed inorchestrator.pyfile.In a separate terminal window, run the entity backend services:python Converse/entity_backend/entity_service_backend.pyIn a separate terminal window, run the front end and start interacting with the bot!python Converse/demo/client.pyYou can interact with the bot directly in the command line or in the browser by openinghttp://localhost:9002/clientin your favorite browser.  To learn more about how to build your own bot, please refer toguide for building your first bot.Learn more about ConversePlease refer to thetutorial on how to build your first botto get started
by building your first bot.To learn more about how to customize Converse for your use case, please refer to our documentation for each component of the system:Task ConfigurationEntity ConfigurationResponse ConfigurationPolicy ConfigurationInformation Layer ConfigurationTemplate BotsHow to contributeWelcome! We are so happy to see you willing to make your contributions to this repository!You can contribute via pull requests. Please follow these steps:Create an issue describing the feature you want to add or modify. A maintainer will review your issue.Discuss the issue with the maintainer in the issue you created.Write your code, tests and documentation, and format them withblack. We provide arun_black.shscript to help you format your code.Run./run_unittest.sh. Make sure that no error occurs in the tests.Create a pull request (PR) describing your changes. Note that your PR should be a reasonable length (<= 500 lines).Your PR will be reviewed by a maintainer. When you get the approval from the maintainer, you can merge your code into the
main branch.Citing ConverseYou can find more details in our paper:https://arxiv.org/abs/2203.12187If you're using Converse in your research or applications, please cite using this BibTeX:@article{xie2022converse,
  title={Converse--A Tree-Based Modular Task-Oriented Dialogue System},
  author={Xie, Tian and Yang, Xinyi and Lin, Angela S. and Wu, Feihong and Hashimoto, Kazuma and Qu, Jin and Kang, Young Mo and Yin, Wenpeng and Wang, Huan and Yavuz, Semih and Wu, Gang and Jones, Michael and Socher, Richard and Zhou, Yingbo and Liu, Wenhao and Xiong, Caiming},
  journal={arXiv preprint arXiv:2203.12187},
  year={2022}
}