发布配置项预览

最近更新时间:2024-04-11 17:23:58

我的收藏

1. 接口描述

接口请求域名: lke.tencentcloudapi.com 。

发布配置项预览

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListReleaseConfigPreview。
Version String 公共参数,本接口取值:2023-11-30。
Region String 公共参数,详见产品支持的 地域列表
BotBizId String 机器人ID
PageNumber Integer 页码
PageSize Integer 每页数量
Query String 查询内容
ReleaseBizId String 发布单ID
Actions.N Array of Integer 状态(1新增2更新3删除)
StartTime String 开始时间
EndTime String 结束时间
ReleaseStatus.N Array of Integer 发布状态

3. 输出参数

参数名称 类型 描述
Total String 数量
List Array of ReleaseConfigs 配置项列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取待发布的配置项

获取待发布的配置项

输入示例

POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListReleaseConfigPreview
<公共请求参数>

{
    "BotBizId": "1747951478630252544",
    "PageNumber": 1,
    "PageSize": 15
}

输出示例

{
    "Response": {
        "List": [
            {
                "Action": 2,
                "ConfigItem": "应用名称",
                "Content": "",
                "LastValue": "",
                "UpdateTime": "1709694760",
                "Value": "上博"
            },
            {
                "Action": 2,
                "ConfigItem": "头像",
                "Content": "应用图标变更",
                "LastValue": "",
                "UpdateTime": "1709694760",
                "Value": "https://cdn.xiaowei.qq.com/lke/assets//static/avatar.png"
            },
            {
                "Action": 2,
                "ConfigItem": "欢迎语",
                "Content": "",
                "LastValue": "",
                "UpdateTime": "1709694760",
                "Value": "您好,我是客服助手,我将为您提供友好、专业和高效的服务。"
            },
            {
                "Action": 2,
                "ConfigItem": "输出方式",
                "Content": "",
                "LastValue": "非流式输出",
                "UpdateTime": "1709694760",
                "Value": "流式输出"
            },
            {
                "Action": 2,
                "ConfigItem": "通用模型回复开关",
                "Content": "",
                "LastValue": "关闭",
                "UpdateTime": "1709694760",
                "Value": "开启"
            },
            {
                "Action": 2,
                "ConfigItem": "默认问题回复",
                "Content": "",
                "LastValue": "",
                "UpdateTime": "1709694760",
                "Value": "作为一个智能助手,针对您这个问题,我所提供的答案或建议可能会存在不准确的地方。建议您转到人工,由专业顾问为您提供服务。"
            },
            {
                "Action": 2,
                "ConfigItem": "问答最大召回数量",
                "Content": "",
                "LastValue": "0",
                "UpdateTime": "1709694760",
                "Value": "3"
            },
            {
                "Action": 2,
                "ConfigItem": "回复灵活度",
                "Content": "",
                "LastValue": "已采纳答案润色回复",
                "UpdateTime": "1709694760",
                "Value": "已采纳答案直接回复"
            },
            {
                "Action": 2,
                "ConfigItem": "知识来源问答配置",
                "Content": "",
                "LastValue": "关闭",
                "UpdateTime": "1709694760",
                "Value": "开启"
            },
            {
                "Action": 2,
                "ConfigItem": "知识来源任务流程配置",
                "Content": "",
                "LastValue": "关闭",
                "UpdateTime": "1709694760",
                "Value": "开启"
            },
            {
                "Action": 2,
                "ConfigItem": "文档最大召回数量",
                "Content": "",
                "LastValue": "0",
                "UpdateTime": "1709694760",
                "Value": "4"
            },
            {
                "Action": 2,
                "ConfigItem": "知识来源文档配置",
                "Content": "",
                "LastValue": "关闭",
                "UpdateTime": "1709694760",
                "Value": "开启"
            },
            {
                "Action": 2,
                "ConfigItem": "上下文指代轮次",
                "Content": "",
                "LastValue": "0",
                "UpdateTime": "1709694760",
                "Value": "1"
            }
        ],
        "RequestId": "ac6c9baf-890b-4b63-b1b3-409eb74b0e14",
        "Total": "13"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码