共用方式為

分析 Azure AI 搜尋 REST API (文字)

  • 發行項

「分析 API」 會顯示分析器如何將文字分解成語彙基元。 其適用于互動式測試，讓您瞭解指定分析器如何標記字串輸入。

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

若要指定索引編制和查詢執行期間所使用的分析器，請在索引中的字串欄位上設定分析器屬性。

URI 參數

參數 Description
服務名稱 必要。 將此設定為搜尋服務的唯一使用者定義名稱。
索引名稱 必要。 要求 URI 會指定包含您要分析之欄位的索引名稱。
api-version 必要。 目前的穩定版本為 api-version=2020-06-30 。 如需更多版本，請參閱 API 版本 。

要求標頭

下表說明必要及選用的要求標頭。

欄位 Description
Content-Type 必要。 請設為 application/json
api-key 如果您使用 Azure 角色 ，而且要求會提供持有人權杖，則為選擇性，否則需要金鑰。 API 金鑰是唯一的系統產生字串，可驗證對搜尋服務的要求。 分析器要求必須包含 api-key 設定為系統管理員金鑰的標頭， (而不是查詢金鑰) 。 如需詳細資訊 ，請參閱使用金鑰驗證連線到 Azure AI 搜尋 服務。

要求本文

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

或

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

analyzer_name、 tokenizer_nametoken_filter_name 和 char_filter_name 必須是索引之預先定義或自訂分析器、Tokenizer、權杖篩選器和字元篩選的有效名稱。 若要深入瞭解語彙分析的程式，請參閱 Azure AI 搜尋中的分析。

回應

回應成功時會傳回狀態碼：200 OK。

回應本文的格式如下：

    {
      "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)
        },
        ...
      ]
    }

範例

要求本文包含您想要使用的字串和分析器。

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

回應會顯示分析器針對您提供的字串所發出的權杖。

{
    "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
        }
    ]
}

另請參閱