カスタム・プロンプトの管理

「例によるチューニング」機能は、米国英語のカスタム・モデルと音声でのみサポートされるベータ機能です。

例によるチューニングには、カスタム・モデルのすべてのカスタム・プロンプトをリストするメソッド、個々のプロンプトに関する情報を取得するメソッド、およびプロンプトを削除するメソッドが含まれています。これらのメソッドは、プロンプトをカスタム・モデルに追加するためのPOST /v1/customizations/{customization_id}/prompts/{prompt_id}メソッドに追加されます。詳しくは、カスタム・プロンプトの追加を参照してください。

カスタム・プロンプトのリスト

例によるチューニングは、指定したカスタム・モデルのカスタム・プロンプトに関する情報をリストするための 2 つのメソッドを提供します。

GET /v1/customizations/{customization_id}/promptsメソッドは、カスタム・モデルに定義されているすべてのカスタム・プロンプトに関する情報をリストします。
GET /v1/customizations/{customization_id}/prompts/{prompt_id}メソッドは、カスタム・モデルからの特定のカスタム・プロンプトに関する情報をリストします。このメソッドを使用して、カスタム・モデルにプロンプトを追加する要求の状況についてサービスをポーリングします。

最初のメソッドは、カスタム・モデルのすべてのプロンプトをリストするprompts配列を返します。配列にリストされているプロンプトごとに、サービスは個々のプロンプトの場合と同じ情報を提供します。

promptは、プロンプトの作成時に指定されたプロンプトのユーザー指定テキストです。
prompt_idは、プロンプトの作成時に指定されたプロンプトのユーザー指定 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"

モデルには 3 つのカスタム・プロンプトが含まれています。最初の 2 つのプロンプトは同じスピーカーに関連付けられています。最初のプロンプトはavailableであり、使用する準備ができています。サービスはprocessing 2 番目のプロンプトのままです。 3 番目のプロンプト (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}"