管理自定义提示

“示范调音”功能是测试版功能，仅支持美式英语定制车型和语音。

Tune by Example包含列出自定义模型的所有自定义提示、获取单个提示的信息以及删除提示的方法。这些方法是对 POST /v1/customizations/{customization_id}/prompts/{prompt_id} 方法的补充，用于向自定义模型添加提示；更多信息，请参阅添加自定义提示。

列出自定义提示

Tune be Example 提供两种方法来列出指定定制车型的定制提示信息：

GET /v1/customizations/{customization_id}/prompts 方法列出了为自定义模型定义的所有自定义提示的信息。
GET /v1/customizations/{customization_id}/prompts/{prompt_id} 方法列出了自定义模型中特定自定义提示的相关信息。使用此方法轮询服务，了解向定制车型添加提示的请求状态。

第一种方法返回一个 prompts 数组，其中列出了定制车型的所有提示。对于数组中列出的每个提示，服务提供的信息与单个提示相同：

prompt 是创建提示时提供的用户自定义文本。
prompt_id 是用户在创建提示时指定的提示标识符。即时ID用于识别服务请求中的即时信息，包括语音合成请求的SSML。
status 是提示的当前状态：
- processing 表示服务已收到添加提示的请求，并正在处理该请求。这是所有提示的初始状态。
- available 表示服务已成功验证提示。该提示现在可用于语音合成请求。
- failed 表示服务对提示的验证失败。提示信息中包含一个 error 字段，用于描述故障原因。
speaker_id 是提示所关联的扬声器型号的GUID。如果提示音没有关联发言者ID，则该字段将被忽略。

当列出定制车型的所有提示时，如果车型不包含任何提示，则 prompts 数组为空。

列出所有自定义提示示例

以下示例列出了自定义模型中包含的所有自定义提示，该自定义模型具有指定的自定义ID：

IBM Cloud

curl -X GET -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}/prompts"

IBM Cloud Pak for Data IBM Software Hub

curl -X GET \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}/prompts"

该模型包含三个自定义提示。前两个提示与同一个发言者相关；第一个是 available，可以使用，第二个仍在 processing 中。第三个提示是 available，与另一个发言人有关。

{
  "prompts": [
    {
      "prompt": "Hello and welcome!",
      "prompt_id": "greeting",
      "status": "available",
      "speaker_id": "56367f89-546d-4b37-891e-4eb0c13cc833"
    },
    {
      "prompt": "How can I help you today?",
      "prompt_id": "help",
      "status": "processing",
      "speaker_id": "56367f89-546d-4b37-891e-4eb0c13cc833"
    },
    {
      "prompt": "I am sorry to hear that.",
      "prompt_id": "sorry",
      "status": "available",
      "speaker_id": "323e4476-63de-9825-7cd7-8120e45f8331"
    }
  ]
}

列出具体的自定义提示示例

以下示例仅返回上一列表中第一个自定义提示的信息：

IBM Cloud

curl -X GET -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}/prompts/greeting"

IBM Cloud Pak for Data IBM Software Hub

curl -X GET \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}/prompts/greeting"

该回复与上一个示例中的信息相同：

{
  "prompt": "Hello and welcome!",
  "prompt_id": "greeting",
  "status": "available",
  "speaker_id": "56367f89-546d-4b37-891e-4eb0c13cc833"
}

删除自定义提示

要从自定义模型中删除自定义提示，请使用 DELETE /v1/customizations/{customization_id}/prompts/{prompt_id} 方法。在语音合成请求中使用不存在的或已删除的自定义提示会导致服务返回400响应代码。确保在生产中不要尝试使用已删除的提示。

删除自定义提示示例

以下示例从指定了自定义ID的自定义模型中删除指定的自定义提示：

IBM Cloud

curl -X DELETE -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}/prompts/{prompt_id}"

IBM Cloud Pak for Data IBM Software Hub

curl -X DELETE \
--header "Authorization: Bearer {token}" \
"{url}/v1/customizations/{customization_id}/prompts/{prompt_id}"