Краткое руководство: Понимание разговорного языка

Microsoft Foundry предлагает единую платформу для создания, управления и развертывания решений ИИ с широким спектром моделей и инструментов. Игровые площадки Foundry — это интерактивные среды на портале Foundry, предназначенные для изучения, тестирования и прототипов с помощью различных моделей и инструментов ИИ.

Используйте эту статью, чтобы приступить к работе с пониманием языка бесед с помощью Foundry или REST API.

Примечание.

  • Если у вас уже есть язык Azure в средствах Foundry или ресурс с несколькими службами ( независимо от того, используется ли он самостоятельно или через Language Studio), вы можете продолжать использовать эти существующие языковые ресурсы на портале Microsoft Foundry.
  • Дополнительные сведения см. в разделе "Использование средств Foundry" на портале Foundry.
  • Настоятельно рекомендуется использовать ресурс Foundry в Foundry. Однако, эти инструкции также можно выполнить, используя ресурс Language.

Предварительные условия

Начало работы с Foundry

Чтобы завершить работу с этим кратким руководством, вам потребуется проект задачи точной настройки общения (CLU), включающий определенную схему и помеченные речевые фрагменты.

Вы можете скачать наш пример файла проекта, который поставляется предварительно настроен как с схемой, так и с помеченными речевыми фрагментами. Этот проект позволяет прогнозировать намерение пользователя для таких команд, как чтение сообщений электронной почты, удаление сообщений электронной почты и вложение документов в сообщения электронной почты.

Начнем:

  1. Перейдите к Литейу.
  2. Если вы еще не вошли, на портале появится запрос на использование учетных данных Azure.
  3. После входа вы можете создать или получить доступ к существующим проектам в Foundry.
  4. Если вы еще не находитесь в проекте для этой задачи, выберите его.
  5. На левой боковой панели навигации выберите "Игровые площадки", перейдите на плитку "Языковая площадка" и нажмите кнопку "Попробовать языковую площадку Azure ".

Скриншот выбора Try Language Playground в Foundry.

Попробуйте использовать языковую площадку Azure

В верхней части игровой площадки языка Azure можно просмотреть и выбрать доступные языки.

  1. Выберите область "Понимание разговорного языка".

    Снимок экрана домашней страницы языковой песочницы в Foundry.

  2. Затем прокрутите страницу и нажмите кнопку "Тонкой настройки ".

    Снимок экрана кнопки настройки параметров на странице языковой площадки в Foundry.

  3. В окне создания службы тонкой настройки выберите карточку распознавания речи беседы. Затем выберите Далее.

    Снимок экрана: плитка выбора понимания разговорной речи в Foundry.

  4. В окне задачи "Создание тонкой настройки CLU " выберите "Импорт существующего проекта", а затем выберите подключенную службу в раскрывающемся меню и заполните поле "Имя ".

    Снимок экрана: импорт существующего выбора проекта в Foundry.

  5. Затем добавьте пример файла проекта , который вы скачали ранее в область отправки.

  6. Нажмите кнопку "Создать ". Выполнение операции создания может занять несколько минут.

  7. После создания проекта задачи тонкой настройки откроется страница "Начало работы с тонкой настройкой ".

    Снимок экрана: страница

Обучение модели

После создания проекта следующие шаги — создание схемы и метка речевых фрагментов. В этом кратком руководстве эти действия предварительно настроены в примере проекта. Таким образом, вы можете перейти к обучению и инициировать задание обучения, выбрав " Обучение модели " в меню "Начало работы ", чтобы создать модель.

Снимок экрана: начало работы с меню тонкой настройки в Foundry.

  1. Нажмите кнопку "Обучение модели" ➕ в окне "Обучение модели ".

    Снимок экрана кнопки

  2. Заполните форму " Выбрать режим" , выполнив поле "Имя модели " и выбрав режим обучения. В этом кратком руководстве выберите бесплатный стандартный режим обучения . Дополнительные сведения см. в режимахобучения.

  3. Выберите версию обучения в раскрывающемся меню, а затем нажмите кнопку "Далее ".

  4. Проверьте выбранные параметры в окне проверки , а затем нажмите кнопку "Создать "

    Скриншот окна выбора проверки в Foundry.

Разверните вашу модель

