携程问道(workbuddy 合作版)技能接入与使用文档
本文档详细介绍携程问道workbuddy 合作版技能wendao-partner-workbuddy-skill的接入流程、使用方法、环境配置及注意事项适用于需要集成该技能并调用携程问道 API 获取旅行相关信息的开发 / 运维人员。一、技能概述1. 核心能力该技能针对各类旅行相关问询场景触发如酒店 / 机票预订、景点推荐、行程规划、签证查询等触发后通过调用携程问道 API 返回专业的旅行规划与攻略信息不依赖通用知识库回答。2. 核心约束技能触发后仅允许通过调用问道 API 获取结果禁止使用通用知识库回答旅行问题API 返回结果仅提取result字段展示给用户其余字段如events/messages/state为内部日志不对外展示。二、前置准备1. 环境要求运行环境已安装 Node.jsv18 及以上版本可访问公网能调用携程问API域名(https://externalcallback.ctrip.com。2. 获取 API Token1访问携程问道开放平台https://www.ctrip.com/wendao/openclaw2按页面指引完成认证申请并复制 API TokenAPI Key3注意Token 为敏感信息仅保存在可信环境禁止截图 / 泄露完整密钥到公开渠道。三、环境配置Token 设置API Token 通过环境变量WENDAO_API_KEY传入优先级高于临时传入支持以下配置方式按需选择1. 临时配置当前终端会话有效macOS/Linuxexport WENDAO_API_KEY你的API TokenWindows CMDset WENDAO_API_KEY你的API TokenWindows PowerShell$env:WENDAO_API_KEY你的API Token2. 长期配置本机永久生效macOS/Linux将Token 写入终端配置文件如~/.zshrc/~/.bash_profileecho export WENDAO_API_KEY你的API Token ~/.zshrc source ~/.zshrc # 立即生效Windows在「系统设置 - 高级系统设置 - 环境变量」中添加「用户变量」WENDAO_API_KEY值为你的 Token。3. 托管环境配置OpenClaw / 腾讯云等在平台的技能环境变量配置页新增 WENDAO_API_KEY 值为你的 API Token确保技能运行时可读取该变量。四、技能使用方法1. 脚本位置技能目录下的scripts/wendao_query.js为核心调用脚本支持通过命令行参数或环境变量传入用户查询内容。2. 执行方式推荐写文件执行避免引号嵌套错误方式 1命令行参数传入用户查询# 格式node scripts/wendao_query.js 用户的旅行相关查询内容 node scripts/wendao_query.js 预订明天北京三里屯附近的酒店预算800-1200元方式 2环境变量传入用户查询# 格式WENDAO_QUERY用户查询内容 node scripts/wendao_query.js WENDAO_QUERY规划7天日本自由行行程 node scripts/wendao_query.js方式 3临时传入 Token若未提前配置WENDAO_API_KEY可在执行命令时临时传入仅本次调用有效# macOS/Linux WENDAO_API_KEY你的Token node scripts/wendao_query.js 查询北京到上海的高铁票 # Windows CMD set WENDAO_API_KEY你的Token node scripts/wendao_query.js 查询北京到上海的高铁票 # Windows PowerShell $env:WENDAO_API_KEY你的Token; node scripts/wendao_query.js 查询北京到上海的高铁票3. 脚本参数说明参数必填说明WENDAO_API_KEY是API 认证 Token优先级环境变量 命令行临时传入USER_QUERY是用户的旅行相关自然语言查询完整问句如 “暑假去成都的景点推荐”timeout否API 请求超时时间默认 30 秒脚本内置无需手动配置4. 结果输出脚本执行后控制台会打印 API 返回的result字段内容Markdown 格式该内容即为可展示给用户的旅行相关结果。五、常见场景示例场景执行命令示例酒店预订node scripts/wendao_query.js 上海外滩五星级酒店预算800-1200元航班搜索node scripts/wendao_query.js 明天从北京到上海的航班优先国航景点推荐node scripts/wendao_query.js 成都周边适合亲子游的景点推荐行程规划node scripts/wendao_query.js 7天日本蜜月旅行行程规划含东京和京都签证查询node scripts/wendao_query.js 2024年办理泰国旅游签证的流程和材料六、API 响应解析说明API 返回 JSON 结构示例{ result: Markdown格式的回复内容字符串, messages: [...], // 内部日志忽略 state: {token: ..., query: ...}, // 内部状态忽略 events: [...], // 内部事件忽略 error: null }脚本会自动提取 result 字段若 result 为字符串直接输出若 result 为对象提取 result.content 无则转为 JSON 字符串输出。七、安全与合规注意事项1.域名验证确保 API 请求仅发送至官方域名https://externalcallback.ctrip.com禁止改用未知域名2. 权限与计费提前确认 Token 的权限范围、计费规则、QPS / 配额限制避免超额或误用3. 内容处理API 返回结果可能包含链接、营销文案需按自身产品策略决定是否展示 / 过滤 / 摘要。八、故障排查1. 脚本执行报错 “缺少 token 或 query”检查WENDAO_API_KEY是否已配置且值不为空检查用户查询内容是否传入命令行参数或WENDAO_QUERY环境变量确保非空。2. API 请求返回 HTTP 错误如 401/403验证 Token 是否有效是否过期检查 Token 权限是否覆盖当前查询场景如酒店 / 机票 / 签证等。3. 脚本无输出或输出非预期内容确认 API 返回的result字段是否有值检查 Node.js 版本是否≥v18避免兼容性问题。九、附录技能触发规则当用户查询包含以下关键词 / 句式时技能自动触发中英文旅行相关操作词 场景词如 “预订酒店”“search flight”“行程规划”“visa application”旅行场景限定词如 “亲子游”“商务出差”“黄金周旅行”“honeymoon trip”具体目的地 场景如 “北京到上海的高铁票”“hotels in Shanghai”。“携程技术”公众号分享交流成长
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2614017.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!