tock/bot_api

Tock Bot API 镜像文档

镜像概述

Tock Bot API 镜像为开源对话AI框架 https://github.com/theopenconversationkit/tock%EF%BC%88The Open Conversation Kit）提供容器化部署的机器人接口服务。该镜像封装了Tock框架的核心Bot API组件，作为对话机器人的后端接口层，负责接收、处理客户端或消息平台的对话请求，并返回机器人响应，是基于Tock构建对话应用的关键基础设施。

核心功能与特性

• Tock框架原生集成：与Tock开源生态深度兼容，支持Tock的对话流程管理、多轮对话状态维护及自然语言理解能力
• 标准化API接口：提供RESTful API接口，支持机器人消息的接收、解析与响应，兼容Tock客户端协议规范
• 多渠道适配支持：通过Tock核心模块间接支持主流消息平台集成（如*** Messenger、Slack、***等），统一对话接入层
• 可配置化部署：支持通过环境变量或配置文件自定义服务参数，包括数据库连接、日志级别、超时策略等
• 轻量级容器化：优化的容器镜像设计，简化部署流程，支持快速启动与横向扩展，兼容Docker及Kubernetes等编排平台

使用场景

• 对话机器人开发：供开发者部署Tock机器人的后端API服务，作为机器人与前端/消息渠道的中间层
• 企业级对话应用：支持企业构建客户服务、智能助手、信息查询等场景的对话系统，处理用户交互
• 多渠道机器人管理：统一管理部署在不同消息平台的机器人实例，通过单一API接口处理跨渠道对话请求

使用方法

前提条件

• 已安装Docker Engine（20.10+版本推荐）或Docker Compose
• （可选）Tock所需的数据库服务（推荐PostgreSQL），用于存储对话状态及配置数据

Docker Run 快速部署

bash
docker run -d \
  --name tock-bot-api \
  -p 8080:8080 \
  -e SPRING_DATASOURCE_URL=jdbc:postgresql://db-host:5432/tock \
  -e SPRING_DATASOURCE_USERNAME=db-user \
  -e SPRING_DATASOURCE_PASSWORD=db-pass \
  -e LOG_LEVEL=INFO \
  tock/bot-api:latest

参数说明

• -p 8080:8080：映射容器内API服务端口（默认8080）至主机端口
• SPRING_DATASOURCE_URL：数据库连接URL（Tock默认使用PostgreSQL，格式为jdbc:postgresql://<host>:<port>/<database>）
• SPRING_DATASOURCE_USERNAME/SPRING_DATASOURCE_PASSWORD：数据库认证信息（必填）
• LOG_LEVEL：日志输出级别（支持DEBUG/INFO/WARN/ERROR，默认INFO）

Docker Compose 部署示例

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  tock-bot-api:
    image: tock/bot-api:latest
    container_name: tock-bot-api
    ports:
      - "8080:8080"
    environment:
      - SPRING_DATASOURCE_URL=jdbc:postgresql://postgres:5432/tock
      - SPRING_DATASOURCE_USERNAME=postgres
      - SPRING_DATASOURCE_PASSWORD=postgres
      - LOG_LEVEL=INFO
      - SERVER_PORT=8080
    depends_on:
      - postgres
    restart: unless-stopped

  postgres:
    image: postgres:14
    container_name: tock-postgres
    environment:
      - POSTGRES_DB=tock
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  postgres-data:

启动服务：

bash
docker-compose up -d

配置参数

环境变量配置

配置文件挂载

如需复杂配置，可通过挂载Tock配置文件自定义服务行为：

bash
docker run -d \
  --name tock-bot-api \
  -p 8080:8080 \
  -v /host/path/to/application.conf:/app/conf/application.conf \
  tock/bot-api:latest

配置文件格式参考Tock官方文档的应用配置规范。

注意事项

• 数据库依赖：Tock Bot API需连接数据库存储对话状态及配置，推荐使用PostgreSQL 12+版本
• 版本兼容性：需确保镜像版本与Tock框架其他组件（如NLP服务）版本匹配
• 资源配置：根据机器人并发量调整容器资源，建议生产环境配置至少1核CPU及1GB内存
• 安全加固：生产环境建议启用TOCK_API_KEY鉴权，并限制CORS_ALLOWED_ORIGINS为可信域名