Отправка запросов классификации текста в модель

Статья
11/21/2024

После успешного развертывания модели можно запросить развертывание для классификации текста на основе модели, назначенной развертыванию. Вы можете запросить развертывание программным способом через API прогнозирования или клиентские библиотеки (пакет SDK Azure).

Тестирование развернутой модели

Вы можете использовать Language Studio для отправки задачи пользовательской классификации текстов и визуализации результатов.

Чтобы протестировать развернутые модели в Language Studio, выполните следующие действия.

В меню слева выберите Testing deployments (Тестирование развертываний).
Выберите развертывание, которое нужно протестировать. Можно тестировать только модели, назначенные развертываниям.
Для многоязычных проектов выберите язык тестируемого текста из раскрывающегося списка языков.
Выберите развертывание, которое требуется запросить или протестировать, из раскрывающегося списка.
Введите текст, который требуется отправить в запросе, или отправьте файл .txt, который требуется использовать.
Выберите "Запустить тест " в верхнем меню.
На вкладке Result (Результат) можно просмотреть извлеченные из текста сущности и их типы. Вы также можете просмотреть ответ JSON на вкладке JSON.

Отправка запроса на классификацию текста в модель

Совет

Модель можно проверить в Language Studio, отправив туда примеры текста для проведения классификации.

После успешного завершения задания развертывания выберите развертывание, которое вы хотите использовать, и в верхнем меню выберите "Получить URL-адрес прогнозирования".
В появившемся окне в разделе "Отправить " скопируйте URL-адрес и текст примера запроса. Замените такие значения заполнителей, как YOUR_DOCUMENT_HERE YOUR_DOCUMENT_LANGUAGE_HERE и фактический текст и язык, которые требуется обработать.
Отправьте запрос POST для получения URL-адреса в терминал или командную строку. Если запрос выполнен успешно, вы получите отклик 202 с результатами API.
В заголовке ответа вы получите {JOB-ID}, извлеченный из operation-location, в формате {ENDPOINT}/language/analyze-text/jobs/<JOB-ID}>
В Language Studio выберите Получить в том же окне, которое вы использовали ранее для получения примера запроса, и скопируйте пример запроса в текстовый редактор.
Добавьте идентификатор задания после /jobs/ URL-адреса, используя идентификатор, извлеченный на предыдущем шаге.
Отправьте запрос GET для получения URL-адреса в терминал или командную строку.

Сначала необходимо получить ключ ресурса и конечную точку:

Перейдите на страницу обзора ресурса на портале Azure
В меню слева выберите Ключи и конечная точка. Вы будете использовать конечную точку и ключ для запросов API

Отправка задачи пользовательской классификации текста

Используйте этот запрос POST для запуска задачи классификации текста.

{ENDPOINT}/language/analyze-text/jobs?api-version={API-VERSION}

Заполнитель	Значение	Пример
`{ENDPOINT}`	Конечная точка для проверки подлинности запроса API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{API-VERSION}`	Версия вызываемого API. Указанное здесь значение определяет последнюю выпущенную версию модели. Дополнительные сведения о других доступных версиях API см. в статье Жизненный цикл модели.	`2022-05-01`

Заголовки

Ключ	Стоимость
Ocp-Apim-Subscription-Key	Ключ, который предоставляет доступ к этому API.

{
  "displayName": "Classifying documents",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
     {
      "kind": "CustomMultiLabelClassification",
      "taskName": "Multi Label Classification",
      "parameters": {
        "projectName": "{PROJECT-NAME}",
        "deploymentName": "{DEPLOYMENT-NAME}"
      }
    }
  ]
}

Ключ	Заполнитель	Значение	Пример
`displayName`	`{JOB-NAME}`	Имя задания.	`MyJobName`
`documents`	[{},{}]	Список документов для запуска задач.	`[{},{}]`
`id`	`{DOC-ID}`	Имя или идентификатор документа.	`doc1`
`language`	`{LANGUAGE-CODE}`	Строка, указывающая код языка для документа. Если этот ключ не указан, служба будет использовать язык по умолчанию проекта, выбранный во время создания проекта. Список всех поддерживаемых языков см. в статье Поддержка языков.	`en-us`
`text`	`{DOC-TEXT}`	Задача документа, для которого будут выполняться задачи.	`Lorem ipsum dolor sit amet`
`tasks`		Список задач, которые мы хотим выполнить.	`[]`
`taskName`	CustomMultiLabelClassification	Имя задачи	CustomMultiLabelClassification
`parameters`		Список параметров, которые нужно передать задаче.
`project-name`	`{PROJECT-NAME}`	Имя проекта. Это значение учитывает регистр.	`myProject`
`deployment-name`	`{DEPLOYMENT-NAME}`	Имя развертывания. Это значение учитывает регистр.	`prod`

{
  "displayName": "Classifying documents",
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "{LANGUAGE-CODE}",
        "text": "Text1"
      },
      {
        "id": "2",
        "language": "{LANGUAGE-CODE}",
        "text": "Text2"
      }
    ]
  },
  "tasks": [
    {
      "kind": "CustomSingleLabelClassification",
      "taskName": "Single Classification Label",
      "parameters": {
        "projectName": "{PROJECT-NAME}",
        "deploymentName": "{DEPLOYMENT-NAME}"
      }
    }
  ]
}

Ключ	Заполнитель	Значение	Пример
displayName	`{JOB-NAME}`	Имя задания.	`MyJobName`
документов		Список документов для запуска задач.
`id`	`{DOC-ID}`	Имя или идентификатор документа.	`doc1`
`language`	`{LANGUAGE-CODE}`	Строка, указывающая код языка для документа. Если этот ключ не указан, служба будет использовать язык по умолчанию проекта, выбранный во время создания проекта. Список всех поддерживаемых языков см. в статье Поддержка языков.	`en-us`
`text`	`{DOC-TEXT}`	Задача документа, для которого будут выполняться задачи.	`Lorem ipsum dolor sit amet`
`taskName`	CustomSingleLabelClassification	Имя задачи	CustomSingleLabelClassification
`tasks`	[]	Массив задач, которые нужно выполнить.	[]
`parameters`		Список параметров, которые нужно передать задаче.
`project-name`	`{PROJECT-NAME}`	Имя проекта. Это значение учитывает регистр.	`myProject`
`deployment-name`	`{DEPLOYMENT-NAME}`	Имя развертывания. Это значение учитывает регистр.	`prod`

Response

Вы получите ответ 202, указывающий на успешное выполнение. Извлеките значение operation-location из заголовков ответа. operation-location имеет следующий формат:

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}

Этот URL-адрес можно использовать для запроса состояния завершения задачи и получения результатов после ее завершения.

Получение результатов выполнения задачи

Используйте следующий запрос GET, чтобы запросить состояние или результаты задания классификации текста.

{ENDPOINT}/language/analyze-text/jobs/{JOB-ID}?api-version={API-VERSION}

Заполнитель	Значение	Пример
`{ENDPOINT}`	Конечная точка для проверки подлинности запроса API.	`https://<your-custom-subdomain>.cognitiveservices.azure.com`
`{API-VERSION}`	Версия вызываемого API. Указанное здесь значение определяет последнюю выпущенную версию модели.	`2022-05-01`

