テキストの分析 (Azure Cognitive Search REST API)Analyze Text (Azure Cognitive Search REST API)

Analyze API は、アナライザーがテキストをトークンに分割する方法を示しています。The Analyze API shows how an analyzer breaks text into tokens.

POST https://[service name].search.windows.net/indexes/[index name]/analyze?api-version=[api-version]
    Content-Type: application/json
    api-key: [admin key]

URI パラメーターURI Parameters

パラメーターParameter 説明Description
サービス名service name 必須です。Required. これを、検索サービスの一意のユーザー定義名に設定します。Set this to the unique, user-defined name of your search service.
インデックス名index name 必須です。Required. 要求 URI では、分析するフィールドを含むインデックスの名前を指定します。The request URI specifies the name of the index that contains the field you want to analyze.
api-versionapi-version 必須です。Required. 現行バージョンは api-version=2020-06-30です。The current version is api-version=2020-06-30. 使用可能なバージョンの一覧については、「 Azure Cognitive Search の API バージョン」を参照してください。See API versions in Azure Cognitive Search for a list of available versions.

要求ヘッダーRequest Headers

次の表では、必須と省略可能の要求ヘッダーについて説明します。The following table describes the required and optional request headers.

フィールドFields 説明Description
Content-TypeContent-Type 必須です。Required. これを application/jsonSet this to application/json
api-keyapi-key 必須です。Required. api-key は Search サービスに対する要求の認証に使用されます。The api-key is used to authenticate the request to your Search service. これはサービスに固有の文字列値です。It is a string value, unique to your service. アナライザーの要求には、 api-key (クエリキーではなく) 管理者キーに設定されたヘッダーを含める必要があります。Analyzer requests must include an api-key header set to your admin key (as opposed to a query key).

は、Azure portal の api-key サービスダッシュボードから取得できます。You can get the api-key from your service dashboard in the Azure portal. 詳細については、「既存のキーを検索する」を参照してください。For more information, see Find existing keys.

要求本文Request Body

{
  "text": "Text to analyze",
  "analyzer": "analyzer_name"
}

またはor

{
  "text": "Text to analyze",
  "tokenizer": "tokenizer_name",
  "tokenFilters": (optional) [ "token_filter_name" ],
  "charFilters": (optional) [ "char_filter_name" ]
}

analyzer_nametokenizer_name 、およびは、 token_filter_name char_filter_name インデックスの定義済みアナライザー、カスタムアナライザー、トークナイザー、トークンフィルター、および char フィルターの有効な名前である必要があります。The analyzer_name, tokenizer_name, token_filter_name and char_filter_name need to be valid names of predefined or custom analyzers, tokenizers, token filters, and char filters for the index. 字句解析のプロセスの詳細については、「 Azure Cognitive Search での分析」を参照してください。To learn more about the process of lexical analysis, see Analysis in Azure Cognitive Search.

応答Response

状態コード: 応答の成功に対して「200 OK」が返されます。Status Code: 200 OK is returned for a successful response.

応答本文の形式は次のとおりです。The response body is in the following format:

    {
      "tokens": [
        {
          "token": string (token),
          "startOffset": number (index of the first character of the token),
          "endOffset": number (index of the last character of the token),
          "position": number (position of the token in the input text)
        },
        ...
      ]
    }

Examples

要求本文には、使用する文字列とアナライザーが含まれています。Request body includes the string and analyzer you want to use.

     {
       "text": "The quick brown fox",
       "analyzer": "standard"
     }

応答には、指定した文字列のアナライザーによって出力されたトークンが表示されます。The response shows the tokens emitted by the analyzer for the string you provide.

{
    "tokens": [
        {
            "token": "the",
            "startOffset": 0,
            "endOffset": 3,
            "position": 0
        },
        {
            "token": "quick",
            "startOffset": 4,
            "endOffset": 9,
            "position": 1
        },
        {
            "token": "brown",
            "startOffset": 10,
            "endOffset": 15,
            "position": 2
        },
        {
            "token": "fox",
            "startOffset": 16,
            "endOffset": 19,
            "position": 3
        }
    ]
}

ヒント

Search Analyzer Demo では、標準 Lucene アナライザー、Lucene の英語アナライザー、Microsoft の英語自然言語プロセッサによって生成された結果の比較が横並びに表示されます。The Search Analyzer Demo provides side-by-side comparison of results produced by the standard Lucene analyzer, Lucene's English language analyzer, and Microsoft's English natural language processor. 指定した検索の入力ごとに、各アナライザーの結果が隣接する列に表示されます。For each search input you provide, results from each analyzer are displayed in adjacent panes.

関連項目See also

Azure Cognitive Search REST APIAzure Cognitive Search REST APIs
Azure Cognitive Search のカスタムアナライザーCustom analyzers in Azure Cognitive Search
言語サポートLanguage support
Azure Cognitive Search)API バージョン (の HTTP 状態コードは、azure Cognitive SearchHTTP status codes (Azure Cognitive Search) API versions in Azure Cognitive Search