Как правило, после обучения модели просмотрите его сведения об оценке. В этом кратком руководстве вы можете просто развернуть модель и сделать ее доступной для тестирования на языковой площадке Azure или путем вызова API прогнозирования. Однако, если вы хотите, вы можете воспользоваться моментом, чтобы выбрать "Оценить модель " в меню слева и просмотреть подробные данные телеметрии для модели. Выполните следующие действия, чтобы развернуть модель в Foundry:

  1. Выберите "Развернуть модель " в меню слева.

  2. Затем выберите ➕"Развернуть обученную модель" в окне "Развертывание модели ".

    Снимок экрана окна развертывания вашей модели в Foundry.

  3. Убедитесь, что выбрана кнопка "Создать новое развертывание ".

  4. Выполните развертывание полей окна обученной модели :

    • Создайте имя развертывания.

    • Выберите обученную модель в раскрывающемся меню "Назначить модель ".

    • Выберите подписку в раскрывающемся меню "Подписка ".

    • Выберите регион в раскрывающемся меню "Регион ".

    • Выберите ресурс в раскрывающемся меню "Ресурс ". Ресурс должен находиться в одном регионе развертывания.

      Снимок экрана конфигурации развертывания вашей модели в Foundry.

  5. Наконец, нажмите кнопку "Создать ". Развертывание модели может занять несколько минут.

  6. После успешного развертывания можно просмотреть состояние развертывания модели на странице развертывания модели . Дата окончания срока действия, которая появляется помечает дату, когда развернутая модель становится недоступной для задач прогнозирования. Эта дата обычно составляет 18 месяцев после развертывания конфигурации обучения.

    Снимок экрана: страница состояния успешно развернутой модели в Foundry.

  7. В меню слева перейдите на языковую площадку Azure.
    Игровые площадкиязыковая песочница (Попробуйте песочницу языка Azure).

  8. Выберите карточку распознавания речи беседы.

  9. Окно конфигурации с развернутой моделью должно отображаться в окне main/center.

  10. В текстовом поле введите речевой фрагмент для проверки. Например, если вы использовали пример приложения проекта для речевых фрагментов, связанных с электронной почтой, можно ввести проверку электронной почты.

  11. После ввода тестового текста нажмите кнопку "Выполнить ".

    Снимок экрана: страница состояния успешно развернутой модели в Foundry.

  12. После выполнения теста вы увидите ответ модели в результате.

    Снимок экрана: развернутая проверка моделей на языковой площадке Foundry.

  13. Результаты можно просмотреть в представлении текста или формата JSON.

    Снимок экрана: результаты развернутого теста модели на игровой площадке на языке Foundry.

Это так, поздравляем!

В этой инструкции вы развернули модель CLU и протестировали её на игровой площадке Foundry Language. Далее вы узнаете, как создать собственный проект задачи точной настройки для приложений и рабочих процессов.

Очистка ресурсов

Если проект больше не нужен, его можно удалить из Foundry.

  1. Перейдите на домашнюю страницу Foundry . Инициируйте процесс проверки подлинности, выполнив вход, если вы еще не выполнили этот шаг и сеанс активен.

  2. Выберите проект, который нужно удалить из раздела Keep building with Foundry

  3. Выберите центр управления.

  4. Выберите "Удалить проект".

    Снимок экрана: кнопка

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

  1. Перейдите на вкладку "Обзор " в разделе "Концентратор ".

    Снимок экрана: список сведений о концентраторе в Foundry.

  2. Справа нажмите кнопку "Удалить концентратор".

  3. Ссылка открывает портал Azure для удаления концентратора.

    Снимок экрана кнопки

Предварительные условия

Создание ресурса на портале Azure

  1. Войдите на портал Azure , чтобы создать новый ресурс Azure Language in Foundry Tools.

  2. Выберите Создать ресурс.

  3. В появившемся окне найдите язык.

  4. Нажмите кнопку "Создать".

  5. Создайте ресурс языка со следующими сведениями:

    Сведения об экземпляре Обязательное значение
    Область/регион Один из поддерживаемых регионов для языкового ресурса.
    Имя. Имя, требуемое для языкового ресурса.
    Ценовая категория Одна из допустимых ценовых категорий для ресурса "Язык".

Получите ключи и конечную точку вашего ресурса

  1. Перейдите на страницу обзора ресурса на портале Azure.

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

    Снимок экрана: страница

Импорт нового примера проекта CLU

