Converse 开源项目使用教程

Converse 开源项目使用教程

Converse 项目地址: https://gitcode.com/gh_mirrors/con/Converse

1. 项目目录结构及介绍

Converse 项目的目录结构如下：

Converse/
├── Converse/
│   ├── demo/
│   ├── entity_backend/
│   ├── orchestrator.py
│   ├── ...
├── documentation/
├── pictures/
├── test_files/
├── flake8/
├── gitignore
├── CODEOWNERS
├── CODE_OF_CONDUCT.md
├── Jenkinsfile
├── LICENSE.txt
├── README.md
├── SECURITY.md
├── pyproject.toml
├── requirements.txt
├── run_black.sh
├── run_config_UI.sh
├── run_flake8.sh
├── run_nlu_service.sh
├── run_unittest.sh
├── setup.py
├── wsgi.py
└── ...

目录结构介绍

• Converse/: 项目的主要代码目录，包含核心功能模块。
  • demo/: 包含演示和测试的脚本。
  • entity_backend/: 实体后端服务代码。
  • orchestrator.py: 项目的主要启动文件。
• documentation/: 项目文档目录。
• pictures/: 项目图片资源目录。
• test_files/: 测试文件目录。
• flake8/: 代码风格检查工具配置。
• gitignore: Git 忽略文件配置。
• CODEOWNERS: 代码所有者配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• Jenkinsfile: Jenkins 持续集成配置文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• SECURITY.md: 安全相关说明。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖包列表。
• run_black.sh: 代码格式化脚本。
• run_config_UI.sh: 配置 UI 启动脚本。
• run_flake8.sh: 代码风格检查启动脚本。
• run_nlu_service.sh: NLU 服务启动脚本。
• run_unittest.sh: 单元测试启动脚本。
• setup.py: Python 项目安装脚本。
• wsgi.py: WSGI 应用启动文件。

2. 项目启动文件介绍

主要启动文件

• orchestrator.py: 这是 Converse 项目的主要启动文件。它负责协调和管理整个对话系统的运行。

启动命令

1. 启动后端服务:

   python Converse/demo/dial_backend.py
   

2. 启动实体后端服务:

   python Converse/entity_backend/entity_service_backend.py
   

3. 启动前端服务:

   python Converse/demo/client.py
   

3. 项目配置文件介绍

主要配置文件

• pyproject.toml: 包含项目的元数据和构建配置。
• requirements.txt: 列出了项目所需的所有 Python 依赖包。
• Jenkinsfile: 用于 Jenkins 持续集成的配置文件。
• run_black.sh: 代码格式化脚本，用于保持代码风格一致。
• run_flake8.sh: 代码风格检查脚本，用于检查代码是否符合 PEP 8 规范。
• run_nlu_service.sh: 启动 NLU 服务的脚本。
• run_unittest.sh: 运行单元测试的脚本。

配置文件示例

pyproject.toml

[tool.poetry]
name = "Converse"
version = "0.0.1"
description = "A flexible framework for building and deploying task-oriented chatbots"
authors = ["Salesforce"]

[tool.poetry.dependencies]
python = "^3.7"
...

requirements.txt

converse-sfr==0.0.2
...

Jenkinsfile

pipeline {
    agent any
    stages {
        stage('Build') {
            steps {
                sh 'python setup.py install'
            }
        }
        stage('Test') {
            steps {
                sh './run_unittest.sh'
            }
        }
    }
}

通过以上配置文件和启动文件的介绍，您可以更好地理解和使用 Converse 项目。

Converse 项目地址: https://gitcode.com/gh_mirrors/con/Converse