クイックスタート: カスタム テキスト分類

この記事を使って、テキスト分類のカスタム モデルをトレーニングできるカスタム テキスト分類プロジェクトの作成を開始します。 モデルとは、特定のタスクを実行するためにトレーニングされる人工知能ソフトウェアです。 このシステムでは、モデルによってテキストが分類され、タグ付けされたデータから学習することでモデルがトレーニングされます。

カスタム テキスト分類では、次の 2 種類のプロジェクトがサポートされています。

  • 単一ラベル分類 - データセットの各ドキュメントに単一のクラスを割り当てることができます。 たとえば、1 本の映画の脚本を "ロマンス" と "コメディ" のどちらかに分類できます。
  • 複数ラベル分類 - データセットの各ドキュメントに複数のクラスを割り当てることができます。 たとえば、1 本の映画の脚本を "コメディ" か、"ロマンス" かつ "コメディ" に分類できます。

このクイックスタートでは、用意されているサンプル データセットを使用して、映画の脚本を 1 つまたは複数のカテゴリに分類できる複数ラベル分類を構築する、または、科学論文の要約を、定義されたドメインの 1 つに分類できる単一ラベル分類データセットを使用することができます。

前提条件

新しい Azure 言語リソースと Azure ストレージ アカウントを作成する

カスタム テキスト分類を使用する前に、Azure 言語リソースを作成する必要があります。これから、プロジェクトの作成とモデルのトレーニング開始に必要な認証情報が提供されます。 モデルの構築に使用するデータセットをアップロードできる Azure ストレージ アカウントも必要です。

重要

すぐに始めるには、この記事で示す手順を使用して新しい Azure 言語リソースを作成することをお勧めします。 この記事の手順を使用すると、言語リソースとストレージ アカウントを同時に作成することができ、後で行うより簡単です。

使用したい既存のリソースがある場合は、それをストレージ アカウントに接続する必要があります。

Azure portal から新しいリソースを作成します

  1. Azure portal に移動し、新しい Azure 言語リソースを作成します。

  2. 表示されるウィンドウで、カスタム機能から [カスタム テキスト分類とカスタム固有表現認識] を選択します。 画面の下部にある [リソースの作成を続行する] をクリックします。

    Azure portal でのカスタム テキスト分類とカスタム固有表現認識の選択オプションを示すスクリーンショット。

  3. 次の詳細を使用して言語リソースを作成します。

    名前 必須値
    サブスクリプション Azure サブスクリプション。
    リソース グループ リソースが格納されるリソース グループ。 既存のものを使用するか、新しく作成することができます。
    リージョン サポートされているリージョンのいずれか。 たとえば、"米国西部 2" です。
    名前 リソースの名前。
    Pricing tier サポートされている価格レベルのいずれか。 Free (F0) レベルを利用して、サービスを試用できます。

    "ログイン アカウントが選択したストレージ アカウントのリソース グループの所有者ではない" ことを通知するメッセージが表示された場合は、言語リソースを作成する前に、アカウントでそのリソース グループに所有者ロールを割り当てる必要があります。 Azure サブスクリプションの所有者に問い合わせてください。

    Azure サブスクリプションの所有者を確認するには、リソース グループを検索し、リンクに従ってそれに関連付けられているサブスクリプションに移動します。 その後、以下を実行します。

    1. [アクセス制御 (IAM)] タブを選びます
    2. [ロールの割り当て] を選びます
    3. Role:Owner でフィルター処理します。
  4. [カスタム テキスト分類とカスタム固有表現認識] セクションで、既存のストレージ アカウントを選択するか、[新しいストレージ アカウント] を選択します。 これらの値は使用を開始するためのものであり、必ずしもご自分の運用環境で使用するストレージ アカウントの値ではないことに注意してください。 プロジェクトのビルド中の待機時間を回避するには、言語リソースと同じリージョンのストレージ アカウントに接続します。

    ストレージ アカウントの値 推奨値
    ストレージ アカウント名 任意の名前
    ストレージ アカウントの種類 標準 LRS
  5. [責任ある AI の通知] がオンになっていることを確認します。 ページ下部にある [確認と作成] を選択します。

サンプル データを BLOB コンテナーにアップロードする

