クイック スタート: 固有表現の検出 (NER)

リファレンス ドキュメント | その他のサンプル | パッケージ (NuGet) | ライブラリのソース コード

このクイック スタートを使用して、.NET 用クライアント ライブラリを使用して固有表現認識 (NER) アプリケーションを作成します。 次の例では、テキスト メッセージの認識されたエンティティを識別できる C# アプリケーションを作成します。

ヒント

Language Studio を使用すると、コードを記述することなく言語サービス機能を試すことができます。

前提条件

• Azure サブスクリプション - 無料アカウントを作成します
• Visual Studio IDE

設定

Azure リソースを作成する

以下のコード サンプルを使用するには、Azure リソースをデプロイする必要があります。 このリソースには、言語サービスに送信する API 呼び出しを認証するために使用するキーとエンドポイントが含まれます。

1. Azure portal を使用して言語リソースを作成するには、次のリンクを使用します。 Azure サブスクリプションを使用してサインインする必要があります。

2. 表示される [追加機能を選択する] スクリーンで、[続行] を選択 してリソースを作成します。

   

3. [言語の作成] スクリーンで、次の情報を入力します。

   詳細	説明
   サブスクリプション	リソースが関連付けられるサブスクリプション アカウント。 ドロップダウン メニューから Azure サブスクリプションを選択します。
   リソース グループ	リソース グループは、作成したリソースを保存するコンテナーです。 [新規作成] を選んで、新しいリソース グループを作成します。
   リージョン	言語リソースの場所。 別のリージョンを選択すると、物理的な場所によっては待機時間が生じる可能性がありますが、リソースのランタイムの可用性には影響しません。 このクイック スタートでは、近くの利用可能なリージョンを選択するか、米国東部を選択します。
   名前	言語リソースの名前。 この名前は、アプリケーションが API 要求の送信に使用するエンドポイント URL の作成にも使用されます。
   価格レベル	言語リソースの価格レベル。 Free F0 レベルを使用してサービスを試用し、後から運用環境用の有料レベルにアップグレードすることができます。

   

4. [責任ある AI の通知] チェックボックスがオンになっていることを確認します。

5. ページの下部にある [確認および作成] を選択します。

6. 表示されるスクリーンで、検証に合格し、情報を正しく入力したことを確認します。 [作成] を選択します。

キーとエンドポイントを取得する

次に、アプリケーションを API に接続するには、リソースのキーとエンドポイントが必要です。 このクイックスタートで後に示すコードに、自分のキーとエンドポイントを貼り付けます。

1. 言語リソースが正常にデプロイされたら、[次の手順] の [リソースに移動] ボタンをクリックします。

   

2. リソースのスクリーンで、左側のナビゲーション メニューの [キーとエンドポイント] を選択します。 以下の手順では、キーの 1 つとエンドポイントを使用します。

   

環境変数を作成する

API 要求を送信するには、アプリケーションを認証する必要があります。 運用環境では、資格情報を安全に保存してアクセスできる方法を使用してください。 この例では、アプリケーションを実行しているローカル コンピューター上の環境変数に資格情報を書き込みます。

ヒント

キーは、コードに直接含めないようにし、公開しないでください。 Azure Key Vault などのその他の認証オプションについては、Azure AI サービスのセキュリティに関する記事を参照してください。

言語リソース キーの環境変数を設定するには、コンソール ウィンドウを開き、オペレーティング システムと開発環境の指示に従います。

1. LANGUAGE_KEY 環境変数を設定するには、your-key をリソースのキーの 1 つに置き換えます。
2. LANGUAGE_ENDPOINT 環境変数を設定するには、your-endpoint をリソースのエンドポイントに置き換えます。

Windows

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Note

現在実行中のコンソールで環境変数のみにアクセスする必要がある場合は、環境変数を setx の代わりに set に設定できます。

実行中のプログラムのうち、環境変数の読み取りを必要とするプログラム (コンソール ウィンドウを含む) については、環境変数を追加した後で再起動が必要となる場合があります。 たとえば、Visual Studio をエディターとして使用している場合、サンプルを実行する前に Visual Studio を再起動します。

Linux

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bashrc を実行します。

macOS

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bash_profile を実行します。

Xcode

