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

创建热词记录

功能介绍

该接口用于创建热词记录。

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/digital-human-chat/hot-words

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

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

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

Authorization

String

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

X-Sdk-Date

String

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

X-Project-Id

String

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

X-App-UserId

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

hot_words_type

String

热词类型。

说明:

SIS:使用的语音识别服务为SIS时选此类型

robot_id

String

应用ID。

sis_hot_words

CreateSisHotWords object

sis类型热词

表4 CreateSisHotWords

参数

是否必选

参数类型

描述

vocabulary_id

String

热词ID。

sis_project_id

String

SIS服务所在区域projectId

region

Integer

对接SIS服务的区域。

说明:

0:北京四;3:上海一;

取值范围:

0-32

language

String

智能交互语言

  • zh_CN:简体中文(已下线,请使用CN)

  • en_US:英语(已下线,请使用EN)

  • CN:中文

  • EN:英文

响应参数

状态码: 200

表5 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表6 响应Body参数

参数

参数类型

描述

hot_words_id

String

热词记录ID。

robot_id

String

应用ID。

hot_words_type

String

热词类型。

说明:

SIS:使用的语音识别服务为SIS时选此类型

vocabulary_id

String

热词ID(sis中配置)。

sis_project_id

String

SIS服务所在区域projectId

region

Integer

对接SIS服务的区域。

说明:

0:北京四;3:上海一;

取值范围:

0-32

language

String

智能交互语言

  • zh_CN:简体中文(已下线,请使用CN)

  • en_US:英语(已下线,请使用EN)

  • CN:中文

  • EN:英文

create_time

String

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

update_time

String

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

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/hot-words

{
  "hot_words_type" : "SIS",
  "robot_id" : "b3e2b1db10b34f45bff241b133142627",
  "sis_hot_words" : {
    "vocabulary_id" : "036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
    "sis_project_id" : "3c4a6bad10334e64823520d734d8f678",
    "region" : 0,
    "language" : "CN"
  }
}

响应示例

状态码: 200

处理成功返回。

{
  "hot_words_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9",
  "robot_id" : "b3e2b1db10b34f45bff241b133142627",
  "hot_words_type" : "SIS",
  "vocabulary_id" : "036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
  "sis_project_id" : "3c4a6bad10334e64823520d734d8f678",
  "region" : 0,
  "language" : "CN",
  "create_time" : "2021-01-10T08:43:17Z",
  "update_time" : "2021-01-10T08:43:17Z"
}

状态码: 400

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

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
52
53
54
55
56
57
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 CreateHotWordsSolution {

    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();
        CreateHotWordsRequest request = new CreateHotWordsRequest();
        CreateHotWordsReq body = new CreateHotWordsReq();
        CreateSisHotWords sisHotWordsbody = new CreateSisHotWords();
        sisHotWordsbody.withVocabularyId("036bd500-27cd-4e2d-bba9-0e6baf9c1bd8")
            .withSisProjectId("3c4a6bad10334e64823520d734d8f678")
            .withRegion(0)
            .withLanguage(CreateSisHotWords.LanguageEnum.fromValue("CN"));
        body.withSisHotWords(sisHotWordsbody);
        body.withRobotId("b3e2b1db10b34f45bff241b133142627");
        body.withHotWordsType(CreateHotWordsReq.HotWordsTypeEnum.fromValue("SIS"));
        request.withBody(body);
        try {
            CreateHotWordsResponse response = client.createHotWords(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
36
37
38
39
40
41
42
# 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 = CreateHotWordsRequest()
        sisHotWordsbody = CreateSisHotWords(
            vocabulary_id="036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
            sis_project_id="3c4a6bad10334e64823520d734d8f678",
            region=0,
            language="CN"
        )
        request.body = CreateHotWordsReq(
            sis_hot_words=sisHotWordsbody,
            robot_id="b3e2b1db10b34f45bff241b133142627",
            hot_words_type="SIS"
        )
        response = client.create_hot_words(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
42
43
44
45
46
47
48
49
50
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.CreateHotWordsRequest{}
	languageSisHotWords:= model.GetCreateSisHotWordsLanguageEnum().CN
	sisHotWordsbody := &model.CreateSisHotWords{
		VocabularyId: "036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
		SisProjectId: "3c4a6bad10334e64823520d734d8f678",
		Region: int32(0),
		Language: &languageSisHotWords,
	}
	hotWordsTypeHotWordsType:= model.GetHotWordsTypeEnumHotWordsTypeEnum().SIS
	request.Body = &model.CreateHotWordsReq{
		SisHotWords: sisHotWordsbody,
		RobotId: "b3e2b1db10b34f45bff241b133142627",
		HotWordsType: &hotWordsTypeHotWordsType,
	}
	response, err := client.CreateHotWords(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码

相关文档