更新时间:2024-05-11 GMT+08:00
分享

创建智能直播间互动规则库

功能介绍

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

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/smart-live-interaction-rule-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

[项目ID,获取方法请参考获取项目ID。](tag:hc,hk)

请求参数

表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

规则索引

rule_name

String

规则名称

enabled

Boolean

是否启用

event_type

Integer

事件类型。 * 1:弹幕事件 * 2:用户入场事件 * 3:用户点赞事件 * 4:用户送礼事件 * 10: 预置话术事件

hit_condition

HitCondition object

命中条件

trigger

TriggerProcess object

触发器

review_config

ReviewConfig object

内容审核配置

表5 HitCondition

参数

是否必选

参数类型

描述

relation

String

条件关系;取值And或者Or

priority

Integer

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

tags

Array of HitConditionTag objects

匹配关系配置

表6 HitConditionTag

参数

是否必选

参数类型

描述

tag

String

事件内容关键字段

operation

String

字段处理

  • SUM: 累计

  • AVG:平均

  • COUNT: 计数

  • NONE: 无处理

match

String

匹配类型

  • EQUAL: 完全相等

  • REGEX:正则匹配

  • MATH_GT:数值大于

  • MATH_GE: 数值大于等于

  • MATH_LT:数值小于

  • MATH_LE:数值小于等于

  • MATH_EQ:数值相等

value

String

匹配值

表7 TriggerProcess

参数

是否必选

参数类型

描述

time_window

Integer

处理抑制时长。单位秒。 -1 表示整场直播 0 表示无抑制,每次都触发

reply_mode

String

回复类型。

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

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

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

layer_config

SmartLayerConfig object

智能图层配置。

extra_layer_config

SmartLayerConfig object

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

reply_texts

Array of strings

回复话术集

reply_audios

Array of ReplyAudioInfo objects

回复音频集。填写audio_url。

reply_order

String

回复次序

  • RANDOM:随机

  • ORDER:顺序循环

reply_role

String

回复角色。默认为主播

  • STREAMER:主播

  • CO_STREAMER:助播

表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。

dy

Integer

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

说明:

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

layer_index

Integer

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

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

表10 LayerSizeConfig

参数

是否必选

参数类型

描述

width

Integer

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

说明:

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

height

Integer

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

说明:

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

表11 SmartImageLayerConfig

参数

是否必选

参数类型

描述

image_url

String

图片文件的URL。

display_duration

Integer

图片显示时长。单位s

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

表12 SmartVideoLayerConfig

参数

是否必选

参数类型

描述

video_url

String

视频文件的URL。

video_cover_url

String

视频封面文件的URL。

display_duration

Integer

视频显示时长。单位s

  • 0 显示时长规则:若携带reply_texts,reply_audios,与播放语音内容时长保持一致; 未携带场景,与匹配的关键词语音内容时长保持一致

表13 SmartTextLayerConfig

参数

是否必选

参数类型

描述

text_type

String

文本类型。

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

  • STATIC: 静态文本。

text_context

String

文本。

font_name

String

字体。当前支持的字体:

  • HarmonyOS_Sans_SC_Black:鸿蒙粗体

  • HarmonyOS_Sans_SC_Regular:鸿蒙常规

  • HarmonyOS_Sans_SC_Thin:鸿蒙细体

  • fzyouh:方正瘦体

font_size

Integer

字体大小(像素)。

取值范围:[4, 120]

font_color

String

字体颜色。RGB颜色值。

display_duration

Integer

文本显示时长。单位s

  • 0 显示时长规则:若携带reply_texts,reply_audios,与播放语音内容时长保持一致; 未携带场景,与匹配的关键词语音内容时长保持一致

表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

状态码: 400

表18 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-live-interaction-rule-groups

{
  "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
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 CreateInteractionRuleGroupSolution {

    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();
        CreateInteractionRuleGroupRequest request = new CreateInteractionRuleGroupRequest();
        InteractionRuleGroup body = new InteractionRuleGroup();
        body.withGroupName("欢迎词");
        request.withBody(body);
        try {
            CreateInteractionRuleGroupResponse response = client.createInteractionRuleGroup(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = CreateInteractionRuleGroupRequest()
        request.body = InteractionRuleGroup(
            group_name="欢迎词"
        )
        response = client.create_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
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.CreateInteractionRuleGroupRequest{}
	request.Body = &model.InteractionRuleGroup{
		GroupName: "欢迎词",
	}
	response, err := client.CreateInteractionRuleGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功。

400

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

401

未鉴权或鉴权失败。

500

内部服务错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品