Создав языковой ресурс, создайте проект по пониманию разговорного языка. Проект — это рабочая область для создания настраиваемых моделей машинного обучения на основе данных. Доступ к используемому языковому ресурсу можно получить только у вас и других пользователей.

В этом кратком руководстве можно скачать этот пример проекта и импортировать его. Этот проект может предсказать предполагаемые команды из входных данных пользователя, такие как чтение сообщений электронной почты, удаление сообщений электронной почты и вложение документа в сообщение электронной почты.

Активация задания проекта импорта

POST Отправьте запрос с помощью следующего URL-адреса, заголовков и текста JSON для импорта проекта.

Запросить URL-адрес

При создании запроса API используйте следующий URL-адрес. Замените значения заполнителей собственными значениями.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение чувствительно к регистру и должно точно соответствовать имени проекта в файле JSON, который вы импортируете. EmailAppDemo
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

Основной текст

Текст JSON, который вы отправляете, аналогичен следующему примеру. Дополнительные сведения об объекте JSON см. в справочной документации.

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "{PROJECT-NAME}",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "intent1"
      },
      {
        "category": "intent2"
      }
    ],
    "entities": [
      {
        "category": "entity1"
      }
    ],
    "utterances": [
      {
        "text": "text1",
        "dataset": "{DATASET}",
        "intent": "intent1",
        "entities": [
          {
            "category": "entity1",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "text2",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "intent": "intent2",
        "entities": []
      }
    ]
  }
}

Ключ Заполнитель Значение Пример
{API-VERSION} Версия вызываемого API. 2023-04-01
projectName {PROJECT-NAME} Имя проекта. Это значение чувствительно к регистру. EmailAppDemo
language {LANGUAGE-CODE} Строка, указывающая языковой код для речевых фрагментов, используемых в проекте. Если проект является многоязычным проектом, выберите языковой код большинства речевых фрагментов. en-us
multilingual true Логическое значение, позволяющее иметь документы на нескольких языках в наборе данных. При развертывании модели можно запрашивать модель на любом поддерживаемом языке, включая языки, которые не включены в учебные документы. true
dataset {DATASET} Сведения о том, как разделить данные между тестовым и обучающим набором, см. в разделе "Метка высказываний" в Foundry. Возможные значения для этого поля: Train и Test. Train

После успешного запроса ответ API содержит заголовок с URL-адресом operation-location , который можно использовать для проверки состояния задания импорта. Заголовок форматируется следующим образом:

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}

Узнать состояние задания импорта

При отправке успешного запроса на импорт проекта полный URL-адрес для проверки состояния задания импорта (включая конечную точку, имя проекта и идентификатор задания) содержится в заголовке ответа operation-location .

Используйте указанный ниже запрос GET, чтобы проверить состояние задания на импорт. Вы можете использовать URL-адрес, полученный на предыдущем шаге, или заменить значения заполнителей собственными значениями.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/import/jobs/{JOB-ID}?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение зависит от регистра. myProject
{JOB-ID} Идентификатор для определения статуса задания импорта. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Описание Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API. {YOUR-PRIMARY-RESOURCE-KEY}

Текст ответа

После отправки запроса вы получите следующий ответ. Продолжайте опрашивать эту конечную точку, пока параметр состояния не изменится на "успешно".

{
  "jobId": "xxxxx-xxxxx-xxxx-xxxxx",
  "createdDateTime": "2022-04-18T15:17:20Z",
  "lastUpdatedDateTime": "2022-04-18T15:17:22Z",
  "expirationDateTime": "2022-04-25T15:17:20Z",
  "status": "succeeded"
}

Начало обучения модели

Как правило, после создания проекта следует создавать схемы и пометить тегами речевые фрагменты. В этом кратком руководстве мы уже импортировали готовый проект со встроенной схемой и помеченными речевыми фрагментами.

Создайте запрос POST, используя указанный ниже URL-адрес, заголовки и текст JSON, чтобы запустить задание обучения.

Запросить URL-адрес

При создании запроса API используйте следующий URL-адрес. Замените значения заполнителей собственными значениями.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:train?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение зависит от регистра. EmailApp
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

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

Используйте в запросе следующий объект. Модель будет названа в честь значения, которое вы используете для параметра modelLabel, после завершения обучения.

