Анализ текста (REST API поиска ИИ Azure)

Статья
05/10/2023

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 Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы анализатора api-key должны содержать заголовок ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу .

Поля	Описание
Content-Type	Обязательный. Для этого заголовка необходимо задать значение `application/json`
api-key	Необязательно, если вы используете роли Azure и в запросе предоставляется маркер носителя, в противном случае требуется ключ. Ключ API — это уникальная, сгенерированная системой строка, которая проверяет подлинность запроса к службе поиска. Запросы анализатора `api-key` должны содержать заголовок ключа администратора (в отличие от ключа запроса). Дополнительные сведения см. в статье Подключение к поиску ИИ Azure с помощью проверки подлинности по ключу .

Текст запроса

{
  "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 должны быть допустимыми именами предопределенных или настраиваемых анализаторов, создателей маркеров, фильтров маркеров и фильтров char для индекса. Дополнительные сведения о процессе лексического анализа см. в статье Анализ в поиске ИИ 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
        }
    ]
}

Поделиться через