你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

分析文本 (Azure 认知搜索 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 参数

参数 描述
服务名称 必需。 将其设置为搜索服务的唯一用户定义的名称。
索引名称 必需。 请求 URI 指定包含要分析的字段的索引的名称。
api-version 必需。 当前稳定版本为 api-version=2020-06-30. 有关更多版本,请参阅 API 版本

请求标头

下表介绍必需和可选的请求标头。

字段 说明
Content-Type 必需。 将其设置为 application/json
api-key 必需。 api-key 用于对搜索服务的请求进行身份验证。 它是一个字符串值,对于服务是唯一的。 分析器请求必须包含一个 api-key 标头集, (而不是查询密钥) 。 可以在Azure 门户的搜索服务仪表板中找到 API 密钥

请求正文

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

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

tokenizer_namechar_filter_nametoken_filter_name需要analyzer_name是预定义分析器或自定义分析器、标记器、令牌筛选器和索引字符筛选器的有效名称。 若要详细了解词法分析过程,请参阅Azure 认知搜索中的分析

响应

对于成功的响应,返回“状态代码:200 正常”。

响应正文格式如下:

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

另请参阅