{
  "modelLabel": "{MODEL-NAME}",
  "trainingMode": "{TRAINING-MODE}",
  "trainingConfigVersion": "{CONFIG-VERSION}",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}
Ключ Заполнитель Значение Пример
modelLabel {MODEL-NAME} Имя модели. Model1
trainingConfigVersion {CONFIG-VERSION} Версия модели конфигурации обучения. По умолчанию используется последняя версия модели. 2022-05-01
trainingMode {TRAINING-MODE} Используемый режим обучения. Поддерживаемые режимы — это Стандартное обучение (ускоренное обучение, доступное только на английском языке) и Расширенное обучение (поддерживающее другие языки и многоязычные проекты, но предусматривающее более длительное время обучения). Узнайте больше о режимах обучения. standard
kind percentage Методы разделения. Возможные значения: percentage и manual. Дополнительные сведения см. в статье об обучении модели. percentage
trainingSplitPercentage 80 Процент ваших данных с тегами, которые будут включены в обучающий набор. Рекомендуемое значение — 80. 80
testingSplitPercentage 20 Процент помеченных тегами данных, которые будут включены в набор для тестирования. Рекомендуемое значение — 20. 20

Примечание.

trainingSplitPercentage и testingSplitPercentage требуются только в том случае, если для Kind задано значение percentage, а сумма процентных значений должна быть равна 100.

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

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}

Этот URL-адрес позволяет получить текущее состояние задания обучения.

Получение состояния задания обучения

Обучение может занять время , иногда от 10 до 30 минут. Следующий запрос можно использовать для проверки состояния задания обучения до тех пор, пока он не завершится успешно.

При отправке успешного запроса на обучение полный URL-адрес запроса для проверки состояния задания (включая конечную точку, имя проекта и идентификатор задания) содержится в заголовке ответа operation-location .

Используйте следующий запрос GET, чтобы получить состояние хода обучения модели. Замените значения заполнителей собственными значениями.

Запросить URL-адрес

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}
Заполнитель Значение Пример
{YOUR-ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение зависит от регистра. EmailApp
{JOB-ID} Идентификатор для определения состояния обучения модели. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

Текст ответа

После отправки запроса вы получите следующий ответ. Продолжайте опрос этой конечной точки до тех пор, пока значение параметра Состояние не изменится на "Выполнено".

{
  "result": {
    "modelLabel": "{MODEL-LABEL}",
    "trainingConfigVersion": "{TRAINING-CONFIG-VERSION}",
    "trainingMode": "{TRAINING-MODE}",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "xxxxx-xxxxx-xxxx-xxxxx-xxxx",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}
Ключ Значение Пример
modelLabel имя модели; Model1
trainingConfigVersion Версия настройки тренировочной программы. По умолчанию используется последняя версия. 2022-05-01
trainingMode Выбранный режим обучения. standard
startDateTime Время начала обучения 2022-04-14T10:23:04.2598544Z
status Состояние задачи обучения. running
estimatedEndDateTime Предполагаемое время завершения задания обучения. 2022-04-14T10:29:38.2598544Z
jobId Идентификатор задания обучения. xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
createdDateTime Дата и время создания задачи обучения. 2022-04-14T10:22:42Z
lastUpdatedDateTime Дата и время последнего обновления задания обучения 2022-04-14T10:23:45Z
expirationDateTime Дата и время истечения задания обучения 2022-04-14T10:22:42Z

Разверните вашу модель

Как правило, после обучения модели вы изучаете сведения о её оценке. В этом кратком руководстве вы развернете модель и вызовите API прогнозирования для запроса результатов.

Отправка задания развертывания

Создайте запрос PUT, используя следующий URL-адрес, заголовки и текст JSON, чтобы начать развертывание модели распознавания разговорной речи.

Запросить URL-адрес

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение зависит от регистра. myProject
{DEPLOYMENT-NAME} Имя, используемое для развертывания. Это значение зависит от регистра. staging
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

Тело запроса

{
  "trainedModelLabel": "{MODEL-NAME}",
}
Ключ Заполнитель Значение Пример
обученнаяМодельМетка {MODEL-NAME} Имя модели, назначенное вашему развертыванию. Назначать можно только успешно обученные модели. Это значение зависит от регистра. myModel

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

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

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

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

При отправке успешного запроса развертывания полный URL-адрес запроса для проверки состояния задания (включая конечную точку, имя проекта и идентификатор задания) содержится в заголовке ответа operation-location .

Используйте указанный ниже запрос GET для запроса состояния задания развертывания. Замените значения заполнителей собственными значениями.

Запросить URL-адрес

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение зависит от регистра. myProject
{DEPLOYMENT-NAME} Имя, используемое для развертывания. Это значение зависит от регистра. staging
{JOB-ID} Идентификатор для определения состояния обучения модели. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

Текст ответа

После отправки запроса вы получите следующий ответ. Продолжайте опрос этой конечной точки до тех пор, пока значение параметра Состояние не изменится на "Выполнено".

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

Модель запроса

Развернутую модель можно начать использовать для прогнозирования с помощью API прогнозирования.

После успешного завершения развертывания можно начать запрашивать у развернутой модели прогнозы.

Создайте запрос POST, используя следующий URL-адрес, заголовки и текст JSON, чтобы начать развертывание модели распознавания разговорной речи.

Запросить URL-адрес

{ENDPOINT}/language/:analyze-conversations?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

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

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "id": "1",
      "participantId": "1",
      "text": "Text 1"
    }
  },
  "parameters": {
    "projectName": "{PROJECT-NAME}",
    "deploymentName": "{DEPLOYMENT-NAME}",
    "stringIndexType": "TextElement_V8"
  }
}
Ключ Заполнитель Значение Пример
participantId {JOB-NAME} "MyJobName
id {JOB-NAME} "MyJobName
text {TEST-UTTERANCE} Речевой фрагмент, для которого требуется предсказать намерение и извлечь сущности. "Read Matt's email
projectName {PROJECT-NAME} Имя проекта. Это значение зависит от регистра. myProject
deploymentName {DEPLOYMENT-NAME} Имя развертывания. Это значение зависит от регистра. staging