Azure storage アカウントを作成し、それを言語リソースに接続したら、サンプル データセットのドキュメントをコンテナーのルート ディレクトリにアップロードする必要があります。 これらのドキュメントは、後ほどモデルのトレーニングで使われます。

  1. 複数ラベル分類プロジェクトのサンプル データセットをダウンロードします

  2. .zip ファイルを開き、ドキュメントが格納されているフォルダーを展開します。

提供されるサンプル データセットには約 200 個のドキュメントが含まれており、それぞれが映画の要約です。 各ドキュメントは、次のクラスの 1 つ以上に属します:

  • "ミステリー"
  • "ドラマ"
  • "スリラー"
  • "コメディ"
  • "アクション"
  1. Azure portal で、作成したストレージ アカウントに移動して選択します。 これを行うには、[ストレージ アカウント] をクリックし、[任意のフィールドのフィルター] にストレージ アカウント名を入力します。

    自分のリソース グループが表示されない場合は、[サブスクリプションが次に等しい] フィルターが [すべて] に設定されていることを確認します。

  2. ストレージ アカウントで、左側のメニューの [データ ストレージ] の下にある [コンテナー] を選択します。 表示された画面で、[+ コンテナー] を選択します。 コンテナーに example-data という名前を付け、既定のパブリック アクセス レベルをそのまま使用します。

    ストレージ アカウントのメイン ページを示すスクリーンショット。

  3. コンテナーが作成されたら、それを選択します。 次に、[アップロード] ボタンをクリックして、前の手順でダウンロードした .txt および .json ファイルを選択します。

    ストレージ アカウントにファイルをアップロードするためのボタンを示すスクリーンショット。

カスタム テキスト分類プロジェクトを作成する

リソースとストレージ コンテナーが構成されたら、新しいカスタム テキスト分類プロジェクトを作成します。 プロジェクトは、データに基づいてカスタム ML モデルを構築するための作業領域です。 ご自分のプロジェクトにアクセスできるのは、本人と、使用されている言語リソースへのアクセス権を持つ方のみです。

  1. Language Studio にサインインします。 サブスクリプションと言語リソースを選ぶためのウィンドウが表示されます。 言語リソースを選びます。

  2. Language Studio の [テキストの分類] セクションで、[カスタム テキストの分類] を選択します。

    Language Studio のランディング ページのカスタム テキスト分類の場所を示すスクリーンショット。

  3. プロジェクト ページの上部メニューから、 [Create new project](新しいプロジェクトの作成) を選択します。 プロジェクトを作成すると、データのラベル付け、モデルのトレーニング、評価、改善、デプロイを実行できます。

    プロジェクト作成ページのスクリーンショット。

  4. [新しいプロジェクトの作成] をクリックすると、ストレージ アカウントを接続するためのウィンドウが表示されます。 既にストレージ アカウントを接続している場合は、そのストレージ アカウントが表示されます。 まだ接続していない場合は、表示されるドロップダウンからご自分のストレージ アカウントを選択し、[ストレージ アカウントを接続する] をクリックします。これにより、ストレージ アカウントに必要なロールが設定されます。 ストレージ アカウントの所有者として割り当てられていない場合、この手順でエラーが返される可能性があります。

    注意

    • この手順は、使用する各言語リソースに対して 1 回のみ行う必要があります。
    • この処理は元に戻すことができません。ストレージ アカウントを言語リソースに接続すると、後で切断することはできません。
    • 言語リソースは 1 つのストレージ アカウントにのみ接続できます。

    カスタム分類プロジェクトのストレージ接続画面のスクリーンショット。

  5. プロジェクト タイプを選択します。 各ドキュメントが 1 つまたは複数のクラスに属することができる複数ラベル分類プロジェクト、または各ドキュメントが 1 つのクラスにのみ属することができる単一ラベル分類プロジェクトのいずれかを作成できます。 選択したタイプを後で変更することはできません。 プロジェクトの種類の詳細

    利用可能なカスタム分類プロジェクトの種類のスクリーンショット。

  6. 名前、説明、プロジェクト内のドキュメントの言語など、プロジェクトの情報を入力します。 サンプル データセットを使用する場合は、[英語] を選択します。 プロジェクトの名前は後で変更できません。 [次へ] をクリックします。

    ヒント

    データセットは、すべて同じ言語である必要はありません。 サポートされる言語がそれぞれ異なる複数のドキュメントを得ることができます。 データセットに異なる言語のドキュメントが含まれる場合や、実行時に異なる言語のテキストが必要になると考えられる場合は、プロジェクトの基本情報を入力するときに、[多言語データセットを有効にする] オプションを選択します。 このオプションは、後で [プロジェクトの設定] ページから有効にすることができます。

  7. データセットをアップロードしたコンテナーを選択します。

    注意

    データが既にラベル付けされている場合は、サポートされている形式に従っていることを確認し、[はい、ドキュメントは既にラベル付けされており、JSON ラベル ファイルを書式設定しています] をクリックし、下のドロップダウン メニューからラベル ファイルを選択します。

    データセットの例のいずれかを使っている場合は、含まれる webOfScience_labelsFile または movieLabels の json ファイルを使います。 続けて、 [次へ] をクリックします。

  8. 入力したデータを確認し、 [Create Project](プロジェクトの作成) を選びます。