iOS と macOS の開発では、Xcode で環境変数を設定します。 たとえば、次の手順に従って、Xcode 13.4.1 で環境変数を設定します。

1. [Product]、[Scheme]、[スキームの編集] の順に選択する
2. [引数] を [実行] (デバッグ実行) ページで選択する
3. [環境変数] で、プラス記号 (+) を選択して、新しい環境変数を追加します。
4. [名前] に「LANGUAGE_KEY」と入力し、[値] に言語リソース キーを入力します。
5. リソース エンドポイントに対してこれらの手順を実行します。 新しい環境変数 LANGUAGE_ENDPOINT に名前を付けます。

その他の構成オプションについては、Xcode のドキュメントを参照してください。

新しい .NET Core アプリを作成する

Visual Studio IDE を使用して新しい .NET Core コンソール アプリを作成します。 1 つの C# ソース ファイル (program.cs) を含んだ "Hello World" プロジェクトを作成します。

ソリューション エクスプローラーでソリューションを右クリックし、 [NuGet パッケージの管理] を選択して、クライアント ライブラリをインストールします。 パッケージ マネージャーが開いたら、 [参照] を選択して Azure.AI.TextAnalytics を検索します。 バージョン 5.2.0 を選択し、 [インストール] を選択します。 パッケージ マネージャー コンソールを使用してもかまいません。

コードの例

次のコードを program.cs ファイルにコピーし、コードを実行します。

using Azure;
using System;
using Azure.AI.TextAnalytics;

namespace Example
{
    class Program
    {
        // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
        static string languageKey = Environment.GetEnvironmentVariable("LANGUAGE_KEY");
        static string languageEndpoint = Environment.GetEnvironmentVariable("LANGUAGE_ENDPOINT");

        private static readonly AzureKeyCredential credentials = new AzureKeyCredential(languageKey);
        private static readonly Uri endpoint = new Uri(languageEndpoint);
        
        // Example method for extracting named entities from text 
        static void EntityRecognitionExample(TextAnalyticsClient client)
        {
            var response = client.RecognizeEntities("I had a wonderful trip to Seattle last week.");
            Console.WriteLine("Named Entities:");
            foreach (var entity in response.Value)
            {
                Console.WriteLine($"\tText: {entity.Text},\tCategory: {entity.Category},\tSub-Category: {entity.SubCategory}");
                Console.WriteLine($"\t\tScore: {entity.ConfidenceScore:F2},\tLength: {entity.Length},\tOffset: {entity.Offset}\n");
            }
        }

        static void Main(string[] args)
        {
            var client = new TextAnalyticsClient(endpoint, credentials);
            EntityRecognitionExample(client);

            Console.Write("Press any key to exit.");
            Console.ReadKey();
        }

    }
}

出力

Named Entities:
        Text: trip,     Category: Event,        Sub-Category:
                Score: 0.74,    Length: 4,      Offset: 18

        Text: Seattle,  Category: Location,     Sub-Category: GPE
                Score: 1.00,    Length: 7,      Offset: 26

        Text: last week,        Category: DateTime,     Sub-Category: DateRange
                Score: 0.80,    Length: 9,      Offset: 34

リファレンス ドキュメント | その他のサンプル | パッケージ (Maven) | ライブラリのソース コード

このクイック スタートを使用して、Java 用クライアント ライブラリを使用して固有表現認識 (NER) アプリケーションを作成します。 次の例では、テキスト メッセージの認識されたエンティティを識別できる Javaアプリケーションを作成します。

前提条件

• Azure サブスクリプション - 無料アカウントを作成します
• Java Development Kit (JDK) バージョン 8 以降

設定

Azure リソースを作成する

以下のコード サンプルを使用するには、Azure リソースをデプロイする必要があります。 このリソースには、言語サービスに送信する API 呼び出しを認証するために使用するキーとエンドポイントが含まれます。

1. Azure portal を使用して言語リソースを作成するには、次のリンクを使用します。 Azure サブスクリプションを使用してサインインする必要があります。

2. 表示される [追加機能を選択する] スクリーンで、[続行] を選択 してリソースを作成します。

   