После отправки запроса вы получите следующий ответ для прогнозирования.

Текст ответа

{
  "kind": "ConversationResult",
  "result": {
    "query": "Text1",
    "prediction": {
      "topIntent": "inten1",
      "projectKind": "Conversation",
      "intents": [
        {
          "category": "intent1",
          "confidenceScore": 1
        },
        {
          "category": "intent2",
          "confidenceScore": 0
        },
        {
          "category": "intent3",
          "confidenceScore": 0
        }
      ],
      "entities": [
        {
          "category": "entity1",
          "text": "text1",
          "offset": 29,
          "length": 12,
          "confidenceScore": 1
        }
      ]
    }
  }
}
Ключ Пример значения Описание
запрос Прочитай электронное письмо Мэтта текст, отправленный для запроса.
topIntent "Чтение" Прогнозируемое намерение с наивысшей оценкой достоверности.
намерения [] Список всех намерений, которые были спрогнозированы для текста запроса, с оценками их достоверности.
сущности [] массив, содержащий список сущностей, извлеченных из текста запроса.

Ответ API для проекта диалогов

В проекте по работе с диалогами вы получите прогнозы как для намерений, так и для сущностей, присутствующих в проекте.

  • К таким намерениям и сущностям относится оценка доверительного уровня между 0,0 и 1,0, связанная с тем, насколько уверенно модель будет прогнозировать определенный элемент в проекте.
  • Намерение с наибольшей оценкой содержится в собственном параметре.
  • В ответе отображаются только прогнозируемые сущности.
  • Объекты указывают:
    • Текст извлеченной сущности
    • Его начальное расположение, обозначаемое значением смещения
    • Длина текста сущности, обозначенная значением длины.

Очистка ресурсов

Если проект вам больше не нужен, вы можете удалить его с помощью интерфейсов API.

DELETE Создайте запрос, используя следующие URL-адрес, заголовки и текст JSON, чтобы удалить проект понимания разговорного языка.

Запросить URL-адрес

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}
Заполнитель Значение Пример
{ENDPOINT} Конечная точка для проверки подлинности запроса API. https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME} Имя проекта. Это значение чувствительно к регистру. myProject
{API-VERSION} Версия вызываемого API. 2023-04-01

Заголовки

Используйте следующий заголовок для проверки подлинности запроса.

Ключ Значение
Ocp-Apim-Subscription-Key Ключ к вашему ресурсу. Используется для проверки подлинности запросов API.

После отправки запроса API вы получите ответ, указывающий 202 на успех, что означает, что проект был удален.

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