カスタム言語モデルの作成

文法を音声認識で使用するには、その文法をカスタム言語モデルに追加する必要があります。 既存のカスタム言語モデルを使用することも、POST /v1/customizations メソッドを使用して新しいカスタム・モデルを作成することもできます。 新しいカスタム・モデルの作成については、カスタム言語モデルの作成を参照してください。

カスタム言語モデルには、コーパス、カスタム単語、および文法を含めることができます。 音声認識時に、そのカスタム・モデルを文法とともに使用することも、文法なしで使用することもできます。 ただし、文法を使用する際は、指定された文法内の単語のみがサービスで認識されます。

カスタム言語モデルへの文法の追加

POST /v1/customizations/{customization_id}/grammars/{grammar_name} メソッドを使用して、文法ファイルをカスタム・モデルに追加します。

customization_id (必須ストリング)

カスタムモデルのカスタマイズIDを指定します。

grammar_name (必須ストリング)

文法の名前を指定します。 カスタム・モデルと同じ言語で表現した名前を使用して、この名前にはその文法の内容を反映させてください。

• 名前の最大文字数は 128 文字です。
• URL エンコードする必要のある文字は使用しないでください。 例えば、スペース、スラッシュ、円記号、コロン、アンパーサンド、二重引用符、正符号、等号、疑問符などは、名前に使用しないでください。 (これらの文字の使用がサービスによって禁止されているわけではありません。 ただし、これらの文字を使用するときには常に URL エンコードする必要があるため、使用は推奨されません。)
• カスタム・モデルに既に追加されている文法やコーパスの名前を使用しないでください。
• 名前 user を使用しないでください。これは、ユーザーによって追加または変更されるカスタム単語を表すためにサービスによって予約されています。
• base_lm および default_lm という名前は使用しないでください。 いずれの名前も、サービスで将来使用するために予約されています。

Content-Type (必須ストリング)

リクエストヘッダーを使用して、文法のフォーマットを指定します

• ABNF 文法の場合は application/srgs
• XML 文法の場合は application/srgs+xml

文法テキストファイルをリクエストの本文として送信してください。 次の例では、confirm.abnf という名前の文法ファイルを指定された ID を持つカスタム・モデルに追加します。 この例では、文法に confirm-abnf という名前を付けています。

IBM Cloud

curl -X POST -u "apikey:{apikey}" \
--header "Content-Type: application/srgs" \
--data-binary @confirm.abnf \
"{url}/v1/customizations/{customization_id}/grammars/confirm-abnf"

IBM Cloud Pak for Data IBM Software Hub

curl -X POST \
--header "Authorization: Bearer {token}" \
--header "Content-Type: application/srgs" \
--data-binary @confirm.abnf \
"{url}/v1/customizations/{customization_id}/grammars/confirm-abnf"

このメソッドは、同じ名前の既存の文法を上書きするために指定できるオプションの allow_overwrite クエリー・パラメーターも受け付けます。 文法をモデルに追加した後にその文法を更新する必要がある場合は、このパラメーターを使用してください。

このメソッドは非同期です。 文法のサイズとサービスに現在かかっている負荷によっては、サービスで文法を分析するのに数秒から数分かかることがあります。 文法のステータスの確認については、文法追加要求のモニターを参照してください。

このメソッドを文法ファイルごとに 1 回呼び出すことで、任意の数の文法を同一カスタム・モデルに追加できます。 文法の追加が完全に完了してから、次の文法を追加する必要があります。

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

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

{
  "name": "confirm-abnf",
  "out_of_vocabulary_words": 0,
  "status": "being_processed"
}

{
  . . .
  "error": "{\"code\":500, \"code_description\":\"Internal Server Error\",
\". . . Cannot compile grammar . . .\"},
  . . .
}

文法内の単語の検証

文法ファイルをカスタム言語モデルに追加すると、サービスによってその文法が解析されて、サービスの基本語彙にまだ含まれていない単語がその文法で認識されるかどうかが確認されます。 このような単語は、未知 (OOV) 語と呼ばれます。 OOV 語はそのカスタム・モデルの単語リソースに追加されます。 単語リソースの目的は、サービスの語彙にまだ含まれていない単語を定義することです。

単語リソース内の定義を通じて、OOV 語の書き起こし方法がサービスに通知されます。 この定義情報に含まれるのは、その単語の発音方法をサービスに通知する sounds_like フィールド、その単語の表示方法をサービスに通知する display_as フィールド、その単語がどのようにカスタム・モデルに追加されたのかを示す source フィールドです。 単語リソースと OOV 語について詳しくは、 単語リソースを参照してください。

文法をカスタム・モデルに追加した後に、そのモデルの単語リソースに含まれている OOV 語を調べて、それらの語の同音異字発音を確認することをお勧めします。 すべての文法に OOV 語が存在するわけではありませんが、通常は単語リソースを確認することが望ましいです。 文法を追加した後にカスタム・モデルの単語を確認するには、次のメソッドを使用します。

• GET /v1/customizations/{customization_id}/words メソッドを使用して、カスタム・モデル内のすべての単語をリストします。 このメソッドの grammars パラメーターで word_type という値を指定することで、文法から追加された単語のみをリストします。
• GET /v1/customizations/{customization_id}/words/{word_name} メソッドを使用して、モデル内の個別の単語を表示します。

単語の同音異字発音が正確で正しいことを確認してください。 また、これらの単語自体に誤字などの誤りがないかどうかも調べてください。 カスタム・モデル内の単語の検証と修正について詳しくは、前世代モデルの単語リソースの検証を参照してください。

カスタム言語モデルのトレーニング

カスタム言語モデルで文法を使用可能にするための最後のステップは、そのモデルをトレーニングすることです。 このプロセスは、新しいコーパスや新しいカスタム単語に基づいてカスタム・モデルをトレーニングするプロセスと同じです。 モデルをトレーニングすると、文法がコンパイルされて音声認識時に使用できるようになります。 サービスによって、文法が元のテキスト・ベース・フォーマットから音声認識用のバイナリー・ランタイム・フォーマットに処理されます。 モデルをトレーニングするまで、文法を使用することはできません。

カスタム・モデルをトレーニングするには、POST /v1/customizations/{customization_id}/train メソッドを使用します。 以下の例に示すように、トレーニングするモデルのカスタマイズ ID をこのメソッドに渡します。

IBM Cloud

curl -X POST -u "apikey:{apikey}" \
"{url}/v1/customizations/{customization_id}/train"

IBM Cloud Pak for Data IBM Software Hub

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

トレーニング・メソッドは非同期です。 トレーニングが完了するのに、通常は数秒または数分しかかかりません。 ただし、文法の複雑さとサービスに対する現在の負荷によっては、これより長い時間がかかることがあります。 トレーニング操作のステータスの確認については、トレーニング要求のモニターを参照してください。

{
  "customization_id": "74f4807e-b5ff-4866-824e-6bba1a84fe96",
  "created": "2018-06-01T18:42:25.324Z",
  "language": "en-US",
  "dialect": "en-US",
  "owner": "297cfd08-330a-22ba-93ce-1a73f454dd98",
  "name": "Example model",
  "description": "Example custom language model",
  "base_model_name": "en-US_BroadbandModel",
  "status": "training",
  "progress": 0
}