3. [言語の作成] スクリーンで、次の情報を入力します。

   詳細	説明
   サブスクリプション	リソースが関連付けられるサブスクリプション アカウント。 ドロップダウン メニューから Azure サブスクリプションを選択します。
   リソース グループ	リソース グループは、作成したリソースを保存するコンテナーです。 [新規作成] を選んで、新しいリソース グループを作成します。
   リージョン	言語リソースの場所。 別のリージョンを選択すると、物理的な場所によっては待機時間が生じる可能性がありますが、リソースのランタイムの可用性には影響しません。 このクイック スタートでは、近くの利用可能なリージョンを選択するか、米国東部を選択します。
   名前	言語リソースの名前。 この名前は、アプリケーションが API 要求の送信に使用するエンドポイント URL の作成にも使用されます。
   価格レベル	言語リソースの価格レベル。 Free F0 レベルを使用してサービスを試用し、後から運用環境用の有料レベルにアップグレードすることができます。

   

4. [責任ある AI の通知] チェックボックスがオンになっていることを確認します。

5. ページの下部にある [確認および作成] を選択します。

6. 表示されるスクリーンで、検証に合格し、情報を正しく入力したことを確認します。 [作成] を選択します。

キーとエンドポイントを取得する

次に、アプリケーションを API に接続するには、リソースのキーとエンドポイントが必要です。 このクイックスタートで後に示すコードに、自分のキーとエンドポイントを貼り付けます。

1. 言語リソースが正常にデプロイされたら、[次の手順] の [リソースに移動] ボタンをクリックします。

   

2. リソースのスクリーンで、左側のナビゲーション メニューの [キーとエンドポイント] を選択します。 以下の手順では、キーの 1 つとエンドポイントを使用します。

   

環境変数を作成する

API 要求を送信するには、アプリケーションを認証する必要があります。 運用環境では、資格情報を安全に保存してアクセスできる方法を使用してください。 この例では、アプリケーションを実行しているローカル コンピューター上の環境変数に資格情報を書き込みます。

ヒント

キーは、コードに直接含めないようにし、公開しないでください。 Azure Key Vault などのその他の認証オプションについては、Azure AI サービスのセキュリティに関する記事を参照してください。

言語リソース キーの環境変数を設定するには、コンソール ウィンドウを開き、オペレーティング システムと開発環境の指示に従います。

1. LANGUAGE_KEY 環境変数を設定するには、your-key をリソースのキーの 1 つに置き換えます。
2. LANGUAGE_ENDPOINT 環境変数を設定するには、your-endpoint をリソースのエンドポイントに置き換えます。

Windows

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Note

現在実行中のコンソールで環境変数のみにアクセスする必要がある場合は、環境変数を setx の代わりに set に設定できます。

実行中のプログラムのうち、環境変数の読み取りを必要とするプログラム (コンソール ウィンドウを含む) については、環境変数を追加した後で再起動が必要となる場合があります。 たとえば、Visual Studio をエディターとして使用している場合、サンプルを実行する前に Visual Studio を再起動します。

Linux

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bashrc を実行します。

macOS

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bash_profile を実行します。

Xcode

iOS と macOS の開発では、Xcode で環境変数を設定します。 たとえば、次の手順に従って、Xcode 13.4.1 で環境変数を設定します。

1. [Product]、[Scheme]、[スキームの編集] の順に選択する
2. [引数] を [実行] (デバッグ実行) ページで選択する
3. [環境変数] で、プラス記号 (+) を選択して、新しい環境変数を追加します。
4. [名前] に「LANGUAGE_KEY」と入力し、[値] に言語リソース キーを入力します。
5. リソース エンドポイントに対してこれらの手順を実行します。 新しい環境変数 LANGUAGE_ENDPOINT に名前を付けます。

その他の構成オプションについては、Xcode のドキュメントを参照してください。

クライアント ライブラリを追加する

好みの IDE または開発環境で Maven プロジェクトを作成します。 次に、自分のプロジェクトの pom.xml ファイルに次の依存関係を追加します。 その他のビルド ツールの実装構文はオンラインで確認できます。

<dependencies>
     <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-ai-textanalytics</artifactId>
        <version>5.2.0</version>
    </dependency>
</dependencies>

コードの例

Example.java という名前で Java ファイルを作成します。 ファイルを開き、下のコードをコピーします。 次にコードを実行します。

