GetHotwordLibrary - 查询热词词库

查询热词词库。

接口说明

请求说明

通过提供词库 ID,可以获取到该词库的详细信息,包括但不限于词库名称、描述以及包含的所有热词及其属性。此接口主要用于管理和查看已创建的热词库的具体内容。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:GetHotwordLibraryget
*全部资源
*

请求参数

名称类型必填描述示例值
HotwordLibraryIdstring

热词库 Id

****96e8864746a0b6f3****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

****12e8864746a0a398****
HotwordLibraryIdstring

热词库 Id

****05512043f49f697f7425****
Namestring

热词库名称

热词库名称
Descriptionstring

热词库描述

热词库描述
Hotwordsarray

热词列表

热词列表Hotword

热词数据

UsageScenariostring

热词库使用场景

ASR
CreationTimestring

热词库创建时间

2020-12-23T13:33:49Z

示例

正常返回示例

JSON格式

{
  "RequestId": "****12e8864746a0a398****",
  "HotwordLibraryId": "****05512043f49f697f7425****",
  "Name": "热词库名称",
  "Description": "热词库描述",
  "Hotwords": [
    {
      "TranspositionResultList": [
        {
          "TranslatedText": "你好",
          "TargetLanguage": "zh"
        }
      ],
      "Language": "en",
      "Text": "hello",
      "Weight": 2
    }
  ],
  "UsageScenario": "ASR",
  "CreationTime": "2020-12-23T13:33:49Z"
}

错误码

访问错误中心查看更多错误码。