vectara-answer Docker镜像文档

概述

vectara-answer 是一个开源React项目，提供可配置的对话式搜索用户界面。该Docker镜像用于部署此项目，使终端用户能够查询数据并获取准确、可靠的答案，也可作为构建自定义对话式搜索应用时的源码参考。对应的代码托管于GitHub。

核心功能与特性

• 提供可配置的用户界面，支持自定义标题、logo、描述等UI参数
• 支持精选问题建议，通过配置文件定义推荐问题
• 需配合配置文件使用，灵活适配不同数据查询场景
• 基于React构建，轻量易部署

使用场景

• 企业内部知识库查询系统
• 新闻、文档等信息聚合平台的搜索界面
• 客户支持问答系统，帮助用户快速获取信息
• 作为构建自定义对话式搜索应用的基础模板

使用方法与配置说明

前提条件

• 安装Docker环境
• 准备三个必要配置文件：config.yaml、queries.json、secrets.toml

配置文件说明

1. config.yaml

定义用户界面参数，如标题文本、logo图片、数据源等。

示例：

yaml
corpus_id: "151,152,153,154,155"
customer_id: ***

app_title: "AskNews"
app_header_learn_more_link: "[***]"
search_description: "基于Vectara构建的新闻聚合示例"
search_logo_src: "images/asknews_logo.png" ## 可为URL
search_logo_alt: "AskNews logo"
search_logo_height: "20"

enable_source_filters: True
sources: "BBC,NPR,FOX,CNBC,CNN"

2. queries.json

定义UI上显示的精选推荐问题。

示例：

json
{
    "questions": [
        "Should AI be regulated?",
        "Will AI replace Hollywood screenwriters?",
        "Should athletes be allowed to protest?",
        "what happened to Harry and Megan in NYC?"
    ]
}

3. secrets.toml

提供查询Vectara语料库所需的凭证信息。

示例：

toml
[news]
    api_key="zwt_YZD..."
[finance]
    api_key="zwt_YOQ..."

运行步骤

1. 生成.env配置文件

使用项目提供的prepare_config.py脚本，将config.yaml和secrets.toml的配置合并为.env文件：

bash
# config/asknews/config.yaml为配置文件路径，"news"为secrets.toml中的配置文件名称
python3 prepare_config.py config/asknews news

2. 启动Docker容器

将本地的.env和queries.json文件挂载到容器中，运行以下命令：

bash
docker run --platform=linux/amd64 -d  -v $(PWD)/queries.json:/usr/src/app/build/queries.json  \
     -p 127.0.0.1:80:3000/tcp \
     --env-file .env  \
     --name vanswer  vectara/vectara-answer

参数说明：

• --platform=linux/amd64：指定容器平台
• -v $(PWD)/queries.json:/usr/src/app/build/queries.json：挂载本地queries.json到容器内对应路径
• -p 127.0.0.1:80:3000/tcp：将容器的3000端口映射到本地80端口
• --env-file .env：加载.env环境变量文件
• --name vanswer：指定容器名称为vanswer
• vectara/vectara-answer：使用的Docker镜像名称