更新时间:2025-11-10 GMT+08:00
分享

修改指令 - UpdateInstruction

功能介绍

该接口用于修改指令。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

PUT /v1/{project_id}/wise-brain-manager/instruction/{instruction_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instruction_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方式认证时必选,请求的发生时间。

X-Project-Id

String

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

X-App-UserId

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

指令名称。

description

String

指令描述。

instruction

String

操作指令。

slot_list

Array of InstructionSlotInfo objects

槽位列表

reply_words_list

Array of InstructionReplyWordsInfo objects

指令回复话术列表

表4 InstructionSlotInfo

参数

是否必选

参数类型

描述

name

String

槽位名称。

description

String

槽位描述。

knowledge_library_list

Array of SlotKnowledgeLibraryInfo objects

知识库列表

表5 SlotKnowledgeLibraryInfo

参数

是否必选

参数类型

描述

language

String

智能交互语言

  • CN:中文

  • EN:英文

knowledge_library_id

String

知识库ID。

表6 InstructionReplyWordsInfo

参数

是否必选

参数类型

描述

language

String

智能交互语言

  • CN:中文

  • EN:英文

reply_words

String

回复话术,多个回复话术间用换行符\n分隔。

响应参数

状态码:200

表7 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

PUT https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/wise-brain-manager/instruction/ea2934bd5354442d80b4df11a52bbfe9

{
  "name" : "看电视",
  "description" : "IPTV指令,用于播放电视对应频道的节目",
  "instruction" : "{\"type\":20,\"instruct\":\"CHANNEL\",\"channelName\":\"{channelName}\"}",
  "slot_list" : [ {
    "name" : "channelName",
    "description" : "频道名称",
    "knowledge_library_list" : [ {
      "language" : "CN",
      "knowledge_library_id" : "8a2de18a95ac6b280195ac6b84ad0000"
    } ]
  } ],
  "reply_words_list" : [ {
    "language" : "CN",
    "reply_words" : "已为您打开。\\n已操作完成。"
  } ]
}

响应示例

状态码: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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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.*;

import java.util.List;
import java.util.ArrayList;

public class UpdateInstructionSolution {

    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();
        UpdateInstructionRequest request = new UpdateInstructionRequest();
        request.withInstructionId("{instruction_id}");
        UpdateInstructionReq body = new UpdateInstructionReq();
        List<InstructionReplyWordsInfo> listbodyReplyWordsList = new ArrayList<>();
        listbodyReplyWordsList.add(
            new InstructionReplyWordsInfo()
                .withLanguage(InstructionReplyWordsInfo.LanguageEnum.fromValue("CN"))
                .withReplyWords("已为您打开。\n已操作完成。")
        );
        List<SlotKnowledgeLibraryInfo> listSlotListKnowledgeLibraryList = new ArrayList<>();
        listSlotListKnowledgeLibraryList.add(
            new SlotKnowledgeLibraryInfo()
                .withLanguage(SlotKnowledgeLibraryInfo.LanguageEnum.fromValue("CN"))
                .withKnowledgeLibraryId("8a2de18a95ac6b280195ac6b84ad0000")
        );
        List<InstructionSlotInfo> listbodySlotList = new ArrayList<>();
        listbodySlotList.add(
            new InstructionSlotInfo()
                .withName("channelName")
                .withDescription("频道名称")
                .withKnowledgeLibraryList(listSlotListKnowledgeLibraryList)
        );
        body.withReplyWordsList(listbodyReplyWordsList);
        body.withSlotList(listbodySlotList);
        body.withInstruction("{"type":20,"instruct":"CHANNEL","channelName":"{channelName}"}");
        body.withDescription("IPTV指令,用于播放电视对应频道的节目");
        body.withName("看电视");
        request.withBody(body);
        try {
            UpdateInstructionResponse response = client.updateInstruction(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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# 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 = UpdateInstructionRequest()
        request.instruction_id = "{instruction_id}"
        listReplyWordsListbody = [
            InstructionReplyWordsInfo(
                language="CN",
                reply_words="已为您打开。\n已操作完成。"
            )
        ]
        listKnowledgeLibraryListSlotList = [
            SlotKnowledgeLibraryInfo(
                language="CN",
                knowledge_library_id="8a2de18a95ac6b280195ac6b84ad0000"
            )
        ]
        listSlotListbody = [
            InstructionSlotInfo(
                name="channelName",
                description="频道名称",
                knowledge_library_list=listKnowledgeLibraryListSlotList
            )
        ]
        request.body = UpdateInstructionReq(
            reply_words_list=listReplyWordsListbody,
            slot_list=listSlotListbody,
            instruction="{"type":20,"instruct":"CHANNEL","channelName":"{channelName}"}",
            description="IPTV指令,用于播放电视对应频道的节目",
            name="看电视"
        )
        response = client.update_instruction(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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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.UpdateInstructionRequest{}
	request.InstructionId = "{instruction_id}"
	languageReplyWordsList:= model.GetInstructionReplyWordsInfoLanguageEnum().CN
	var listReplyWordsListbody = []model.InstructionReplyWordsInfo{
        {
            Language: &languageReplyWordsList,
            ReplyWords: "已为您打开。\n已操作完成。",
        },
    }
	languageKnowledgeLibraryList:= model.GetSlotKnowledgeLibraryInfoLanguageEnum().CN
	var listKnowledgeLibraryListSlotList = []model.SlotKnowledgeLibraryInfo{
        {
            Language: &languageKnowledgeLibraryList,
            KnowledgeLibraryId: "8a2de18a95ac6b280195ac6b84ad0000",
        },
    }
	descriptionSlotList:= "频道名称"
	var listSlotListbody = []model.InstructionSlotInfo{
        {
            Name: "channelName",
            Description: &descriptionSlotList,
            KnowledgeLibraryList: &listKnowledgeLibraryListSlotList,
        },
    }
	instructionUpdateInstructionReq:= "{"type":20,"instruct":"CHANNEL","channelName":"{channelName}"}"
	descriptionUpdateInstructionReq:= "IPTV指令,用于播放电视对应频道的节目"
	nameUpdateInstructionReq:= "看电视"
	request.Body = &model.UpdateInstructionReq{
		ReplyWordsList: &listReplyWordsListbody,
		SlotList: &listSlotListbody,
		Instruction: &instructionUpdateInstructionReq,
		Description: &descriptionUpdateInstructionReq,
		Name: &nameUpdateInstructionReq,
	}
	response, err := client.UpdateInstruction(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码

相关文档