网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

更新智能直播间互动规则库

更新时间:2025-01-24 GMT+08:00
分享

功能介绍

该接口用于更新智能直播间互动规则库。

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/smart-live-interaction-rule-groups/{group_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

group_id

String

互动规则库ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

格式为(YYYYMMDD'T'HHMMSS'Z')。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息。

X-App-UserId

String

第三方用户ID。不允许输入中文。

表3 请求Body参数

参数

是否必选

参数类型

描述

group_name

String

互动规则库名称

interaction_rules

Array of InteractionRuleInfo objects

互动规则列表

表4 InteractionRuleInfo

参数

是否必选

参数类型

描述

rule_index

String

参数解释

规则索引。用于触发规则时索引具体规则。

约束限制

无需用户填写。

取值范围

字符0-64位

默认取值

不涉及。

rule_name

String

参数解释

规则名称。

约束限制

不涉及。

取值范围

字符0-256位

默认取值

不涉及。

enabled

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用

  • fasle:不启用

默认取值

true

event_type

Integer

参数解释

规则匹配直播事件类型。接口的取值范围[0,100],实际业务取值如下所示:

  • 1:弹幕事件

  • 2:用户入场事件

  • 3:用户点赞事件

  • 4:用户送礼事件

  • 10: 预置话术事件

请以实际业务取值为准。

说明:
  • 1,2,3,4:与LiveEventReport中的event.type对应。

  • 10:匹配预置剧本

约束限制

不涉及。

默认取值

不涉及

取值范围:

0-100

hit_condition

HitCondition object

规则命中的条件

trigger

TriggerProcess object

规则命中后处理

review_config

ReviewConfig object

内容审核配置

表5 HitCondition

参数

是否必选

参数类型

描述

relation

String

参数解释

条件关系。对于多个条件的逻辑运算关系。

约束限制

不涉及。

取值范围

  • AND:表示多个条件同时满足。

  • OR:表示多个条件满足其一即可。

  • RESERVED:兜底回复不会去判断其他命中条件。

默认取值

不涉及。

priority

Integer

参数解释

优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值

约束限制

不涉及

取值范围:

0-999

默认取值:

500

tags

Array of HitConditionTag objects

匹配关系配置

表6 HitConditionTag

参数

是否必选

参数类型

描述

tag

String

参数解释

事件内容关键字段

说明:
  • event_type为1,2,3,4:与LiveEventReport中event.content中反序列化后的JSON字段对应。如:弹幕事件上报事件。

    {

    "timestamp": 1694481224245,

    "type": 1,

    "content": "{"user":{"userId":"2027271526","name":"","level":17,"badge":"","badgeLevel":0},"content":""}"

    }

    匹配弹幕内容,填写content;匹配用户平台等级,填写level。

  • 10:固定填写content即可。

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

operation

String

参数解释

字段取值处理

约束限制

不涉及

取值范围

  • SUM:累计

  • AVG:平均

  • COUNT:计数

  • NONE:无处理

默认取值:

NONE

match

String

参数解释

匹配类型。关键词匹配建议使用REGEX。

约束限制

不涉及。

取值范围

  • EQUAL: 完全相等

  • REGEX:正则匹配

  • MATH_GT:数值大于

  • MATH_GE:数值大于等于

  • MATH_LT:数值小于

  • MATH_LE:数值小于等于

  • MATH_EQ:数值相等

默认取值

不涉及

value

String

参数解释

匹配值。

约束限制

不涉及

取值范围

字符长度0-1024

默认取值

不涉及。

表7 TriggerProcess

参数

是否必选

参数类型

描述

time_window

Integer

参数解释

处理抑制时长。单位秒。

  • -1:表示整场直播仅触发一次。

  • 0:表示无抑制,每次都触发。

  • 其他值n:表示n秒内仅触发一次。

约束限制

不涉及

默认取值

不涉及

取值范围:

-1-7200

reply_mode

String

参数解释

回复类型。

约束限制

不涉及

取值范围

  • SYSTEM_REPLY:系统自动回复预先设置的话术。

  • CALLBACK:回调给其他服务,携带设置的话术。

  • SHOW_LAYER:仅显示叠加图层,不影响话术。

  • INTELLIGENT_REPLY:使用配置的大模型生成回复话术。

默认取值

不涉及

layer_config

SmartLayerConfig object

智能图层配置。

extra_layer_config

SmartLayerConfig object

额外图层,用于有产品同时需要显示动态文本场景,配置第二图层使用。

reply_texts

Array of strings

参数解释

回复话术集。

约束限制

不涉及

取值范围

最大支持5条预置话术。

单条话术字符长度0-1024位。

默认取值

不涉及

reply_audios

Array of ReplyAudioInfo objects

参数解释

回复音频集。填写audio_url。

约束限制

不涉及

取值范围

最大支持5条预置音频。

默认取值

不涉及

reply_order

String

参数解释

回复话术选择次序。

约束限制

不涉及

取值范围

  • RANDOM:随机

  • ORDER:顺序循环

默认取值

不涉及

reply_role

String

参数解释

回复角色。

约束限制

不涉及

取值范围

  • STREAMER:主播

  • CO_STREAMER:助播,仅声音。

默认取值:

STREAMER

robot_id

String

参数解释

机器人ID。

约束限制

reply_mode为INTELLIGENT_REPLY时必填,智能交互配置的大模型机器人ID。

获取方法请参考创建应用

取值范围

字符长度0-64位。

默认取值

不涉及

play_type

String

回复播放类型。

  • APPEND:追加,放置在场景播放队列尾部

  • INSERT: 插入,在两个音频文件,或者文本句末添加。

  • PLAY_NOW : 立即插入,收到指令后,立即播放,无需等待句末。

默认取值:

PLAY_NOW

表8 SmartLayerConfig

参数

是否必选

参数类型

描述

layer_type

String

图层类型。

  • IMAGE: 素材图片图层

  • VIDEO: 素材视频图层

  • TEXT: 文本图层

asset_id

String

图层所需资产的资产id,外部资产信息无需填写

position

LayerPositionConfig object

图层位置配置。

size

LayerSizeConfig object

图层大小配置。

image_config

SmartImageLayerConfig object

素材图片图层配置。

video_config

SmartVideoLayerConfig object

素材视频图层配置。

text_config

SmartTextLayerConfig object

素材视频图层配置。

表9 LayerPositionConfig

参数

是否必选

参数类型

描述

dx

Integer

参数解释

图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

-1920-3840

默认取值:

0

dy

Integer

参数解释

图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

-1920-3840

默认取值:

0

layer_index

Integer

参数解释

图片、视频、人物图的层顺序。

说明:

图层顺序为从1开始的整数,底层图层顺序是1,往上依次增加。

约束限制

如果出现重复则重复图层叠加关系随机。

取值范围:

1-100

默认取值:

100

表10 LayerSizeConfig

参数

是否必选

参数类型

描述

width

Integer

参数解释

图层图片宽度像素值(相对画布大小)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

1-7680

height

Integer

参数解释

图层图片高度像素值(相对画布大小)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。|

取值范围:

1-7680

表11 SmartImageLayerConfig

参数

是否必选

参数类型

描述

image_url

String

图片文件的URL。

display_duration

Integer

参数解释

图片显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致。若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表12 SmartVideoLayerConfig

参数

是否必选

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

display_duration

Integer

参数解释

图片显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致。若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表13 SmartTextLayerConfig

参数

是否必选

参数类型

描述

text_type

String

参数解释

文本类型。

  • DYNAMIC:动态文本,需要进行关键字替换。

  • STATIC:静态文本。

默认取值:

DYNAMIC

text_context

String

文本。

font_name

String

参数解释

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

  • fzyouh:方正瘦体

默认取值:

HarmonyOS_Sans_SC_Black

font_size

Integer

参数解释

字体大小(像素)。

业务取值范围:[4, 120],请以业务取值范围为准。

取值范围:

0-120

默认取值:

16

font_color

String

参数解释

字体颜色。RGB颜色值。

默认取值:

#FFFFFF

display_duration

Integer

参数解释

文本显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致;若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表14 ReplyAudioInfo

参数

是否必选

参数类型

描述

audio_url

String

音频URL

audio_name

String

音频名

表15 ReviewConfig

参数

是否必选

参数类型

描述

no_need_review

Boolean

免审核。 目前仅白名单用户可使用此参数,非白名单用户跟随系统策略审核。

响应参数

状态码:200

表16 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表17 响应Body参数

参数

参数类型

描述

group_id

String

互动规则库ID

group_name

String

互动规则库名称

interaction_rules

Array of InteractionRuleDetailInfo objects

互动规则列表

create_time

String

创建时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

update_time

String

更新时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

表18 InteractionRuleDetailInfo

参数

参数类型

描述

rule_index

String

参数解释

规则索引。用于触发规则时索引具体规则。

约束限制

无需用户填写。

取值范围

字符0-64位

默认取值

不涉及。

rule_name

String

参数解释

规则名称。

约束限制

不涉及。

取值范围

字符0-256位

默认取值

不涉及。

enabled

Boolean

参数解释

是否启用。

约束限制

不涉及。

取值范围

  • true:启用

  • fasle:不启用

默认取值

true

event_type

Integer

参数解释

规则匹配直播事件类型。接口的取值范围[0,100],实际业务取值如下所示:

  • 1:弹幕事件

  • 2:用户入场事件

  • 3:用户点赞事件

  • 4:用户送礼事件

  • 10: 预置话术事件

请以实际业务取值为准。

说明:
  • 1,2,3,4:与LiveEventReport中的event.type对应。

  • 10:匹配预置剧本

约束限制

不涉及。

默认取值

不涉及

取值范围:

0-100

hit_condition

HitCondition object

规则命中的条件

trigger

TriggerProcess object

规则命中后处理

review_config

ReviewConfig object

内容审核配置

rule_id

String

互动规则ID

create_time

String

创建时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

update_time

String

更新时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。

表19 HitCondition

参数

参数类型

描述

relation

String

参数解释

条件关系。对于多个条件的逻辑运算关系。

约束限制

不涉及。

取值范围

  • AND:表示多个条件同时满足。

  • OR:表示多个条件满足其一即可。

  • RESERVED:兜底回复不会去判断其他命中条件。

默认取值

不涉及。

priority

Integer

参数解释

优先级,数值越低优先级越高;取值0-999,默认值为500,为可选值

约束限制

不涉及

取值范围:

0-999

默认取值:

500

tags

Array of HitConditionTag objects

匹配关系配置

表20 HitConditionTag

参数

参数类型

描述

tag

String

参数解释

事件内容关键字段

说明:
  • event_type为1,2,3,4:与LiveEventReport中event.content中反序列化后的JSON字段对应。如:弹幕事件上报事件。

    {

    "timestamp": 1694481224245,

    "type": 1,

    "content": "{"user":{"userId":"2027271526","name":"","level":17,"badge":"","badgeLevel":0},"content":""}"

    }

    匹配弹幕内容,填写content;匹配用户平台等级,填写level。

  • 10:固定填写content即可。

约束限制

不涉及

取值范围

字符长度0-256位

默认取值

不涉及

operation

String

参数解释

字段取值处理

约束限制

不涉及

取值范围

  • SUM:累计

  • AVG:平均

  • COUNT:计数

  • NONE:无处理

默认取值:

NONE

match

String

参数解释

匹配类型。关键词匹配建议使用REGEX。

约束限制

不涉及。

取值范围

  • EQUAL: 完全相等

  • REGEX:正则匹配

  • MATH_GT:数值大于

  • MATH_GE:数值大于等于

  • MATH_LT:数值小于

  • MATH_LE:数值小于等于

  • MATH_EQ:数值相等

默认取值

不涉及

value

String

参数解释

匹配值。

约束限制

不涉及

取值范围

字符长度0-1024

默认取值

不涉及。

表21 TriggerProcess

参数

参数类型

描述

time_window

Integer

参数解释

处理抑制时长。单位秒。

  • -1:表示整场直播仅触发一次。

  • 0:表示无抑制,每次都触发。

  • 其他值n:表示n秒内仅触发一次。

约束限制

不涉及

默认取值

不涉及

取值范围:

-1-7200

reply_mode

String

参数解释

回复类型。

约束限制

不涉及

取值范围

  • SYSTEM_REPLY:系统自动回复预先设置的话术。

  • CALLBACK:回调给其他服务,携带设置的话术。

  • SHOW_LAYER:仅显示叠加图层,不影响话术。

  • INTELLIGENT_REPLY:使用配置的大模型生成回复话术。

默认取值

不涉及

layer_config

SmartLayerConfig object

智能图层配置。

extra_layer_config

SmartLayerConfig object

额外图层,用于有产品同时需要显示动态文本场景,配置第二图层使用。

reply_texts

Array of strings

参数解释

回复话术集。

约束限制

不涉及

取值范围

最大支持5条预置话术。

单条话术字符长度0-1024位。

默认取值

不涉及

reply_audios

Array of ReplyAudioInfo objects

参数解释

回复音频集。填写audio_url。

约束限制

不涉及

取值范围

最大支持5条预置音频。

默认取值

不涉及

reply_order

String

参数解释

回复话术选择次序。

约束限制

不涉及

取值范围

  • RANDOM:随机

  • ORDER:顺序循环

默认取值

不涉及

reply_role

String

参数解释

回复角色。

约束限制

不涉及

取值范围

  • STREAMER:主播

  • CO_STREAMER:助播,仅声音。

默认取值:

STREAMER

robot_id

String

参数解释

机器人ID。

约束限制

reply_mode为INTELLIGENT_REPLY时必填,智能交互配置的大模型机器人ID。

获取方法请参考创建应用

取值范围

字符长度0-64位。

默认取值

不涉及

play_type

String

回复播放类型。

  • APPEND:追加,放置在场景播放队列尾部

  • INSERT: 插入,在两个音频文件,或者文本句末添加。

  • PLAY_NOW : 立即插入,收到指令后,立即播放,无需等待句末。

默认取值:

PLAY_NOW

表22 SmartLayerConfig

参数

参数类型

描述

layer_type

String

图层类型。

  • IMAGE: 素材图片图层

  • VIDEO: 素材视频图层

  • TEXT: 文本图层

asset_id

String

图层所需资产的资产id,外部资产信息无需填写

position

LayerPositionConfig object

图层位置配置。

size

LayerSizeConfig object

图层大小配置。

image_config

SmartImageLayerConfig object

素材图片图层配置。

video_config

SmartVideoLayerConfig object

素材视频图层配置。

text_config

SmartTextLayerConfig object

素材视频图层配置。

表23 LayerPositionConfig

参数

参数类型

描述

dx

Integer

参数解释

图层左上角像素点的X轴位置值(画布左上角坐标是0x0)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

-1920-3840

默认取值:

0

dy

Integer

参数解释

图层图片左上角像素点的Y轴位置值(画布左上角坐标是0x0)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

-1920-3840

默认取值:

0

layer_index

Integer

参数解释

图片、视频、人物图的层顺序。

说明:

图层顺序为从1开始的整数,底层图层顺序是1,往上依次增加。

约束限制

如果出现重复则重复图层叠加关系随机。

取值范围:

1-100

默认取值:

100

表24 LayerSizeConfig

参数

参数类型

描述

width

Integer

参数解释

图层图片宽度像素值(相对画布大小)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。

取值范围:

1-7680

height

Integer

参数解释

图层图片高度像素值(相对画布大小)。

横屏(16:9)画布像素为1920x1080;竖屏(9:16)画布像素为1080x1920。

约束限制

该值为相对于画布的像素值,仅表示布局位置关系,与输出画面分辨率无关。|

取值范围:

1-7680

表25 SmartImageLayerConfig

参数

参数类型

描述

image_url

String

图片文件的URL。

display_duration

Integer

参数解释

图片显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致。若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表26 SmartVideoLayerConfig

参数

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

display_duration

Integer

参数解释

图片显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致。若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表27 SmartTextLayerConfig

参数

参数类型

描述

text_type

String

参数解释

文本类型。

  • DYNAMIC:动态文本,需要进行关键字替换。

  • STATIC:静态文本。

默认取值:

DYNAMIC

text_context

String

文本。

font_name

String

参数解释

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

  • fzyouh:方正瘦体

默认取值:

HarmonyOS_Sans_SC_Black

font_size

Integer

参数解释

字体大小(像素)。

业务取值范围:[4, 120],请以业务取值范围为准。

取值范围:

0-120

默认取值:

16

font_color

String

参数解释

字体颜色。RGB颜色值。

默认取值:

#FFFFFF

display_duration

Integer

参数解释

文本显示时长,单位s。

显示时长规则为,若携带reply_texts、reply_audios,则与播放语音内容时长保持一致;若未携带,则与匹配的关键词语音内容时长保持一致。

取值范围:

0-3600

默认取值:

0

表28 ReplyAudioInfo

参数

参数类型

描述

audio_url

String

音频URL

audio_name

String

音频名

表29 ReviewConfig

参数

参数类型

描述

no_need_review

Boolean

免审核。 目前仅白名单用户可使用此参数,非白名单用户跟随系统策略审核。

状态码:400

表30 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表31 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表32 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

PUT https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-interaction-rule-groups/26f06524-4f75-4b3a-a853-b649a21aaf66

{
  "group_name" : "欢迎词"
}

响应示例

状态码:200

成功。

{
  "group_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}

状态码:400

请求传参异常,包含错误码及对应描述。

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码:401

未鉴权或鉴权失败。

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

状态码:500

内部服务错误。

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class UpdateInteractionRuleGroupSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateInteractionRuleGroupRequest request = new UpdateInteractionRuleGroupRequest();
        request.withGroupId("{group_id}");
        InteractionRuleGroup body = new InteractionRuleGroup();
        body.withGroupName("欢迎词");
        request.withBody(body);
        try {
            UpdateInteractionRuleGroupResponse response = client.updateInteractionRuleGroup(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateInteractionRuleGroupRequest()
        request.group_id = "{group_id}"
        request.body = InteractionRuleGroup(
            group_name="欢迎词"
        )
        response = client.update_interaction_rule_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateInteractionRuleGroupRequest{}
	request.GroupId = "{group_id}"
	request.Body = &model.InteractionRuleGroup{
		GroupName: "欢迎词",
	}
	response, err := client.UpdateInteractionRuleGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion;
import com.huaweicloud.sdk.metastudio.v1.*;
import com.huaweicloud.sdk.metastudio.v1.model.*;


public class UpdateInteractionRuleGroupSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        MetaStudioClient client = MetaStudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateInteractionRuleGroupRequest request = new UpdateInteractionRuleGroupRequest();
        request.withGroupId("{group_id}");
        InteractionRuleGroup body = new InteractionRuleGroup();
        body.withGroupName("欢迎词");
        request.withBody(body);
        try {
            UpdateInteractionRuleGroupResponse response = client.updateInteractionRuleGroup(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkmetastudio.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = MetaStudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateInteractionRuleGroupRequest()
        request.group_id = "{group_id}"
        request.body = InteractionRuleGroup(
            group_name="欢迎词"
        )
        response = client.update_interaction_rule_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := metastudio.NewMetaStudioClient(
        metastudio.MetaStudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateInteractionRuleGroupRequest{}
	request.GroupId = "{group_id}"
	request.Body = &model.InteractionRuleGroup{
		GroupName: "欢迎词",
	}
	response, err := client.UpdateInteractionRuleGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功。

400

请求传参异常,包含错误码及对应描述。

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容