import com.azure.core.credential.AzureKeyCredential;
import com.azure.ai.textanalytics.models.*;
import com.azure.ai.textanalytics.TextAnalyticsClientBuilder;
import com.azure.ai.textanalytics.TextAnalyticsClient;

public class Example {

    // This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
    private static String languageKey = System.getenv("LANGUAGE_KEY");
    private static String languageEndpoint = System.getenv("LANGUAGE_ENDPOINT");

    public static void main(String[] args) {
        TextAnalyticsClient client = authenticateClient(languageKey, languageEndpoint);
        recognizeEntitiesExample(client);
    }
    // Method to authenticate the client object with your key and endpoint
    static TextAnalyticsClient authenticateClient(String key, String endpoint) {
        return new TextAnalyticsClientBuilder()
                .credential(new AzureKeyCredential(key))
                .endpoint(endpoint)
                .buildClient();
    }
    // Example method for recognizing entities in text
    static void recognizeEntitiesExample(TextAnalyticsClient client)
    {
        // The text that needs to be analyzed.
        String text = "I had a wonderful trip to Seattle last week.";
    
        for (CategorizedEntity entity : client.recognizeEntities(text)) {
            System.out.printf(
                "Recognized entity: %s, entity category: %s, entity sub-category: %s, score: %s, offset: %s, length: %s.%n",
                entity.getText(),
                entity.getCategory(),
                entity.getSubcategory(),
                entity.getConfidenceScore(),
                entity.getOffset(),
                entity.getLength());
        }
    }
}

出力

Recognized entity: trip, entity category: Event, entity sub-category: null, score: 0.74, offset: 18, length: 4.
Recognized entity: Seattle, entity category: Location, entity sub-category: GPE, score: 1.0, offset: 26, length: 7.
Recognized entity: last week, entity category: DateTime, entity sub-category: DateRange, score: 0.8, offset: 34, length: 9.

リファレンス ドキュメント | その他のサンプル | パッケージ (npm) | ライブラリのソース コード

このクイック スタートを使用して、Node.js 用クライアント ライブラリを使用して固有表現認識 (NER) アプリケーションを作成します。 次の例では、テキスト メッセージの認識されたエンティティを識別できる JavaScript アプリケーションを作成します。

前提条件

• Azure サブスクリプション - 無料アカウントを作成します
• Node.js v14 LTS 以降

設定

Azure リソースを作成する

以下のコード サンプルを使用するには、Azure リソースをデプロイする必要があります。 このリソースには、言語サービスに送信する API 呼び出しを認証するために使用するキーとエンドポイントが含まれます。

1. Azure portal を使用して言語リソースを作成するには、次のリンクを使用します。 Azure サブスクリプションを使用してサインインする必要があります。

2. 表示される [追加機能を選択する] スクリーンで、[続行] を選択 してリソースを作成します。

   

3. [言語の作成] スクリーンで、次の情報を入力します。

   詳細	説明
   サブスクリプション	リソースが関連付けられるサブスクリプション アカウント。 ドロップダウン メニューから Azure サブスクリプションを選択します。
   リソース グループ	リソース グループは、作成したリソースを保存するコンテナーです。 [新規作成] を選んで、新しいリソース グループを作成します。
   リージョン	言語リソースの場所。 別のリージョンを選択すると、物理的な場所によっては待機時間が生じる可能性がありますが、リソースのランタイムの可用性には影響しません。 このクイック スタートでは、近くの利用可能なリージョンを選択するか、米国東部を選択します。
   名前	言語リソースの名前。 この名前は、アプリケーションが API 要求の送信に使用するエンドポイント URL の作成にも使用されます。
   価格レベル	言語リソースの価格レベル。 Free F0 レベルを使用してサービスを試用し、後から運用環境用の有料レベルにアップグレードすることができます。

   

4. [責任ある AI の通知] チェックボックスがオンになっていることを確認します。

5. ページの下部にある [確認および作成] を選択します。

6. 表示されるスクリーンで、検証に合格し、情報を正しく入力したことを確認します。 [作成] を選択します。

キーとエンドポイントを取得する