モデルをトレーニングする

通常、プロジェクトを作成した後、先に進み、プロジェクトに接続されているコンテナーにあるドキュメントのラベル付けを開始します。 このクイックスタートでは、サンプルのラベル付けされたデータセットをインポートし、サンプルの JSON ラベル ファイルを使用してプロジェクトを初期化しました。

Language Studio 内からモデルのトレーニングを開始するには:

  1. 左側のメニューから [トレーニング ジョブ] を選択します。

  2. 上部のメニューから [Start a training job] (トレーニング ジョブの開始) を選択します。

  3. [新しいモデルのトレーニング] を選択し、テキスト ボックスにモデル名を入力します。 また、[既存のモデルを上書きする] オプションを選択し、ドロップダウン メニューから上書きするモデルを選択することにより、既存のモデルを上書きすることもできます。 トレーニング済みモデルを上書きすると、元に戻すことはできません。ただし、新しいモデルをデプロイするまで、デプロイされているモデルには影響しません。

    新しいトレーニング ジョブを作成する

  4. データの分割方法を選択します。 [トレーニング用データからテスト用セットを自動的に分割する] を選択できます。その場合、システムは、指定された割合に従って、ラベル付けされたデータをトレーニング用セットとテスト用セットに分割します。 または、[トレーニング用データとテスト用データの手動分割を使用] を選択することもできます。このオプションは、データのラベル付け中にドキュメントをテスト用セットに追加した場合にのみ有効になります。 データ分割の詳細については、モデルのトレーニング方法をご覧ください。

  5. [Train] (トレーニング) ボタンをクリックします。

  6. 一覧からトレーニング ジョブ ID をクリックすると、サイド ウィンドウが表示され、そのジョブの [トレーニングの進行状況][ジョブの状態]、その他の詳細を確認できます。

    注意

    • 正常に完了したトレーニング ジョブでのみ、モデルが生成されます。
    • モデルのトレーニングには、ラベル付けされたデータのサイズに基づいて、数分から数時間かかる場合があります。
    • 一度に実行できるトレーニング ジョブは 1 つだけです。 実行中のジョブが完了するまで、同じプロジェクト内で他のトレーニング ジョブを開始することはできません。

モデルをデプロイする

通常はモデルをトレーニングした後、その評価の詳細を確認し、必要に応じて改善を行います。 このクイックスタートでは、モデルをデプロイして Language Studio で試せるようにするところまで行いますが、予測 API を呼び出すこともできます。

