プロビジョニングジョブを作成する
新規または既存のエンジン用にガイダンスを生成し、進捗確認と復旧に備えてジョブ ID を保存します。
プロビジョニングは、API がリクエストを受け付けるとバックグラウンドで開始されます。すべてのルートで https://api.lingo.dev と API 認証を使用します。
エンジンを作成してガイダンスを追加する #
POST /v2/organizations/:orgId/provisioning/jobs
Content-Type: application/json
X-API-Key: YOUR_API_KEY{
"engine": { "name": "Acme support", "description": "Customer support content" },
"kinds": {
"glossary": { "name": "Product terminology" },
"ruleset": { "name": "Support writing rules" },
"brandVoice": { "name": "Support voice" }
},
"sources": [
{ "_tag": "Link", "url": "https://example.com/style-guide" },
{ "_tag": "Content", "text": "Use clear, direct sentences. Keep the product name Acme unchanged." }
]
}サンプルの URL を、ガイダンスを含むアクセス可能なページの URL に置き換えるか、代わりにテキストを指定してください。
| フィールド | 仕様 |
|---|---|
engine | エンジンの作成に必要なオブジェクトです。name は空にできません。description は任意です。モデル構成、カバレッジ、パイプライン設定も指定できます。 |
kinds | glossary、ruleset、brandVoice のうち少なくとも一つを選択する必須オブジェクトです。選択した各項目の値には {} または { "name": "Nonempty name" } を指定します。 |
sources | 空にできない必須の配列です。リンクまたはテキストソースを最大十件まで指定できます。 |
エンジン設定は、エンジン作成の仕様に従います。sourceCoverage と targetCoverage はロケールの配列で、[] はすべてのロケールを対象とします。modelConfigs を省略すると、プラットフォーム既定のモデル設定が初期値として適用されます。[] を指定すると、固定されたモデル構成がない状態になります。翻訳に使用する前に、エンジンのモデルを設定してください。
呼び出し元には、エンジンの作成権限と、リクエストしたガイダンスの作成権限が必要です。エンジン数、プランで利用できる機能、アカウントのクレジット残高、プロビジョニングのレート制限によって、リクエストが拒否される場合があります。
既存のエンジンにガイダンスを追加する #
POST /v2/engines/:engineId/provisioning/jobs
Content-Type: application/jsonエンジンにセットがまだ関連付けられていない種類だけを追加するには、次のようにします。
{
"kinds": { "_tag": "Empty" },
"sources": [{ "_tag": "Content", "text": "Keep Acme unchanged. Use concise, friendly language." }]
}特定の種類の新しいセットをリクエストするには、次のようにします。
{
"kinds": {
"_tag": "Requested",
"glossary": { "name": "Support terminology" },
"ruleset": {}
},
"sources": [{ "_tag": "Link", "url": "https://example.com/support" }]
}Requested では、既存の用語集やルールセットを残したまま、新しいものを追加できます。プロビジョニングで、関連付け済みのブランドボイスが置き換えられることはありません。Empty は、ジョブの実行中に関連付けられたセットも含め、セットがすでに関連付けられている種類をスキップします。リクエストのたびに三種類すべてが作成されるとは限らないため、種類ごとの結果をレビューしてください。
一つのエンジンで同時に実行できるプロビジョニングジョブは一つだけです。ProvisioningJobRunning(409)には既存の jobId が含まれます。追加の処理を送信する前に、そのジョブの状況を確認してください。NothingToProvision(409)は、エンジンの現在の状態では、リクエストしたどの処理でもガイダンスを追加できないことを意味します。
レスポンスを保存する #
どちらの作成ルートも、プロビジョニングジョブとともに HTTP 200 を返します。ポーリングを開始する前に id と engineId を保存してください。初期状態は通常 status: { "_tag": "Running" } です。
作成処理では、冪等性ヘッダーは定義されていません。レスポンスが失われた場合は、新規エンジンの作成リクエストを再送する前に、実行中のジョブとエンジン一覧を確認してください。再送すると、別のエンジンが作成される可能性があります。これらの確認手順と、失敗した種類の再試行については、復旧で説明しています。