次に、アプリケーションを API に接続するには、リソースのキーとエンドポイントが必要です。 このクイックスタートで後に示すコードに、自分のキーとエンドポイントを貼り付けます。

1. 言語リソースが正常にデプロイされたら、[次の手順] の [リソースに移動] ボタンをクリックします。

   

2. リソースのスクリーンで、左側のナビゲーション メニューの [キーとエンドポイント] を選択します。 以下の手順では、キーの 1 つとエンドポイントを使用します。

   

環境変数を作成する

API 要求を送信するには、アプリケーションを認証する必要があります。 運用環境では、資格情報を安全に保存してアクセスできる方法を使用してください。 この例では、アプリケーションを実行しているローカル コンピューター上の環境変数に資格情報を書き込みます。

ヒント

キーは、コードに直接含めないようにし、公開しないでください。 Azure Key Vault などのその他の認証オプションについては、Azure AI サービスのセキュリティに関する記事を参照してください。

言語リソース キーの環境変数を設定するには、コンソール ウィンドウを開き、オペレーティング システムと開発環境の指示に従います。

1. LANGUAGE_KEY 環境変数を設定するには、your-key をリソースのキーの 1 つに置き換えます。
2. LANGUAGE_ENDPOINT 環境変数を設定するには、your-endpoint をリソースのエンドポイントに置き換えます。

Windows

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Note

現在実行中のコンソールで環境変数のみにアクセスする必要がある場合は、環境変数を setx の代わりに set に設定できます。

実行中のプログラムのうち、環境変数の読み取りを必要とするプログラム (コンソール ウィンドウを含む) については、環境変数を追加した後で再起動が必要となる場合があります。 たとえば、Visual Studio をエディターとして使用している場合、サンプルを実行する前に Visual Studio を再起動します。

Linux

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bashrc を実行します。

macOS

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bash_profile を実行します。

Xcode

iOS と macOS の開発では、Xcode で環境変数を設定します。 たとえば、次の手順に従って、Xcode 13.4.1 で環境変数を設定します。

1. [Product]、[Scheme]、[スキームの編集] の順に選択する
2. [引数] を [実行] (デバッグ実行) ページで選択する
3. [環境変数] で、プラス記号 (+) を選択して、新しい環境変数を追加します。
4. [名前] に「LANGUAGE_KEY」と入力し、[値] に言語リソース キーを入力します。
5. リソース エンドポイントに対してこれらの手順を実行します。 新しい環境変数 LANGUAGE_ENDPOINT に名前を付けます。

その他の構成オプションについては、Xcode のドキュメントを参照してください。

新しい Node.js アプリケーションを作成する

コンソール ウィンドウ (cmd、PowerShell、Bash など) で、ご利用のアプリ用に新しいディレクトリを作成し、そこに移動します。

mkdir myapp 

cd myapp

npm init コマンドを実行し、package.json ファイルを使用して node アプリケーションを作成します。

npm init

クライアント ライブラリをインストールする

npm パッケージをインストールします:

npm install @azure/ai-language-text

コードの例

ファイルを開き、下のコードをコピーします。 次にコードを実行します。

"use strict";

const { TextAnalyticsClient, AzureKeyCredential } = require("@azure/ai-text-analytics");

// This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
const key = process.env.LANGUAGE_KEY;
const endpoint = process.env.LANGUAGE_ENDPOINT;

//an example document for entity recognition
const documents = [ "Microsoft was founded by Bill Gates and Paul Allen on April 4, 1975, to develop and sell BASIC interpreters for the Altair 8800"];

//example of how to use the client library to recognize entities in a document.
async function main() {
    console.log("== NER sample ==");
  
    const client = new TextAnalysisClient(endpoint, new AzureKeyCredential(key));
  
    const results = await client.analyze("EntityRecognition", documents);
  
    for (const result of results) {
      console.log(`- Document ${result.id}`);
      if (!result.error) {
        console.log("\tRecognized Entities:");
        for (const entity of result.entities) {
          console.log(`\t- Entity ${entity.text} of type ${entity.category}`);
        }
      } else console.error("\tError:", result.error);
    }
  }

//call the main function
main().catch((err) => {
    console.error("The sample encountered an error:", err);
});

出力