Language Studio 内からモデルのデプロイを開始するには、次の手順を行います。

  1. 左側のメニューから [Deploying a model](モデルのデプロイ) を選びます。

  2. [Add deployment](デプロイの追加) をクリックして、新しいデプロイ ジョブを開始します。

    デプロイ ボタンを示すスクリーンショット

  3. [デプロイの新規作成] を選択して新しいデプロイを作成し、下のドロップダウンからトレーニング済みのモデルを割り当てます。 既存のデプロイを上書きすることもできます。そのためにはこのオプションを選択して、下のドロップダウンから割り当てるトレーニング済みモデルを選択します。

    注意

    既存のデプロイを上書きしても、Prediction API の呼び出しを変更する必要はありませんが、その結果は、新しく割り当てたモデルに基づくものになります。

    デプロイ画面を示すスクリーンショット

  4. [デプロイ] をクリックして、デプロイ ジョブを開始します。

  5. デプロイが成功すると、その横に有効期限が表示されます。 デプロイの有効期限とは、デプロイされたモデルを予測に使用できなくなるときであり、通常は、トレーニング構成の有効期限が切れる 12 か月後に発生します。

モデルのテスト

モデルがデプロイされたら、モデルの使用を開始して 予測 API を使ってテキストを分類できます。 このクイックスタートでは、Language Studio を使用して、カスタム テキスト分類タスクを送信し、結果を視覚化します。 先ほどダウンロードしたサンプル データセットに、この手順で使用できるテスト ドキュメントがいくつか用意されています。

デプロイされたモデルを Language Studio 内でテストするには、次のようにします。

  1. 画面左側のメニューから [Testing deployments](デプロイのテスト) を選択します。

  2. テストするデプロイを選択します。 テストできるのは、デプロイに割り当てられているモデルのみです。

  3. 多言語プロジェクトの場合は、言語ドロップダウンを使用してテストするテキストの言語を選択します。

  4. ドロップダウンからクエリ/テストするデプロイを選択します。

  5. 要求で送信するテキストを入力するか、使用する .txt ドキュメントをアップロードします。 データセットの例のいずれかを使っている場合は、含まれている .txt ファイルのいずれかを使用できます。

  6. 上部のメニューから [テストの実行] をクリックします。

  7. [Result](結果) タブで、テキストに対して予測されたクラスを確認できます。 [JSON] タブで JSON 応答を表示することもできます。次の例は、単一ラベル分類プロジェクトの場合です。 複数ラベル分類プロジェクトでは、結果に複数のクラスが返される可能性があります。

    単一ラベル分類プロジェクトのモデル テスト結果を示すスクリーンショット。

プロジェクトをクリーンアップする

プロジェクトが不要な場合は、Language Studio を使ってプロジェクトを削除できます。 上部の [カスタム テキスト分類] を選び、削除するプロジェクトを選びます。 上部のメニューから [削除] を選んで、プロジェクトを削除します。

前提条件

新しい Azure 言語リソースと Azure ストレージ アカウントを作成する

カスタム テキスト分類を使用する前に、Azure 言語リソースを作成する必要があります。これから、プロジェクトの作成とモデルのトレーニング開始に必要な認証情報が提供されます。 モデルの構築に使用されるデータセットをアップロードできる Azure ストレージ アカウントも必要です。

重要

すぐに始めるには、この記事に記載されている手順を使用して新しい Azure 言語リソースを作成することをお勧めします。言語リソースの作成と、ストレージ アカウントの作成、接続、またはその両方を同時に行うことができ、後で行うより簡単だからです。

使用したい既存のリソースがある場合は、それをストレージ アカウントに接続する必要があります。

