プロビジョニング結果を確認する
ジョブ、生成されたセット、スキップされた処理、部分的な失敗を確認します。
作成時に返されたIDを使って、プロビジョニングジョブを取得します。
http
GET /v2/provisioning/jobs/:id
X-API-Key: YOUR_API_KEYジョブのフィールド #
| フィールド | 意味 |
|---|---|
id, organizationId, engineId | ジョブの識別情報と、ジョブが属する組織およびエンジン。 |
status | Running、Completed、Failedのいずれかのタグで示される状態。Failedにはmessageが含まれます。 |
kinds | 要求されたglossary、ruleset、brandVoiceの処理結果。要求されていない種類は含まれない場合があります。 |
sources | ソース読み取りの進捗またはレポート。省略される場合があります。 |
website | 最初に指定されたウェブサイトのURL。入力がテキストのみの場合は含まれません。 |
createdAt | ISO形式の作成日時。 |
finishedAt | ISO形式の完了日時。処理結果が確定すると含まれます。 |
種類ごとの状態 #
最上位のジョブがCompletedの場合も、要求したすべての種類の状態を確認してください。
kinds.<kind>._tag | フィールドと意味 |
|---|---|
Pending | 処理中です。省略可能なstepの値はreading、generating、savingのいずれかです。startedAtはそのステップの開始日時を示します。 |
Done | setIdは関連付けられたセットを、itemCountは生成された項目数を示します。 |
Skipped | reasonは、その種類が変更されなかった理由を示します。 |
Failed | messageは、その種類の内容を補完できなかった理由を示します。 |
たとえば、次の結果の抜粋には、生成された用語集と、生成に失敗したルールセットが含まれています。
json
{
"glossary": { "_tag": "Done", "setId": "YOUR_GLOSSARY_ID", "itemCount": 12 },
"ruleset": { "_tag": "Failed", "message": "Could not generate rules from the supplied material." }
}種類ごとに個別に保存されるため、ある種類の処理が失敗しても、正常に生成されたガイダンスは引き続き利用できます。また、生成中にエンジンにセットが関連付けられることもあり、その場合は、空の場合にのみ行う補完やブランドボイスの補完がスキップされることがあります。
生成されたレコードを確認する #
Studioでエンジンを開き、関連付けられた用語集、ルールセット、またはブランドボイスに移動します。APIで取得する場合は、次を使用します。
- 用語集の項目には
GET /v2/glossaries/:id/terms。 - ルールには
GET /v2/rulesets/:id/rules。 - ボイスのバリエーションには
GET /v2/brand-voices/:id/variations。
対応するsetIdを使い、各リストのページネーションに従って取得してください。用語、言語ごとの適用可否、翻訳しない名前、モデルが追加した前提を確認します。項目数は作成されたレコードの数であり、その正確さを示すものではありません。
処理に失敗した種類については、再試行と復旧を参照してください。別のエンジンを作成してすべての処理をやり直すのではなく、完了済みのセットを保持してください。