Document ID: 0
        Name: Microsoft         Category: Organization  Subcategory: N/A
        Score: 0.29
        Name: Bill Gates        Category: Person        Subcategory: N/A
        Score: 0.78
        Name: Paul Allen        Category: Person        Subcategory: N/A
        Score: 0.82
        Name: April 4, 1975     Category: DateTime      Subcategory: Date
        Score: 0.8
        Name: 8800      Category: Quantity      Subcategory: Number
        Score: 0.8
Document ID: 1
        Name: 21        Category: Quantity      Subcategory: Number
        Score: 0.8
        Name: Seattle   Category: Location      Subcategory: GPE
        Score: 0.25

リファレンス ドキュメント | その他のサンプル | パッケージ (PyPi) | ライブラリのソース コード

このクイック スタートを使用して、Python 用クライアント ライブラリを使用して固有表現認識 (NER) アプリケーションを作成します。 次の例では、テキスト メッセージの認識されたエンティティを識別できる Python アプリケーションを作成します。

前提条件

• Azure サブスクリプション - 無料アカウントを作成します
• Python 3.8 以降

設定

クライアント ライブラリをインストールする

Python をインストールしたら、次を使用してクライアント ライブラリをインストールすることができます。

pip install azure-ai-textanalytics==5.2.0

コードの例

新しい Python ファイルを作成し、下のコードをコピーします。 次にコードを実行します。

# This example requires environment variables named "LANGUAGE_KEY" and "LANGUAGE_ENDPOINT"
language_key = os.environ.get('LANGUAGE_KEY')
language_endpoint = os.environ.get('LANGUAGE_ENDPOINT')

from azure.ai.textanalytics import TextAnalyticsClient
from azure.core.credentials import AzureKeyCredential

# Authenticate the client using your key and endpoint 
def authenticate_client():
    ta_credential = AzureKeyCredential(language_key)
    text_analytics_client = TextAnalyticsClient(
            endpoint=language_endpoint, 
            credential=ta_credential)
    return text_analytics_client

client = authenticate_client()

# Example function for recognizing entities from text
def entity_recognition_example(client):

    try:
        documents = ["I had a wonderful trip to Seattle last week."]
        result = client.recognize_entities(documents = documents)[0]

        print("Named Entities:\n")
        for entity in result.entities:
            print("\tText: \t", entity.text, "\tCategory: \t", entity.category, "\tSubCategory: \t", entity.subcategory,
                    "\n\tConfidence Score: \t", round(entity.confidence_score, 2), "\tLength: \t", entity.length, "\tOffset: \t", entity.offset, "\n")

    except Exception as err:
        print("Encountered exception. {}".format(err))
entity_recognition_example(client)

出力

Named Entities:

    Text:    trip   Category:        Event  SubCategory:     None
    Confidence Score:        0.74   Length:          4      Offset:          18

    Text:    Seattle        Category:        Location       SubCategory:     GPE
    Confidence Score:        1.0    Length:          7      Offset:          26

    Text:    last week      Category:        DateTime       SubCategory:     DateRange
    Confidence Score:        0.8    Length:          9      Offset:          34

リファレンス ドキュメント

このクイック スタートを使用して、REST APIを使い、固有表現認識 (NER)要求を送信します。 次の例では、cURL を使用して、テキスト メッセージ内の認識されたエンティティを識別します。

前提条件

• Azure サブスクリプション - 無料アカウントを作成します

設定

Azure リソースを作成する

以下のコード サンプルを使用するには、Azure リソースをデプロイする必要があります。 このリソースには、言語サービスに送信する API 呼び出しを認証するために使用するキーとエンドポイントが含まれます。

1. Azure portal を使用して言語リソースを作成するには、次のリンクを使用します。 Azure サブスクリプションを使用してサインインする必要があります。

2. 表示される [追加機能を選択する] スクリーンで、[続行] を選択 してリソースを作成します。

   