Azure portal から新しいリソースを作成します

  1. Azure portal に移動し、新しい Azure 言語リソースを作成します。

  2. 表示されるウィンドウで、カスタム機能から [カスタム テキスト分類とカスタム固有表現認識] を選択します。 画面の下部にある [リソースの作成を続行する] をクリックします。

    Azure portal でのカスタム テキスト分類とカスタム固有表現認識の選択オプションを示すスクリーンショット。

  3. 次の詳細を使用して言語リソースを作成します。

    名前 必須値
    サブスクリプション Azure サブスクリプション。
    リソース グループ リソースが格納されるリソース グループ。 既存のものを使用するか、新しく作成することができます。
    リージョン サポートされているリージョンのいずれか。 たとえば、"米国西部 2" です。
    名前 リソースの名前。
    Pricing tier サポートされている価格レベルのいずれか。 Free (F0) レベルを利用して、サービスを試用できます。

    "ログイン アカウントが選択したストレージ アカウントのリソース グループの所有者ではない" ことを通知するメッセージが表示された場合は、言語リソースを作成する前に、アカウントでそのリソース グループに所有者ロールを割り当てる必要があります。 Azure サブスクリプションの所有者に問い合わせてください。

    Azure サブスクリプションの所有者を確認するには、リソース グループを検索し、リンクに従ってそれに関連付けられているサブスクリプションに移動します。 その後、以下を実行します。

    1. [アクセス制御 (IAM)] タブを選びます
    2. [ロールの割り当て] を選びます
    3. Role:Owner でフィルター処理します。
  4. [カスタム テキスト分類とカスタム固有表現認識] セクションで、既存のストレージ アカウントを選択するか、[新しいストレージ アカウント] を選択します。 これらの値は使用を開始するためのものであり、必ずしもご自分の運用環境で使用するストレージ アカウントの値ではないことに注意してください。 プロジェクトのビルド中の待機時間を回避するには、言語リソースと同じリージョンのストレージ アカウントに接続します。

    ストレージ アカウントの値 推奨値
    ストレージ アカウント名 任意の名前
    ストレージ アカウントの種類 標準 LRS
  5. [責任ある AI の通知] がオンになっていることを確認します。 ページ下部にある [確認と作成] を選択します。

サンプル データを BLOB コンテナーにアップロードする

Azure storage アカウントを作成し、それを言語リソースに接続したら、サンプル データセットのドキュメントをコンテナーのルート ディレクトリにアップロードする必要があります。 これらのドキュメントは、後ほどモデルのトレーニングで使われます。

  1. 複数ラベル分類プロジェクトのサンプル データセットをダウンロードします

  2. .zip ファイルを開き、ドキュメントが格納されているフォルダーを展開します。

提供されるサンプル データセットには約 200 個のドキュメントが含まれており、それぞれが映画の要約です。 各ドキュメントは、次のクラスの 1 つ以上に属します:

  • "ミステリー"
  • "ドラマ"
  • "スリラー"
  • "コメディ"
  • "アクション"
  1. Azure portal で、作成したストレージ アカウントに移動して選択します。 これを行うには、[ストレージ アカウント] をクリックし、[任意のフィールドのフィルター] にストレージ アカウント名を入力します。

    自分のリソース グループが表示されない場合は、[サブスクリプションが次に等しい] フィルターが [すべて] に設定されていることを確認します。

  2. ストレージ アカウントで、左側のメニューの [データ ストレージ] の下にある [コンテナー] を選択します。 表示された画面で、[+ コンテナー] を選択します。 コンテナーに example-data という名前を付け、既定のパブリック アクセス レベルをそのまま使用します。

    ストレージ アカウントのメイン ページを示すスクリーンショット。

  3. コンテナーが作成されたら、それを選択します。 次に、[アップロード] ボタンをクリックして、前の手順でダウンロードした .txt および .json ファイルを選択します。

    ストレージ アカウントにファイルをアップロードするためのボタンを示すスクリーンショット。

リソースのキーとエンドポイントを取得する

  • Azure portal でリソースの概要ページに移動します

  • 左側のメニューで [キーとエンドポイント] を選びます。 API 要求のエンドポイントとキーを使います

Azure portal のキーとエンドポイントのページを示すスクリーンショット

カスタム テキスト分類プロジェクトを作成する

リソースとストレージ コンテナーが構成されたら、新しいカスタム テキスト分類プロジェクトを作成します。 プロジェクトは、データに基づいてカスタム ML モデルを構築するための作業領域です。 ご自分のプロジェクトにアクセスできるのは、本人と、使用されている言語リソースへのアクセス権を持つ方のみです。

プロジェクト ジョブのインポートをトリガーする

ラベル ファイルをインポートするには、次の URL、ヘッダー、JSON 本文を使って POST 要求を送信します。 ラベル ファイルが、許容される形式に従っていることを確認してください。

同じ名前のプロジェクトが既に存在する場合は、そのプロジェクトのデータを置き換えます。

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

Body