Заголовки

Ключ	Стоимость
Ocp-Apim-Subscription-Key	Ключ, который предоставляет доступ к этому API.

Текст ответа

Ответ будет содержать документ JSON с приведенными ниже параметрами.

Классификация по нескольким меткам
Классификация по одной метке

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxxxx-xxxxx-xxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "customMultiClassificationTasks",
        "taskName": "Classify documents",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "{DOC-ID}",
              "classes": [
                  {
                      "category": "Class_1",
                      "confidenceScore": 0.0551877357
                  }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

{
  "createdDateTime": "2021-05-19T14:32:25.578Z",
  "displayName": "MyJobName",
  "expirationDateTime": "2021-05-19T14:32:25.578Z",
  "jobId": "xxxx-xxxxxx-xxxxx-xxxx",
  "lastUpdateDateTime": "2021-05-19T14:32:25.578Z",
  "status": "succeeded",
  "tasks": {
    "completed": 1,
    "failed": 0,
    "inProgress": 0,
    "total": 1,
    "items": [
      {
        "kind": "customSingleClassificationTasks",
        "taskName": "Classify documents",
        "lastUpdateDateTime": "2020-10-01T15:01:03Z",
        "status": "succeeded",
        "results": {
          "documents": [
            {
              "id": "{DOC-ID}",
              "class": [
                  {
                      "category": "Class_1",
                      "confidenceScore": 0.0551877357
                  }
              ],
              "warnings": []
            }
          ],
          "errors": [],
          "modelVersion": "2020-04-01"
        }
      }
    ]
  }
}

Сначала необходимо получить ключ ресурса и конечную точку:

Перейдите на страницу обзора ресурса на портале Azure
В меню слева выберите Ключи и конечная точка. Конечная точка и ключ вам понадобятся для запросов API.

Скачайте и установите пакет клиентской библиотеки для выбранного языка:

Язык Версия пакета

.NET 5.2.0-beta.3

Java 5.2.0-beta.3

JavaScript 6.0.0-beta.1

Python 5.2.0b4
После установки клиентской библиотеки используйте следующие примеры на GitHub для вызова API.

Классификация по одной метке:
- C#
- Java
- JavaScript
- Python
Классификация по нескольким меткам:
- C#
- Java
- JavaScript
- Python
Дополнительные сведения о клиенте и возвращаемом объекте см. в следующей справочной документации:
- C#
- Java
- JavaScript
- Python

Язык	Версия пакета
.NET	5.2.0-beta.3
Java	5.2.0-beta.3
JavaScript	6.0.0-beta.1
Python	5.2.0b4

Следующие шаги

Общие сведения о пользовательской классификации текстов

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

Отправка запросов классификации текста в модель

Тестирование развернутой модели

Отправка запроса на классификацию текста в модель

Отправка задачи пользовательской классификации текста

Заголовки

Текст

Response

Получение результатов выполнения задачи

Заголовки

Текст ответа

Следующие шаги

Обратная связь

Дополнительные ресурсы