3. [言語の作成] スクリーンで、次の情報を入力します。

   詳細	説明
   サブスクリプション	リソースが関連付けられるサブスクリプション アカウント。 ドロップダウン メニューから Azure サブスクリプションを選択します。
   リソース グループ	リソース グループは、作成したリソースを保存するコンテナーです。 [新規作成] を選んで、新しいリソース グループを作成します。
   リージョン	言語リソースの場所。 別のリージョンを選択すると、物理的な場所によっては待機時間が生じる可能性がありますが、リソースのランタイムの可用性には影響しません。 このクイック スタートでは、近くの利用可能なリージョンを選択するか、米国東部を選択します。
   名前	言語リソースの名前。 この名前は、アプリケーションが API 要求の送信に使用するエンドポイント URL の作成にも使用されます。
   価格レベル	言語リソースの価格レベル。 Free F0 レベルを使用してサービスを試用し、後から運用環境用の有料レベルにアップグレードすることができます。

   

4. [責任ある AI の通知] チェックボックスがオンになっていることを確認します。

5. ページの下部にある [確認および作成] を選択します。

6. 表示されるスクリーンで、検証に合格し、情報を正しく入力したことを確認します。 [作成] を選択します。

キーとエンドポイントを取得する

次に、アプリケーションを API に接続するには、リソースのキーとエンドポイントが必要です。 このクイックスタートで後に示すコードに、自分のキーとエンドポイントを貼り付けます。

1. 言語リソースが正常にデプロイされたら、[次の手順] の [リソースに移動] ボタンをクリックします。

   

2. リソースのスクリーンで、左側のナビゲーション メニューの [キーとエンドポイント] を選択します。 以下の手順では、キーの 1 つとエンドポイントを使用します。

   

環境変数を作成する

API 要求を送信するには、アプリケーションを認証する必要があります。 運用環境では、資格情報を安全に保存してアクセスできる方法を使用してください。 この例では、アプリケーションを実行しているローカル コンピューター上の環境変数に資格情報を書き込みます。

ヒント

キーは、コードに直接含めないようにし、公開しないでください。 Azure Key Vault などのその他の認証オプションについては、Azure AI サービスのセキュリティに関する記事を参照してください。

言語リソース キーの環境変数を設定するには、コンソール ウィンドウを開き、オペレーティング システムと開発環境の指示に従います。

1. LANGUAGE_KEY 環境変数を設定するには、your-key をリソースのキーの 1 つに置き換えます。
2. LANGUAGE_ENDPOINT 環境変数を設定するには、your-endpoint をリソースのエンドポイントに置き換えます。

Windows

setx LANGUAGE_KEY your-key

setx LANGUAGE_ENDPOINT your-endpoint

Note

現在実行中のコンソールで環境変数のみにアクセスする必要がある場合は、環境変数を setx の代わりに set に設定できます。

実行中のプログラムのうち、環境変数の読み取りを必要とするプログラム (コンソール ウィンドウを含む) については、環境変数を追加した後で再起動が必要となる場合があります。 たとえば、Visual Studio をエディターとして使用している場合、サンプルを実行する前に Visual Studio を再起動します。

Linux

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bashrc を実行します。

macOS

Bash

export LANGUAGE_KEY=your-key

export LANGUAGE_ENDPOINT=your-endpoint

環境変数を追加した後、変更を有効にするには、コンソール ウィンドウから source ~/.bash_profile を実行します。

Xcode

iOS と macOS の開発では、Xcode で環境変数を設定します。 たとえば、次の手順に従って、Xcode 13.4.1 で環境変数を設定します。

1. [Product]、[Scheme]、[スキームの編集] の順に選択する
2. [引数] を [実行] (デバッグ実行) ページで選択する
3. [環境変数] で、プラス記号 (+) を選択して、新しい環境変数を追加します。
4. [名前] に「LANGUAGE_KEY」と入力し、[値] に言語リソース キーを入力します。
5. リソース エンドポイントに対してこれらの手順を実行します。 新しい環境変数 LANGUAGE_ENDPOINT に名前を付けます。

その他の構成オプションについては、Xcode のドキュメントを参照してください。

要求本文の例を使用して JSON ファイルを作成する

コード エディターで、test_ner_payload.json という名前の新しいファイルを作成し、次の JSON の例をコピーします。 この例の要求は、次の手順で API に送信されます。

{
    "kind": "EntityRecognition",
    "parameters": {
        "modelVersion": "latest"
    },
    "analysisInput":{
        "documents":[
            {
                "id":"1",
                "language": "en",
                "text": "I had a wonderful trip to Seattle last week."
            }
        ]
    }
}