要求では次の JSON を使います。 次のプレースホルダーの値を実際の値に置き換えてください。

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectName": "{PROJECT-NAME}",
    "storageInputContainerName": "{CONTAINER-NAME}",
    "projectKind": "customMultiLabelClassification",
    "description": "Trying out custom multi label text classification",
    "language": "{LANGUAGE-CODE}",
    "multilingual": true,
    "settings": {}
  },
  "assets": {
    "projectKind": "customMultiLabelClassification",
    "classes": [
      {
        "category": "Class1"
      },
      {
        "category": "Class2"
      }
    ],
    "documents": [
      {
        "location": "{DOCUMENT-NAME}",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "classes": [
          {
            "category": "Class1"
          },
          {
            "category": "Class2"
          }
        ]
      },
      {
        "location": "{DOCUMENT-NAME}",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "classes": [
          {
            "category": "Class2"
          }
        ]
      }
    ]
  }
}

Key プレースホルダー
api-version {API-VERSION} 呼び出している API のバージョン。 ここで使用するバージョンは、URL 内と同じ API バージョンである必要があります。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01
projectName {PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
projectKind customMultiLabelClassification プロジェクトの種類。 customMultiLabelClassification
language {LANGUAGE-CODE} プロジェクトで使用されるドキュメントの言語コードを指定する文字列。 プロジェクトが多言語プロジェクトの場合は、ほとんどのドキュメントの言語コードを選択します。 多言語サポートの詳細については、言語サポートをご覧ください。 en-us
複数言語 true データセットに複数の言語のドキュメントを含め、モデルをデプロイするときに、サポートされている任意の言語 (トレーニング ドキュメントに含まれているとは限りません) でモデルにクエリを実行できるブール値です。 多言語サポートの詳細については、言語サポートをご覧ください。 true
storageInputContainerName {CONTAINER-NAME} ドキュメントをアップロードした Azure ストレージ コンテナーの名前。 myContainer
クラス [] プロジェクト内のすべてのクラスを含む配列。 これらはドキュメントの分類先となるクラスです。 []
ドキュメント [] プロジェクト内のすべてのドキュメントと、このドキュメントにラベル付けされたクラスを含む配列。 []
location {DOCUMENT-NAME} ストレージ コンテナー内のドキュメントの場所。 すべてのドキュメントはコンテナーのルートに含まれているので、これはドキュメント名にする必要があります。 doc1.txt
dataset {DATASET} トレーニング前に分割する場合にこのドキュメントが移動するテスト セット。 データ分割の詳細については、モデルのトレーニング方法をご覧ください。 このフィールドで使用できる値は Train および Test です。 Train

API 要求を送信すると、ジョブが正しく送信されたことを示す 202 応答を受け取ります。 応答ヘッダーで、operation-location の値を抽出します。 それは次のように書式設定されています。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}

この操作は非同期であるため、{JOB-ID} を使って要求が識別されます。 この URL を使用してインポート ジョブの状態を取得します。

この要求で考えられるエラー シナリオ:

  • 選択されたリソースに、ストレージ アカウントに対する適切なアクセス許可がありません。
  • 指定された storageInputContainerName が存在しません。
  • 無効な言語コードが使用されているか、言語コードの種類が文字列でない場合。
  • multilingual 値は文字列であり、ブール値ではありません。

インポート ジョブの状態を取得する

次の GET 要求を使用して、プロジェクトのインポートの状態を取得します。 次のプレースホルダーの値を実際の値に置き換えてください。

要求 URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{JOB-ID} モデルのトレーニングの状態を取得するための ID。 この値は、前のステップで受け取った location ヘッダーの値に含まれています。 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

モデルをトレーニングする

通常、プロジェクトを作成した後、先に進み、プロジェクトに接続されているコンテナーにあるドキュメントのタグ付けを開始します。 このクイックスタートでは、サンプルのタグ付けされたデータセットをインポートし、サンプルの JSON タグ ファイルを使用してプロジェクトを初期化しました。

モデルのトレーニングを開始する

プロジェクトがインポートされたら、モデルのトレーニングを開始できます。

トレーニング ジョブを送信するには、次の URL、ヘッダー、JSON 本文を使用して POST 要求を送信します。 次のプレースホルダーの値を実際の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/:train?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

要求本文

要求本文では次の JSON を使います。 トレーニングが完了すると、モデルに {MODEL-NAME} が与えられます。 正常に完了したトレーニング ジョブでのみ、モデルが生成されます。

{
	"modelLabel": "{MODEL-NAME}",
	"trainingConfigVersion": "{CONFIG-VERSION}",
	"evaluationOptions": {
		"kind": "percentage",
		"trainingSplitPercentage": 80,
		"testingSplitPercentage": 20
	}
}
Key プレースホルダー
modelLabel {MODEL-NAME} トレーニングが正常に行われた後にモデルに割り当てられるモデル名。 myModel
trainingConfigVersion {CONFIG-VERSION} これは、モデルをトレーニングするために使用されるモデル バージョンです。 2022-05-01
evaluationOptions データをトレーニング用セットとテスト用セットに分割するオプション。 {}
kind percentage 分割方法。 指定できる値は percentage または manual です。 詳細については、モデルのトレーニング方法に関する記事をご覧ください。 percentage
trainingSplitPercentage 80 トレーニング セットに含まれるタグ付きデータの割合。 推奨値は 80 です。 80
testingSplitPercentage 20 テスト セットに含まれるタグ付きデータの割合。 推奨値は 20 です。 20

注意

trainingSplitPercentagetestingSplitPercentage は、Kindpercentage に設定されている場合にのみ必要であり、両方の割合の合計は 100 に等しくなる必要があります。

API 要求を送信すると、ジョブが正しく送信されたことを示す 202 応答を受け取ります。 応答ヘッダーで、location の値を抽出します。 それは次のように書式設定されています。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}

この操作は非同期であるため、要求を識別するために、{JOB ID} が使われます。 この URL を使用してトレーニングの状態を取得できます。

トレーニング ジョブの状態を取得する

トレーニングには 10 分から 30 分かかる場合があります。 次の要求を使用して、トレーニング ジョブが正常に完了するまで状態をポーリングし続けることができます。

モデルのトレーニングの進行状況を表す状態を取得するには、次の GET 要求を使用します。 次のプレースホルダーの値を実際の値に置き換えてください。

要求 URL

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{JOB-ID} モデルのトレーニングの状態を取得するための ID。 この値は、前のステップで受け取った location ヘッダーの値に含まれています。 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 使用可能な他の API バージョンの詳細については、「モデルのライフサイクル」を参照してください。 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

応答本文

要求を送信すると、次の応答を受け取ります。