test_ner_payload.json をコンピューターの任意の場所に保存します。 たとえば、デスクトップなどです。

名前付きエンティティ認識 API 要求を送信する

現在使用しているプログラムを使用して API 要求を送信するには、次のコマンドを使用します。 コマンドをターミナルにコピーして実行します。

パラメーター	Description
-X POST <endpoint>	API にアクセスするためのエンドポイントを指定します。
-H Content-Type: application/json	JSON データを送信するためのコンテンツ タイプ。
-H "Ocp-Apim-Subscription-Key:<key>	API にアクセスするためのキーを指定します。
-d <documents>	送信するドキュメントを含む JSON。

Windows

C:\Users\<myaccount>\Desktop\test_ner_payload.json は、前のステップで作成した JSON 要求ファイルの例の場所に置き換えます。

コマンド プロンプト

curl -X POST "%LANGUAGE_ENDPOINT%/language/:analyze-text?api-version=2022-05-01" ^
-H "Content-Type: application/json" ^
-H "Ocp-Apim-Subscription-Key: %LANGUAGE_KEY%" ^
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

PowerShell

curl.exe -X POST $env:LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 `
-H "Content-Type: application/json" `
-H "Ocp-Apim-Subscription-Key: $env:LANGUAGE_KEY" `
-d "@C:\Users\<myaccount>\Desktop\test_ner_payload.json"

Linux

現在使用しているプログラムを使用して API 要求を送信するには、次のコマンドを使用します。 /home/mydir/test_ner_payload.json は、前のステップで作成した JSON 要求ファイルの例の場所に置き換えます。

curl -X POST $LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
-d "@/home/mydir/test_ner_payload.json"

macOS

現在使用しているプログラムを使用して API 要求を送信するには、次のコマンドを使用します。 /home/mydir/test_ner_payload.json は、前のステップで作成した JSON 要求ファイルの例の場所に置き換えます。

curl -X POST $LANGUAGE_ENDPOINT/language/:analyze-text?api-version=2022-05-01 \
-H "Content-Type: application/json" \
-H "Ocp-Apim-Subscription-Key: $LANGUAGE_KEY" \
-d "@/home/mydir/test_ner_payload.json"

JSON 応答

注意

• 一般提供 API と現在のプレビュー API の応答形式は異なります。「プレビュー API マッピングの一般公開」をご覧ください。
• プレビュー API は、API バージョン 2023-04-15-preview から開始できます。

一般提供 API

{
	"kind": "EntityRecognitionResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"text": "trip",
				"category": "Event",
				"offset": 18,
				"length": 4,
				"confidenceScore": 0.74
			}, {
				"text": "Seattle",
				"category": "Location",
				"subcategory": "GPE",
				"offset": 26,
				"length": 7,
				"confidenceScore": 1.0
			}, {
				"text": "last week",
				"category": "DateTime",
				"subcategory": "DateRange",
				"offset": 34,
				"length": 9,
				"confidenceScore": 0.8
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2021-06-01"
	}
}

プレビュー API

{
	"kind": "EntityRecognitionResults",
	"results": {
		"documents": [{
			"id": "1",
			"entities": [{
				"text": "trip",
				"type": "Event",
				"offset": 18,
				"length": 4,
				"score": 0.74,
				"tags": ["Event"]
			}, {
				"text": "Seattle",
				"type": "Location",
				"offset": 26,
				"length": 7,
				"score": 1.0,
				"tags": ["Location", "GPE", "City"]
			}, {
				"text": "last week",
				"type": "Temporal",
				"offset": 34,
				"length": 9,
				"score": 0.8,
				"tags": ["Temporal", "DateRange"],
				"metadata": {
					"begin": "2022-01-03 00:00:00",
					"end": "2022-01-10 00:00:00"
				}
			}],
			"warnings": []
		}],
		"errors": [],
		"modelVersion": "2023-04-01"
	}
}

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

Azure AI サービス サブスクリプションをクリーンアップして削除したい場合は、リソースまたはリソース グループを削除することができます。 リソース グループを削除すると、それに関連付けられている他のリソースも削除されます。

• ポータル
• Azure CLI

次のステップ

• NER の概要