{
  "result": {
    "modelLabel": "{MODEL-NAME}",
    "trainingConfigVersion": "{CONFIG-VERSION}",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "{JOB-ID}",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

モデルをデプロイする

通常はモデルをトレーニングした後で、評価の詳細を確認し、必要に応じて改善を行います。 このクイックスタートでは、モデルをデプロイして Language Studio で試せるようにするところまで行いますが、予測 API を呼び出すこともできます。

デプロイ ジョブを送信する

デプロイ ジョブを送信するには、次の URL、ヘッダー、JSON 本文を使って PUT 要求を送信します。 次のプレースホルダーの値を実際の値に置き換えてください。

{Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{DEPLOYMENT-NAME} デプロイの名前。 この値は、大文字と小文字が区別されます。 staging
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

要求本文

要求の本文で次の JSON を使います。 デプロイに割り当てるモデルの名前を使います。

{
  "trainedModelLabel": "{MODEL-NAME}"
}
Key プレースホルダー
trainedModelLabel {MODEL-NAME} デプロイに割り当てられるモデル名。 正常にトレーニングされたモデルのみ割り当てることができます。 この値は、大文字と小文字が区別されます。 myModel

API 要求を送信すると、ジョブが正しく送信されたことを示す 202 応答を受け取ります。 応答ヘッダーで、operation-location の値を抽出します。 それは次のように書式設定されています。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

この操作は非同期であるため、要求を識別するために、{JOB ID} が使われます。 この URL を使用してデプロイの状態を取得できます。

デプロイ ジョブの状態を取得する

デプロイ ジョブの状態を照会するには、次の GET 要求を使います。 前のステップで取得した URL を使うことも、下のプレースホルダーの値を実際の値に置き換えることもできます。

{ENDPOINT}/language/authoring/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{DEPLOYMENT-NAME} デプロイの名前。 この値は、大文字と小文字が区別されます。 staging
{JOB-ID} モデルのトレーニングの状態を取得するための ID。 これは、前のステップで受け取った location ヘッダーの値に含まれています。 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

応答本文

要求を送信すると、次の応答を受け取ります。 [status](状態) パラメーターが [succeeded](成功) に変更されるまで、このエンドポイントのポーリングを続けます。 要求の成功を示す 200 コードを取得します。

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

テキストを分類する

モデルが正常にデプロイされたら、モデルの使用を開始して 予測 API を使ってテキストを分類できます。 先ほどダウンロードしたサンプル データセットに、この手順で使用できるテスト ドキュメントがいくつか用意されています。

カスタム テキスト分類タスクを送信する

この POST 要求を使用して、テキスト分類タスクを開始します。

{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 使用可能な他の API バージョンの詳細については、モデルのライフサイクルに関するページを参照してください。 2022-05-01

ヘッダー

Key
Ocp-Apim-Subscription-Key この API へのアクセスを提供するキー。

Body

{
  "displayName": "Classifying documents",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
     {
      "kind": "CustomMultiLabelClassification",
      "taskName": "Multi Label Classification",
      "parameters": {
        "projectName": "{PROJECT-NAME}",
        "deploymentName": "{DEPLOYMENT-NAME}"
      }
    }
  ]
}
Key プレースホルダー
displayName {JOB-NAME} ジョブの名前。 MyJobName
documents [{},{}] タスクを実行するドキュメントのリスト。 [{},{}]
id {DOC-ID} ドキュメント名または ID。 doc1
language {LANGUAGE-CODE} ドキュメントの言語コードを指定する文字列。 このキーが指定されていない場合、サービスではプロジェクトの作成時に選択されたプロジェクトの既定の言語を想定します。 サポートされている言語コードの一覧については、言語のサポートに関するページを参照してください。 en-us
text {DOC-TEXT} タスクを実行するドキュメント タスク。 Lorem ipsum dolor sit amet
tasks 実行するタスクのリスト。 []
taskName CustomMultiLabelClassification タスク名 CustomMultiLabelClassification
parameters タスクに渡すパラメーターのリスト。
project-name {PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
deployment-name {DEPLOYMENT-NAME} デプロイの名前。 この値は、大文字と小文字が区別されます。 prod

Response

成功を示す 202 応答を受け取ります。 応答のヘッダーで、operation-location を抽出します。 operation-location は次のように書式設定されています。

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}

この URL を使用して、タスクの完了状態をクエリし、タスクが完了したときに結果を取得できます。

タスクの結果を取得する

テキスト分類タスクの状態と結果のクエリを実行するには、次の GET 要求を使います。

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリースされた最新のモデル バージョンです。 2022-05-01

ヘッダー

Key
Ocp-Apim-Subscription-Key この API へのアクセスを提供するキー。

応答本文

応答は、次のパラメーターを含む JSON ドキュメントです

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxxxx-xxxxx-xxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "customMultiClassificationTasks",
        "taskName": "Classify documents",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "{DOC-ID}",
              "classes": [
                  {
                      "category": "Class_1",
                      "confidenceScore": 0.0551877357
                  }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

リソースをクリーンアップする

プロジェクトが不要になったら、次の DELETE 要求で削除できます。 プレースホルダーの値は、実際の値に置き換えます。

{Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version={API-VERSION}
プレースホルダー
{ENDPOINT} API 要求を認証するためのエンドポイント。 https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} プロジェクトの名前。 この値は、大文字と小文字が区別されます。 myProject
{API-VERSION} 呼び出している API のバージョン。 ここで参照される値は、リリース済みの最新バージョン用です。 その他の利用可能な API バージョンの詳細を確認する 2022-05-01

ヘッダー

要求を認証するには、次のヘッダーを使います。

Key
Ocp-Apim-Subscription-Key リソースへのキー。 API 要求の認証に使われます。

API 要求を送信すると、成功を示す 202 応答を受け取ります。これは、プロジェクトが削除されたことを意味します。 呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。

次のステップ

カスタム テキスト分類モデルを作成した後は、次のことができます。

独自のカスタム テキスト分類プロジェクトの作成を開始するときは、ハウツー記事を使用して、モデルの開発の詳細について確認してください。