Azure Cognitive Services для службы Языка

Azure Cognitive Service для языка, ранее известный как соединитель "Анализ текста", обнаруживает язык, тональность и многое другое предоставленное вами текст.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Стандарт Все регионы Power Automate
Логические приложения Стандарт Все регионы Logic Apps
Power Apps Стандарт Все регионы Power Apps
Power Automate Стандарт Все регионы Power Automate
Контакт
Имя Microsoft
URL https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
Адрес электронной почты mlapi@microsoft.com
Метаданные соединителя
Publisher Microsoft
Веб-сайт https://azure.microsoft.com/services/cognitive-services/text-analytics/

Замечание

Этот соединитель ранее был известен как Text Analytics или Microsoft Cognitive Services Text Analytics.

Для использования этой интеграции потребуется ресурс Cognitive Service на портале Azure. Вы получите конечную точку и ключ для проверки подлинности приложений. Чтобы сделать подключение, укажите ключ учетной записи, URL-адрес сайта и выберите "Создать подключение". Дополнительные сведения см. в статье об затратах на операции подключения.

Теперь вы готовы начать использовать эту интеграцию.

Подключение с помощью идентификатора Microsoft Entra

Чтобы создать подключения с идентификатором Microsoft Entra, необходимо добавить роль пользователя Cognitive Services в учетную запись для доступа. Чтобы использовать это подключение, необходимо ввести уникальный поддомен, связанный с ресурсом Cognitive Services, в вспомогательные операции.

Операции, не поддерживаемые проверкой подлинности идентификатора Microsoft Entra

При использовании проверки подлинности идентификатора Microsoft Entra id поддерживаются только действия версии 4. Устаревшие действия будут продолжать работать с Access Key проверкой подлинности, но при использовании с подключением идентификатора Microsoft Entra ID завершится ошибкой.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

Ключ API Ключ API (ApiKey) Все регионы Доступный для общего пользования
По умолчанию [не рекомендуется] Этот параметр предназначен только для старых подключений без явного типа проверки подлинности и предоставляется только для обратной совместимости. Все регионы Недоступен для совместного использования

Ключ API

Идентификатор проверки подлинности: keyBasedAuth

Применимо: все регионы

Ключ API (ApiKey)

Это совместное подключение. Если приложение power app предоставлено другому пользователю, подключение также предоставляется совместно. Дополнительные сведения см. в обзоре соединителей для приложений на основе холста — Power Apps | Документация Майкрософт

Имя Тип Description Обязательно
Ключ учетной записи securestring Ключ учетной записи Cognitive Services True
URL-адрес сайта струна URL-адрес корневого сайта (пример: https://westus.api.cognitive.microsoft.com)

По умолчанию [не рекомендуется]

Применимо: все регионы

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

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ учетной записи securestring Ключ учетной записи Cognitive Services True
URL-адрес сайта струна URL-адрес корневого сайта (пример: https://westus.api.cognitive.microsoft.com). Если это не указано, url-адрес сайта по умолчанию будет иметь значение https://westus.api.cognitive.microsoft.com.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 1200 60 секунд

Действия

Async AbstractiveSummarization (2022-10-01-preview)

Отправка коллекции текстовых документов для абстрактной суммирования

Async Conversation PII (text) (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Async Conversation PII (транскрибирование) (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Async CustomEntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания пользовательских сущностей.

Async CustomMultiLabelClassification (2022-05-01)

Отправьте коллекцию текстовых документов для пользовательского анализа классификации.

Async CustomSingleLabelClassification (2022-05-01)

Отправьте коллекцию текстовых документов для пользовательского анализа классификации.

Async EntityLinking (2022-05-01)

Отправьте коллекцию текстовых документов для анализа связывания сущностей.

Async EntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания сущностей.

Async ExtractiveSummarization (2022-10-01-preview)

Отправка коллекции текстовых документов для извлечения сводных данных

Async Healthcare (2022-05-01)

Отправьте коллекцию текстовых документов для анализа здравоохранения.

Async KeyPhrases (2022-05-01)

Отправьте коллекцию текстовых документов для анализа извлечения ключевых фраз.

Async PiiEntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания личных сущностей.

Async SentimentAnalysis (2022-05-01)

Отправьте коллекцию текстовых документов для анализа тональности.

Асинхронная сводка бесед (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Беседы (CLU) (2022-05-01)

Анализирует речевой фрагмент входной беседы.

Беседы (оркестрация) (2022-05-01)

Анализирует речевой фрагмент входной беседы.

Ключевые фразы (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Ключевые фразы (версия 3.0)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Ключевые фразы (версия 3.1) (предварительная версия)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Ключевые фразы (версия 4) (предварительная версия)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Ключевые фразы [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Ключевые фразы [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Обнаружение персональных данных (версия 3.1)

API возвращает список сущностей с личными данными ("SSN", "Банковский счет" и т. д.) в документе. В списке поддерживаемых типов сущностей проверьте категории поддерживаемых личных сведений (PII). Список поддерживаемых языков см. в поддерживаемых языках в Службе Cognitive Service Azure для языка .

Обнаружение персональных данных (версия 4) (предварительная версия)

API возвращает список сущностей с личными данными ("SSN", "Банковский счет" и т. д.) в документе. В списке поддерживаемых типов сущностей проверьте категории поддерживаемых личных сведений (PII). Список поддерживаемых языков см. в поддерживаемых языках в Службе Cognitive Service Azure для языка .

Обнаружение сущностей (версия 2) [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте распознавание именованных сущностей (V4 ).

Возвращает список известных сущностей и общих именованных сущностей ("Person", "Location", "Organization" и т. д.) в данном документе.

Обнаружение тональности (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1 для каждого документа. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная.

Обнаружение тональности [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная. В настоящее время поддерживаются следующие языки: английский, испанский, французский, португальский.

Обнаружение тональности [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная.

Обнаружение языка (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1 для каждого документа. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Обнаружение языка [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Обнаружение языка [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Определение языка (версия 3.0)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Определение языка (версия 3.1) (предварительная версия)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Определение языка (версия 4) (предварительная версия)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Распознавание именованных сущностей (версия 3.0)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Распознавание именованных сущностей (версия 3.1) (предварительная версия)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Распознавание именованных сущностей (версия 4) (предварительная версия)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Связывание сущностей (V4) (предварительная версия)

API возвращает список распознанных сущностей со ссылками на хорошо известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Связывание сущностей (версия 3.0)

API возвращает список распознанных сущностей со ссылками на известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Связывание сущностей (версия 3.1) (предварительная версия)

API возвращает список распознанных сущностей со ссылками на хорошо известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Создание ответа из Project

Это действие помогает ответить на указанный вопрос с помощью базы знаний в проекте.

Сущности [не рекомендуется]

Это действие устарело. Вместо этого используйте распознавание именованных сущностей (V4 ).

Возвращает список известных сущностей и общих именованных сущностей ("Person", "Location", "Organization" и т. д.) в данном документе.

Тональность (V4) (предварительная версия)

API возвращает подробный анализ тональности для входного текста. Анализ выполняется на нескольких уровнях детализации, начиная с уровня документа, вплоть до предложений и ключевых терминов (целевых объектов и оценок).

Тональность (версия 3.0)

API возвращает прогноз тональности, а также оценки тональности для каждого класса тональности (положительный, отрицательный и нейтральный) для документа и каждого предложения в нем. Ознакомьтесь с поддержкой языка анализа тональности и интеллектуального анализа мнений для списка поддерживаемых языков.

Тональность (версия 3.1) (предварительная версия)

API возвращает подробный анализ тональности для входного текста. Анализ выполняется на нескольких уровнях детализации, начиная с уровня документа, вплоть до предложений и ключевых терминов (целевых объектов и оценок).

Async AbstractiveSummarization (2022-10-01-preview)

Отправка коллекции текстовых документов для абстрактной суммирования

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

предложениеCount
sentenceCount integer

Он определяет приблизительное количество предложений в выходных сводках.

Возвращаемое значение

Async Conversation PII (text) (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Идентификатор элемента беседы.

идентификатор участника
participantId True string

Идентификатор участника элемента беседы.

language
language string

Переопределение языка элемента беседы в представлении языка BCP 47.

роль
role string

Роль участника.

текст
text True string

Ввод текста

language
language True string

Язык элемента беседы в формате BCP-47.

domain
domain string

Перечисление поддерживаемых диалоговых доменов.

loggingOptOut
loggingOptOut boolean
PiiCategories
piiCategories array of string

Описывает категории piI, возвращаемые для обнаружения. Если это не указано, будут возвращены категории по умолчанию, которые будут отличаться от языка.

Возвращаемое значение

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Async Conversation PII (транскрибирование) (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Идентификатор элемента беседы.

идентификатор участника
participantId True string

Идентификатор участника элемента беседы.

language
language string

Переопределение языка элемента беседы в представлении языка BCP 47.

роль
role string

Роль участника.

itn
itn string

Обратное нормализация текста представления входных данных. Инверсно-нормализованная форма — это распознанный текст из API распознавания речи Майкрософт в текст, с номерами телефонов, цифрами, сокращенными и другими преобразованиями.

maskedItn
maskedItn string

Обратный формат нормализованного текста с применением маскирования ненормативной лексики.

текст
text string

Отображаемая форма распознанного текста из речи в API текста с добавлением пунктуации и заглавной буквы.

лексический
lexical string

Лексическая форма распознанного текста из речи в API текста с фактическими распознаваемыми словами.

word
word string

Слово распознано.

offset
offset integer

Смещение с начала звука речи в галочки. 1 галочку = 100 ns.

duration
duration integer

Длительность артефакта слова в тиках. 1 галочку = 100 ns.

language
language True string

Язык элемента беседы в формате BCP-47.

domain
domain string

Перечисление поддерживаемых диалоговых доменов.

loggingOptOut
loggingOptOut boolean
PiiCategories
piiCategories array of string

Описывает категории piI, возвращаемые для обнаружения. Если это не указано, будут возвращены категории по умолчанию, которые будут отличаться от языка.

includeAudioRedaction
includeAudioRedaction boolean

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

redactionSource
redactionSource string

Перечисление поддерживаемых типов контента расшифровки.

Возвращаемое значение

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Async CustomEntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания пользовательских сущностей.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

имя проекта
projectName True string

Это поле указывает имя проекта для модели.

имя_развертывания
deploymentName True string

Это поле указывает имя развертывания для модели.

Возвращаемое значение

Async CustomMultiLabelClassification (2022-05-01)

Отправьте коллекцию текстовых документов для пользовательского анализа классификации.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

имя проекта
projectName True string

Это поле указывает имя проекта для модели.

имя_развертывания
deploymentName True string

Это поле указывает имя развертывания для модели.

Возвращаемое значение

Async CustomSingleLabelClassification (2022-05-01)

Отправьте коллекцию текстовых документов для пользовательского анализа классификации.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

имя проекта
projectName True string

Это поле указывает имя проекта для модели.

имя_развертывания
deploymentName True string

Это поле указывает имя развертывания для модели.

Возвращаемое значение

Async EntityLinking (2022-05-01)

Отправьте коллекцию текстовых документов для анализа связывания сущностей.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Async EntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания сущностей.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Async ExtractiveSummarization (2022-10-01-preview)

Отправка коллекции текстовых документов для извлечения сводных данных

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

предложениеCount
sentenceCount integer
sortBy
sortBy string

Критерии сортировки, используемые для результатов извлечения суммирования.

Возвращаемое значение

Async Healthcare (2022-05-01)

Отправьте коллекцию текстовых документов для анализа здравоохранения.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Async KeyPhrases (2022-05-01)

Отправьте коллекцию текстовых документов для анализа извлечения ключевых фраз.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

loggingOptOut
loggingOptOut boolean

Возвращаемое значение

Async PiiEntityRecognition (2022-05-01)

Отправьте коллекцию текстовых документов для анализа распознавания личных сущностей.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

domain
domain string

Домен PII, используемый для распознавания сущностей PII.

PiiCategories
piiCategories array of string

(Необязательно) описывает категории piI для возврата

Возвращаемое значение

Async SentimentAnalysis (2022-05-01)

Отправьте коллекцию текстовых документов для анализа тональности.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

opinionMining
opinionMining boolean

Возвращаемое значение

Асинхронная сводка бесед (2022-05-15-preview)

Отправьте коллекцию бесед для анализа. Укажите одну или несколько уникальных задач для выполнения.

Параметры

Имя Ключ Обязательно Тип Описание
id
id True string

Идентификатор элемента беседы.

идентификатор участника
participantId True string

Идентификатор участника элемента беседы.

language
language string

Переопределение языка элемента беседы в представлении языка BCP 47.

роль
role string

Роль участника.

текст
text True string

Ввод текста

language
language True string

Язык элемента беседы в формате BCP-47.

domain
domain string

Перечисление поддерживаемых диалоговых доменов.

loggingOptOut
loggingOptOut boolean
сводкаAspects
summaryAspects True array of string

Возвращаемое значение

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Беседы (CLU) (2022-05-01)

Анализирует речевой фрагмент входной беседы.

Параметры

Имя Ключ Обязательно Тип Описание
language
language string

Переопределение языка элемента беседы в представлении языка BCP 47.

текст
text True string

Ввод текста

имя проекта
projectName True string

Имя используемого проекта.

имя_развертывания
deploymentName True string

Имя используемого развертывания.

verbose
verbose boolean

Если значение true, служба вернет более подробные сведения в ответе.

Возвращаемое значение

Результаты задачи беседы.

Беседы (оркестрация) (2022-05-01)

Анализирует речевой фрагмент входной беседы.

Параметры

Имя Ключ Обязательно Тип Описание
language
language string

Переопределение языка элемента беседы в представлении языка BCP 47.

текст
text True string

Ввод текста

имя проекта
projectName True string

Имя используемого проекта.

имя_развертывания
deploymentName True string

Имя используемого развертывания.

verbose
verbose boolean

Если значение true, служба вернет более подробные сведения в ответе.

directTarget
directTarget string

Имя целевого проекта для пересылки запроса.

targetProjectParameters
targetProjectParameters object

Словарь, представляющий параметры для каждого целевого проекта.

Возвращаемое значение

Результаты задачи беседы.

Ключевые фразы (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True string

Уникальный, непустый идентификатор документа.

Текст
text True string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
KeyPhraseResults

Ключевые фразы (версия 3.0)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

Показать статистику
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня входных данных и документов.

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Ключевые фразы (версия 3.1) (предварительная версия)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
KeyPhraseResult

Ключевые фразы (версия 4) (предварительная версия)

API возвращает список строк, обозначающих ключевые фразы во входном тексте. Сведения о поддержке языка для извлечения ключевых фраз см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
KeyPhraseResult

Ключевые фразы [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
KeyPhraseResult

Ключевые фразы [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте ключевые фразы (V4 ).

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

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
KeyPhraseResult

Обнаружение персональных данных (версия 3.1)

API возвращает список сущностей с личными данными ("SSN", "Банковский счет" и т. д.) в документе. В списке поддерживаемых типов сущностей проверьте категории поддерживаемых личных сведений (PII). Список поддерживаемых языков см. в поддерживаемых языках в Службе Cognitive Service Azure для языка .

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

domain
domain string

(Необязательно) если указано, присвойте домену PII только подмножество категорий сущностей. Возможные значения включают: PHI, none.

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

PiiCategories
piiCategories array

(Необязательно) описывает категории piI для возврата

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
PiiResult

Обнаружение персональных данных (версия 4) (предварительная версия)

API возвращает список сущностей с личными данными ("SSN", "Банковский счет" и т. д.) в документе. В списке поддерживаемых типов сущностей проверьте категории поддерживаемых личных сведений (PII). Список поддерживаемых языков см. в поддерживаемых языках в Службе Cognitive Service Azure для языка .

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

domain
domain string

(Необязательно) если указано, присвойте домену PII только подмножество категорий сущностей. Возможные значения включают: PHI, none.

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

PiiCategories
piiCategories array

(Необязательно) описывает категории piI для возврата

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
PiiResult

Обнаружение сущностей (версия 2) [НЕ РЕКОМЕНДУЕТСЯ]

Это действие устарело. Вместо этого используйте распознавание именованных сущностей (V4 ).

Возвращает список известных сущностей и общих именованных сущностей ("Person", "Location", "Organization" и т. д.) в данном документе.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True string

Уникальный, непустый идентификатор документа.

Текст
text True string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
EntitiesResults

Обнаружение тональности (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1 для каждого документа. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True string

Уникальный, непустый идентификатор документа.

Текст
text True string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
SentimentResults

Обнаружение тональности [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная. В настоящее время поддерживаются следующие языки: английский, испанский, французский, португальский.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
SentimentResult

Обнаружение тональности [не рекомендуется]

Это действие устарело. Вместо этого используйте тональность (V4 ).

Возвращает числовую оценку от 0 до 1. Если оценка близка к 1, у текста положительная тональность, а если к 0 — отрицательная.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
SentimentResult

Обнаружение языка (версия 2) [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1 для каждого документа. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True string

Уникальный, непустый идентификатор документа.

Текст
text True string

Текст для анализа.

Возвращаемое значение

Тело
LanguageResults

Обнаружение языка [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Количество языков
numberOfLanguagesToDetect integer

Число языков для обнаружения. Установите значение 1 по умолчанию.

Возвращаемое значение

Тело
LanguageResult

Обнаружение языка [не рекомендуется]

Это действие устарело. Вместо этого используйте язык обнаружения (V4 ).

Возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Поддерживаются в общей сложности 120 языков.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Возвращаемое значение

Тело
LanguageResult

Определение языка (версия 3.0)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

Показать статистику
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня входных данных и документов.

id
id True string

Уникальный, непустый идентификатор документа.

текст
text True string
countryHint
countryHint string

Возвращаемое значение

Тело
LanguageResultV3

Определение языка (версия 3.1) (предварительная версия)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

id
id True string

Уникальный, непустый идентификатор документа.

текст
text True string
countryHint
countryHint string

Возвращаемое значение

Тело
LanguageResult

Определение языка (версия 4) (предварительная версия)

API возвращает обнаруженный язык и числовую оценку от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true. Сведения о поддержке языков для обнаружения языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

id
id True string

Уникальный, непустый идентификатор документа.

текст
text True string
countryHint
countryHint string

Возвращаемое значение

Тело
LanguageResult

Распознавание именованных сущностей (версия 3.0)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Параметры

Имя Ключ Обязательно Тип Описание
Версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

Показать статистику
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня входных данных и документов.

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
EntitiesResultV3

Распознавание именованных сущностей (версия 3.1) (предварительная версия)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
EntitiesResult

Распознавание именованных сущностей (версия 4) (предварительная версия)

API возвращает список общих именованных сущностей в данном документе. Список поддерживаемых типов сущностей см. в категории поддерживаемых именованных сущностей распознавания именованных сущностей (NER).

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тело
EntitiesResult

Связывание сущностей (V4) (предварительная версия)

API возвращает список распознанных сущностей со ссылками на хорошо известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Связывание сущностей (версия 3.0)

API возвращает список распознанных сущностей со ссылками на известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

Показать статистику
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня входных данных и документов.

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Связывание сущностей (версия 3.1) (предварительная версия)

API возвращает список распознанных сущностей со ссылками на хорошо известную базу знаний. Сведения о поддержке языков см. в списке поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Создание ответа из Project

Это действие помогает ответить на указанный вопрос с помощью базы знаний в проекте.

Параметры

Имя Ключ Обязательно Тип Описание
Имя проекта
projectName True string

Это имя проекта, которое вы хотите использовать.

Question
question string

Вопрос пользователя к запросу к проекту.

Идентификатор пользователя
userId string

Уникальный идентификатор пользователя.

Вверх #
top integer

Максимальное количество ответов, возвращаемых для вопроса.

Порог достоверности
confidenceScoreThreshold float

Минимальная оценка порогового значения для ответов. Диапазоны значений от 0 до 1.

Тип Ранкера
rankerType string

Тип используемого ранга.

Идентификатор QnA
qnaId string

Это точный идентификатор QnA для получения из проекта.

Предыдущий идентификатор QnA
previousQnaId integer

Предыдущий поворот верхнего ответа результирующий идентификатор QnA.

Предыдущий запрос пользователя
previousUserQuery string

Предыдущий запрос пользователя.

key
key string

Ключ метаданных из словаря метаданных, используемый в QnA.

value
value string

Значение метаданных из словаря метаданных, используемого в QnA.

Присоединение метаданных с помощью
logicalOperation string

Задайте значение OR или AND для соответствующих логических операций для фильтров метаданных.

Исходный фильтр
sourceFilter string

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

Присоединение фильтров с помощью
logicalOperation string

Логическая операция, используемая для объединения фильтра метаданных с исходным фильтром.

Включение точного ответа
enable boolean

Включение или отключение прогнозирования диапазона ответов.

Порог достоверности
confidenceScoreThreshold float

Минимальная оценка порогового значения, требуемая для включения точного ответа, диапазон значений составляет от 0 до 1.

Вверх #
topAnswersWithSpan integer

Число лучших ответов, которые следует учитывать для точного прогнозирования ответов от 1 до 10.

Включение неструктурированных источников
includeUnstructuredSources boolean

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

Название развертывания
deploymentName True string

Это конкретное развертывание проекта, который вы хотите использовать.

Версия API
api-version True string

Это версия клиентского API.

Возвращаемое значение

Представляет список ответов на вопросы.

Тело
AnswersResult

Сущности [не рекомендуется]

Это действие устарело. Вместо этого используйте распознавание именованных сущностей (V4 ).

Возвращает список известных сущностей и общих именованных сущностей ("Person", "Location", "Organization" и т. д.) в данном документе.

Параметры

Имя Ключ Обязательно Тип Описание
Текст
text string

Текст для анализа.

Language
language string

Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д.,

Возвращаемое значение

Тело
EntitiesResult

Тональность (V4) (предварительная версия)

API возвращает подробный анализ тональности для входного текста. Анализ выполняется на нескольких уровнях детализации, начиная с уровня документа, вплоть до предложений и ключевых терминов (целевых объектов и оценок).

Параметры

Имя Ключ Обязательно Тип Описание
Поддомен ресурсов или регион
subdomain True string

Поддомен Azure или географический регион (например, westus)

версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

opinionMining
opinionMining boolean

(Необязательно) если задано значение true, ответ будет содержать не только результаты прогнозирования тональности, но и анализа мнений (анализ тональности на основе аспектов).

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тональность (версия 3.0)

API возвращает прогноз тональности, а также оценки тональности для каждого класса тональности (положительный, отрицательный и нейтральный) для документа и каждого предложения в нем. Ознакомьтесь с поддержкой языка анализа тональности и интеллектуального анализа мнений для списка поддерживаемых языков.

Параметры

Имя Ключ Обязательно Тип Описание
Версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

Показать статистику
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня входных данных и документов.

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Тональность (версия 3.1) (предварительная версия)

API возвращает подробный анализ тональности для входного текста. Анализ выполняется на нескольких уровнях детализации, начиная с уровня документа, вплоть до предложений и ключевых терминов (целевых объектов и оценок).

Параметры

Имя Ключ Обязательно Тип Описание
версия модели
model-version string

(Необязательно) Это значение указывает, какая модель будет использоваться для оценки. Если версия модели не указана, API должен по умолчанию использовать последнюю, не предварительную версию.

showStats
showStats boolean

(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

loggingOptOut
loggingOptOut boolean

(Необязательно) Если задано значение true, вы откажетесь от записи ввода текста для устранения неполадок. По умолчанию Служба Azure Cognitive Service для языка регистрирует входной текст в течение 48 часов, чтобы разрешить устранение неполадок при предоставлении функций обработки естественного языка Azure Cognitive Service для языка. Если этот параметр имеет значение true, отключает входное ведение журнала и может ограничить возможность устранения проблем, возникающих. Дополнительные сведения см. в https://aka.ms/cs-compliance заметках о соответствии и конфиденциальности Cognitive Services, а также принципы ответственного искусственного интеллекта Майкрософт.https://www.microsoft.com/en-us/ai/responsible-ai

opinionMining
opinionMining boolean

(Необязательно) если задано значение true, ответ будет содержать не только результаты прогнозирования тональности, но и анализа мнений (анализ тональности на основе аспектов).

stringIndexType
stringIndexType string

(Необязательно) Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets

id
id True string

Уникальный непустый идентификатор документа.

текст
text True string

Входной текст для обработки.

language
language string

(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.

Возвращаемое значение

Определения

ConversationalPIITranscriptJobState

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Имя Путь Тип Описание
отображаемое имя
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
статус
status string
Ошибки
errors array of Error
nextLink
nextLink string
статистика
statistics ConversationRequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

завершено
tasks.completed integer

Количество задач успешно завершено.

ошибка
tasks.failed integer

Количество задач, которые завершилися сбоем.

inProgress
tasks.inProgress integer

Количество выполняемых в настоящее время задач.

итог
tasks.total integer

Общее количество задач, отправленных в рамках задания.

taskResult
tasks.taskResult ConversationalPIITranscriptResult

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

ConversationRequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

Имя Путь Тип Описание
documentsCount
documentsCount integer

Количество документов, отправленных в запросе.

validDocumentsCount
validDocumentsCount integer

Количество допустимых документов. Это исключает пустые, слишком многоуровневые или не поддерживаемые документы языков.

ошибкаDocumentsCount
erroneousDocumentsCount integer

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

transactionsCount
transactionsCount integer

Количество транзакций для запроса.

conversationsCount
conversationsCount integer

Количество бесед, отправленных в запросе.

validConversationsCount
validConversationsCount integer

Количество документов бесед. Это исключает пустые, слишком многоуровневые или не поддерживаемые документы языков.

ошибкаConversationsCount
erroneousConversationsCount integer

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

ConversationalPIITranscriptResult

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

Имя Путь Тип Описание
lastUpdateDateTime
lastUpdateDateTime date-time

Последнее обновление времени в формате UTC для задачи.

статус
status

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

имя задачи
taskName string
добрый
kind ConversationalPIIResultsKind

Перечисление поддерживаемых результатов задачи анализа бесед.

results
results ConversationPIITranscriptResults

Результат операции обнаружения и редактирования piI для каждой беседы.

ConversationalPIIResultsKind

Перечисление поддерживаемых результатов задачи анализа бесед.

ConversationPIITranscriptResults

Результат операции обнаружения и редактирования piI для каждой беседы.

Имя Путь Тип Описание
conversationItems
conversations.conversationItems array of ConversationPIITranscriptItemResult

Перечисление результатов операций обнаружения и редактирования piI для всех элементов беседы в беседе.

id
conversations.id string

Уникальный, непустый идентификатор беседы.

Предупреждения
conversations.warnings array of InputWarning

Предупреждения, возникающие при обработке документа.

статистика
conversations.statistics ConversationStatistics

Если значение showStats=true указано в запросе, это поле будет содержать сведения о полезных данных беседы.

Ошибки
errors array of InputError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

InputError

Содержит сведения об ошибках, возникающих во время выполнения задания.

Имя Путь Тип Описание
id
id string

Идентификатор входных данных.

ошибка
error Error

Объект ошибки.

InputWarning

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

Имя Путь Тип Описание
код
code string

Код предупреждения.

сообщение
message string

Предупреждение.

targetRef
targetRef string

Ссылка указателя JSON, указывающая целевой объект.

ConversationStatistics

Если значение showStats=true указано в запросе, это поле будет содержать сведения о полезных данных беседы.

Имя Путь Тип Описание
transactionsCount
transactionsCount integer

Количество текстовых единиц для запроса.

ConversationPIITranscriptItemResult

Имя Путь Тип Описание
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTranscriptContent

Ответ на содержимое расшифровки, созданный службой, со всеми необходимыми персональными данными, редактируемыми.

entities
entities array of Entity

ConversationalPIITranscriptRedactedTranscriptContent

Ответ на содержимое расшифровки, созданный службой, со всеми необходимыми персональными данными, редактируемыми.

Имя Путь Тип Описание
itn
itn string

Отредактированные выходные данные для ввода обратного текста нормализованного формата.

maskedItn
maskedItn string

Отредактированные выходные данные для вставленного обратного текста нормализованных входных данных формата.

текст
text string

Отредактированные выходные данные для ввода текста (речь Майкрософт по тексту "display").

лексический
lexical string

Отредактированные выходные данные для лексических входных данных формата.

audioTimings
audioTimings array of AudioTiming

Список отредактированных сегментов звука.

AudioTiming

Сведения о времени звука.

Имя Путь Тип Описание
offset
offset integer

Смещение с начала звука речи в галочки. 1 галочку = 100 ns.

duration
duration integer

Длительность артефакта слова в тиках. 1 галочку = 100 ns.

ConversationalPIITextJobState

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Имя Путь Тип Описание
отображаемое имя
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
статус
status string
Ошибки
errors array of Error
nextLink
nextLink string
статистика
statistics ConversationRequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

завершено
tasks.completed integer

Количество задач успешно завершено.

ошибка
tasks.failed integer

Количество задач, которые завершилися сбоем.

inProgress
tasks.inProgress integer

Количество выполняемых в настоящее время задач.

итог
tasks.total integer

Общее количество задач, отправленных в рамках задания.

taskResult
tasks.taskResult ConversationalPIITextResult

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

ConversationalPIITextResult

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

Имя Путь Тип Описание
lastUpdateDateTime
lastUpdateDateTime date-time

Последнее обновление времени в формате UTC для задачи.

статус
status

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

имя задачи
taskName string
добрый
kind ConversationalPIIResultsKind

Перечисление поддерживаемых результатов задачи анализа бесед.

results
results ConversationPIITextResults

Результат операции обнаружения и редактирования piI для каждой беседы.

ConversationPIITextResults

Результат операции обнаружения и редактирования piI для каждой беседы.

Имя Путь Тип Описание
conversationItems
conversations.conversationItems array of ConversationPIITextItemResult

Перечисление результатов операций обнаружения и редактирования piI для всех элементов беседы в беседе.

id
conversations.id string

Уникальный, непустый идентификатор беседы.

Предупреждения
conversations.warnings array of InputWarning

Предупреждения, возникающие при обработке документа.

статистика
conversations.statistics ConversationStatistics

Если значение showStats=true указано в запросе, это поле будет содержать сведения о полезных данных беседы.

Ошибки
errors array of InputError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

ConversationPIITextItemResult

Имя Путь Тип Описание
id
id string
redactedContent
redactedContent ConversationalPIITranscriptRedactedTextContent

Ответ на содержимое расшифровки, созданный службой, со всеми необходимыми персональными данными, редактируемыми.

entities
entities array of Entity

ConversationalPIITranscriptRedactedTextContent

Ответ на содержимое расшифровки, созданный службой, со всеми необходимыми персональными данными, редактируемыми.

Имя Путь Тип Описание
текст
text string

Отредактированные выходные данные для ввода текста (речь Майкрософт по тексту "display").

АнализConversationSummarizationJobState

Содержит состояние задания анализа бесед, отправленного вместе со связанной статистикой.

Имя Путь Тип Описание
отображаемое имя
displayName string
createdDateTime
createdDateTime date-time
expirationDateTime
expirationDateTime date-time
jobId
jobId string
lastUpdatedDateTime
lastUpdatedDateTime date-time
статус
status string
Ошибки
errors array of Error
nextLink
nextLink string
статистика
statistics ConversationRequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

завершено
tasks.completed integer

Количество задач успешно завершено.

ошибка
tasks.failed integer

Количество задач, которые завершилися сбоем.

inProgress
tasks.inProgress integer

Количество выполняемых в настоящее время задач.

итог
tasks.total integer

Общее количество задач, отправленных в рамках задания.

taskResult
tasks.taskResult AnalyzeConversationSummarizationResult

Результат задачи суммирования для беседы.

AnalyzeConversationSummarizationResult

Результат задачи суммирования для беседы.

Имя Путь Тип Описание
lastUpdateDateTime
lastUpdateDateTime date-time

Последнее обновление времени в формате UTC для задачи.

статус
status

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

имя задачи
taskName string
добрый
kind ConversationalSummarizationResultsKind

Перечисление поддерживаемых результатов задачи анализа бесед.

results
results SummaryResult

ConversationalSummarizationResultsKind

Перечисление поддерживаемых результатов задачи анализа бесед.

СводкаResult

Имя Путь Тип Описание
summaries
conversations.summaries array of SummaryResultItem
id
conversations.id string

Уникальный, непустый идентификатор беседы.

Предупреждения
conversations.warnings array of InputWarning

Предупреждения, возникающие при обработке документа.

статистика
conversations.statistics ConversationStatistics

Если значение showStats=true указано в запросе, это поле будет содержать сведения о полезных данных беседы.

Ошибки
errors array of InputError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

SummaryResultItem

Имя Путь Тип Описание
аспект
aspect string
текст
text string

Ошибка

Объект ошибки.

Имя Путь Тип Описание
код
code ErrorCode

Код ошибки, доступный для чтения человеком.

сообщение
message string

Читаемое пользователем представление ошибки.

target
target string

Целевой объект ошибки.

details
details array of Error

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.

innererror
innererror InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ErrorCode

Код ошибки, доступный для чтения человеком.

Код ошибки, доступный для чтения человеком.

InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя Путь Тип Описание
код
code InnerErrorCode

Код ошибки, доступный для чтения человеком.

сообщение
message string

Сообщение об ошибке.

details
details object

Сведения об ошибке.

target
target string

Целевой объект ошибки.

innererror
innererror InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

КодВнутреннейОшибки

Код ошибки, доступный для чтения человеком.

Код ошибки, доступный для чтения человеком.

LanguageCustomEntitiesResult

Имя Путь Тип Описание
Документы
documents array of LanguageEntitiesDocumentResult

Ответ по документу

LanguageCustomLabelClassificationResult

Имя Путь Тип Описание
Документы
documents array of LanguageClassificationDocumentResult

Ответ по документу

LanguageClassificationResult

Имя Путь Тип Описание
категория
category string

Тип классификации.

confidenceScore
confidenceScore double

Оценка достоверности от 0 до 1 распознанного класса.

LanguageClassificationDocumentResult

Имя Путь Тип Описание
класс
class array of LanguageClassificationResult
id
id string

Уникальный, непустый идентификатор документа.

LanguageHealthcareResult

Имя Путь Тип Описание
Документы
documents array of LanguageHealthcareEntitiesDocumentResult

LanguageHealthcareEntitiesDocumentResult

Имя Путь Тип Описание
entities
entities array of LanguageHealthcareEntity

Сущности здравоохранения.

relations
relations array of LanguageHealthcareRelation

Отношения сущностей здравоохранения.

id
id string

Уникальный, непустый идентификатор документа.

LanguageHealthcareEntity

Имя Путь Тип Описание
текст
text string

Текст сущности, как показано в запросе.

категория
category string

Категория сущностей здравоохранения.

Подкатегория
subcategory string

(Необязательно) Подтип сущности.

offset
offset integer

Начальная позиция для текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.

length
length integer

Длина текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемую длину.

confidenceScore
confidenceScore double

Оценка достоверности от 0 до 1 извлеченной сущности.

assertion
assertion LanguageHealthcareAssertion
имя
name string

Предпочтительное имя сущности. Пример: "гистологично" будет иметь "имя" "гистологического".

links
links array of LanguageHealthcareEntityLink

Ссылки на сущности в известных источниках данных.

LanguageHealthcareRelation

Каждое отношение — это граф сущности определенного типа отношения, где все сущности подключены и имеют определенные роли в контексте отношения.

Имя Путь Тип Описание
relationType
relationType string

Тип отношения. Примеры включают: DosageOfMedication или FrequencyOfMedication, и т. д.

entities
entities array of LanguageHealthcareRelationEntity

Сущности в связи.

LanguageHealthcareAssertion

Имя Путь Тип Описание
условность
conditionality string

Описывает любую условность сущности.

уверенность
certainty string

Описывает определенные сущности и полярность.

ассоциация
association string

Описывает, является ли сущность предметом текста или если он описывает другого пользователя.

LanguageHealthcareRelationEntity

Имя Путь Тип Описание
ref
ref string

Объект ссылок, использующий указатель JSON RFC 6901 (представление идентификатора фрагмента URI), указывающий на сущность.

роль
role string

Роль сущности в связи. Например: CD20-положительный диффузный большой лимфома B-клеток имеет следующие сущности со своими ролями в скобках: CD20 (GeneOrProtein), Положительный (выражение), диффузная большая лимфома B-клеток (диагностика).

Имя Путь Тип Описание
dataSource
dataSource string

Каталог сущностей. Примеры: UMLS, CHV, MSH и т. д.

id
id string

Идентификатор сущности в указанном исходном каталоге.

LanguageSentimentResponse

Имя Путь Тип Описание
Документы
documents array of LanguageSentimentDocumentResult

Анализ тональности на документ.

LanguageSentimentDocumentResult

Имя Путь Тип Описание
настроение
sentiment string

Прогнозируемые тональности для документа (отрицательные, нейтральные, положительные или смешанные).

confidenceScores
confidenceScores LanguageSentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Предложения
sentences array of LanguageSentenceSentiment

Анализ тональности на уровне предложения.

id
id string

Уникальный, непустый идентификатор документа.

LanguageSentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Имя Путь Тип Описание
Положительная
positive double

Оценка достоверности для положительной тональности

нейтральный
neutral double

Оценка достоверности для нейтральной тональности

Отрицательная
negative double

Оценка достоверности для отрицательной тональности

LanguageSentenceSentiment

Имя Путь Тип Описание
текст
text string

Текст предложения.

настроение
sentiment string

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

confidenceScores
confidenceScores LanguageSentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

offset
offset integer

Смещение предложения от начала документа.

length
length integer

Длина предложения.

targets
targets array of LanguageSentenceTarget

Массив предложений, предназначенный для предложения.

assessments
assessments array of LanguageSentenceAssessment

Массив оценок для предложения.

LanguageSentenceTarget

Имя Путь Тип Описание
настроение
sentiment string

Целевое тональность в предложении.

confidenceScores
confidenceScores LanguageTargetConfidenceScoreLabel

Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.

offset
offset integer

Целевое смещение от начала предложения.

length
length integer

Длина целевого объекта.

текст
text string

Обнаруженный целевой текст.

relations
relations array of LanguageTargetRelation

Массив объектов оценки или целевых объектов, связанных с целевым объектом.

LanguageSentenceAssessment

Имя Путь Тип Описание
настроение
sentiment string

Оценка тональности в предложении.

confidenceScores
confidenceScores LanguageTargetConfidenceScoreLabel

Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.

offset
offset integer

Смещение оценки с начала предложения.

length
length integer

Длина оценки.

текст
text string

Обнаружен текст оценки.

isNegated
isNegated boolean

Индикатор, представляющий, отрицает ли оценка.

LanguageTargetRelation

Имя Путь Тип Описание
relationType
relationType string

Тип, связанный с целевым объектом.

ref
ref string

Указатель JSON, указывающий связанный объект.

LanguageTargetConfidenceScoreLabel

Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.

Имя Путь Тип Описание
Положительная
positive double

Оценка достоверности для положительной тональности

Отрицательная
negative double

Оценка достоверности для отрицательной тональности

LanguageEntitiesResult

Имя Путь Тип Описание
Документы
documents array of LanguageEntitiesDocumentResult

Ответ по документу

LanguageEntitiesDocumentResult

Имя Путь Тип Описание
entities
entities array of LanguageEntity

Распознанные сущности в документе.

id
id string

Уникальный, непустый идентификатор документа.

LanguageEntity

Имя Путь Тип Описание
текст
text string

Текст сущности, как показано в запросе.

категория
category string

Тип сущности.

Подкатегория
subcategory string

(Необязательно) Подтип сущности.

offset
offset integer

Начальная позиция для текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.

length
length integer

Длина текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемую длину.

confidenceScore
confidenceScore double

Оценка достоверности от 0 до 1 извлеченной сущности.

LanguageEntityLinkingResult

Имя Путь Тип Описание
Документы
documents array of LanguageLinkedEntitiesDocumentResult

Ответ по документу

LanguageLinkedEntitiesDocumentResult

Имя Путь Тип Описание
entities
entities array of LanguageLinkedEntity

Распознанные известные сущности в документе.

id
id string

Уникальный, непустый идентификатор документа.

LanguageLinkedEntity

Имя Путь Тип Описание
имя
name string

Связывание сущностей формального имени.

спички
matches array of LanguageMatch

Список экземпляров этой сущности отображается в тексте.

language
language string

Язык, используемый в источнике данных.

id
id string

Уникальный идентификатор распознанной сущности из источника данных.

URL-адрес
url string

URL-адрес страницы сущности из источника данных.

dataSource
dataSource string

Источник данных, используемый для извлечения связывания сущностей, таких как Wiki/Bing и т. д.

bingId
bingId string

Уникальный идентификатор API поиска сущностей Bing для распознанной сущности.

LanguageMatch

Имя Путь Тип Описание
confidenceScore
confidenceScore double

Если хорошо известный элемент распознается, возвращается десятичное число, обозначающее уровень достоверности от 0 до 1.

текст
text string

Текст сущности, как показано в запросе.

offset
offset integer

Начальная позиция для текста сопоставления сущностей.

length
length integer

Длина текста сопоставления сущностей.

LanguagePiiResult

Имя Путь Тип Описание
Документы
documents array of LanguagePiiEntitiesDocumentResult

Ответ по документу

LanguagePiiEntitiesDocumentResult

Имя Путь Тип Описание
redactedText
redactedText string

Возвращает отредактированный текст.

entities
entities array of LanguageEntity

Распознанные сущности в документе.

id
id string

Уникальный, непустый идентификатор документа.

LanguageKeyPhraseResult

Имя Путь Тип Описание
Документы
documents array of LanguageKeyPhrasesDocumentResult

Ответ по документу

LanguageKeyPhrasesDocumentResult

Имя Путь Тип Описание
ключевые фразы
keyPhrases array of string

Список репрезентативных слов или фраз. Количество возвращаемых ключевых фраз пропорционально количеству слов в входном документе.

id
id string

Уникальный, непустый идентификатор документа.

LanguageAnalyzeTextJobState_KPE

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageKeyPhraseExtractionLROResult

LanguageAnalyzeTextJobState_CNER

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageCustomEntityRecognitionLROResult

LanguageAnalyzeTextJobState_CSLC

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageCustomSingleLabelClassificationLROResult

LanguageAnalyzeTextJobState_CMLC

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageCustomMultiLabelClassificationLROResult

LanguageAnalyzeTextJobState_Entites

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Pii

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguagePiiEntityRecognitionLROResult

LanguageAnalyzeTextJobState_Sentiment

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageSentimentLROResult

LanguageAnalyzeTextJobState_HealthCare

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageHealthcareLROResult

LanguageAnalyzeTextJobState_ExtractiveSummarization

Имя Путь Тип Описание
taskResult
tasks.taskResult ExtractiveSummarizationLROResult

LanguageAnalyzeTextJobState_AbstractiveSummarization

Имя Путь Тип Описание
taskResult
tasks.taskResult AbstractiveSummarizationLROResult

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

LanguageAnalyzeTextJobState_EntityLinking

Имя Путь Тип Описание
taskResult
tasks.taskResult LanguageEntityLinkingLROResult

LanguageEntityRecognitionLROResult

Имя Путь Тип Описание
results
results LanguageEntitiesResult

LanguageCustomEntityRecognitionLROResult

Имя Путь Тип Описание
results
results LanguageCustomEntitiesResult

LanguageCustomSingleLabelClassificationLROResult

Имя Путь Тип Описание
results
results LanguageCustomLabelClassificationResult

LanguageCustomMultiLabelClassificationLROResult

Имя Путь Тип Описание
results
results LanguageCustomLabelClassificationResult

LanguageEntityLinkingLROResult

Имя Путь Тип Описание
results
results LanguageEntityLinkingResult

LanguagePiiEntityRecognitionLROResult

Имя Путь Тип Описание
results
results LanguagePiiResult

LanguageHealthcareLROResult

Имя Путь Тип Описание
results
results LanguageHealthcareResult

LanguageSentimentLROResult

Имя Путь Тип Описание
results
results LanguageSentimentResponse

LanguageKeyPhraseExtractionLROResult

Имя Путь Тип Описание
results
results LanguageKeyPhraseResult

LanguageDocumentWarning

Имя Путь Тип Описание
код
code string

Код ошибки.

сообщение
message string

Предупреждение.

targetRef
targetRef string

Ссылка указателя JSON, указывающая целевой объект.

DocumentError

Имя Путь Тип Описание
id
id string

Идентификатор документа.

ошибка
error TextAnalyticsError

TextAnalyticsError

Имя Путь Тип Описание
код
code string

Код ошибки.

сообщение
message string

Сообщение об ошибке.

target
target string

Целевой объект ошибки.

innererror
innererror InnerError
details
details array of TextAnalyticsError

Сведения об определенных ошибках, которые привели к этой сообщаемой ошибке.

TextAnalyticsWarning

Имя Путь Тип Описание
код
code string

Код ошибки.

сообщение
message string

Предупреждение.

targetRef
targetRef string

Ссылка указателя JSON, указывающая целевой объект.

InnerError

Имя Путь Тип Описание
код
code string

Код ошибки.

сообщение
message string

Сообщение об ошибке.

details
details object

Сведения об ошибке.

target
target string

Целевой объект ошибки.

innererror
innererror InnerError

SentimentResponse

Имя Путь Тип Описание
Документы
documents array of DocumentSentiment

Анализ тональности на документ.

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

DocumentSentiment

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

настроение
sentiment string

Прогнозируемые тональности для документа (отрицательные, нейтральные, положительные или смешанные).

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

confidenceScores
confidenceScores SentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Предложения
sentences array of SentenceSentiment

Анализ тональности на уровне предложения.

Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

Имя Путь Тип Описание
documentsCount
documentsCount integer

Количество документов, отправленных в запросе.

validDocumentsCount
validDocumentsCount integer

Количество допустимых документов. Это исключает пустые, слишком многоуровневые или не поддерживаемые документы языков.

ошибкаDocumentsCount
erroneousDocumentsCount integer

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

transactionsCount
transactionsCount integer

Количество транзакций для запроса.

DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

Имя Путь Тип Описание
charactersCount
charactersCount integer

Количество текстовых элементов, распознанных в документе.

transactionsCount
transactionsCount integer

Количество транзакций для документа.

SentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Имя Путь Тип Описание
Положительная
positive double
нейтральный
neutral double
Отрицательная
negative double

ПредложениеSentiment

Имя Путь Тип Описание
текст
text string

Текст предложения.

настроение
sentiment string

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

confidenceScores
confidenceScores SentimentConfidenceScorePerLabel

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

offset
offset integer

Смещение предложения от начала документа.

length
length integer

Длина предложения по стандарту Юникода.

DocumentEntities

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

entities
entities array of Entity

Распознанные сущности в документе.

Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

PiiDocumentEntities

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

redactedText
redactedText string

Возвращает отредактированный текст.

entities
entities array of Entity

Распознанные сущности в документе.

Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

Объект

Имя Путь Тип Описание
текст
text string

Текст сущности, как показано в запросе.

категория
category string

Тип сущности, например Person/Location/Org/SSN и т. д.

Подкатегория
subcategory string

Подтип сущности, например Age/Year/TimeRange и т. д.

offset
offset integer

Начальная позиция (в символах Юникода) для текста сущности.

length
length integer

Длина (в символах Юникода) для текста сущности.

confidenceScore
confidenceScore double

Оценка достоверности от 0 до 1 извлеченной сущности.

EntityLinkingResult

Имя Путь Тип Описание
Документы
documents array of DocumentLinkedEntities

Ответ по документу

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

DocumentLinkedEntities

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

entities
entities array of LinkedEntity

Распознанные известные сущности в документе.

Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

LinkedEntity

Имя Путь Тип Описание
имя
name string

Связывание сущностей формального имени.

спички
matches array of Match

Список экземпляров этой сущности отображается в тексте.

language
language string

Язык, используемый в источнике данных.

id
id string

Уникальный идентификатор распознанной сущности из источника данных.

URL-адрес
url string

URL-адрес страницы сущности из источника данных.

dataSource
dataSource string

Источник данных, используемый для извлечения связывания сущностей, таких как Wiki/Bing и т. д.

Match

Имя Путь Тип Описание
confidenceScore
confidenceScore double

Если распознается хорошо известный элемент, возвращается десятичное число, обозначающее уровень достоверности от 0 до 1.

текст
text string

Текст сущности, как показано в запросе.

offset
offset integer

Начальная позиция (в символах Юникода) для текста сопоставления сущностей.

length
length integer

Длина (в символах Юникода) для текста сопоставления сущностей.

DocumentKeyPhrases

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

ключевые фразы
keyPhrases array of string

Список репрезентативных слов или фраз. Количество возвращаемых ключевых фраз пропорционально количеству слов в входном документе.

Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

DocumentLanguage

Имя Путь Тип Описание
id
id string

Уникальный, непустый идентификатор документа.

detectedLanguage
detectedLanguage DetectedLanguage
Предупреждения
warnings array of TextAnalyticsWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

DetectedLanguage

Имя Путь Тип Описание
имя
name string

Длинное имя обнаруженного языка (например, английский, французский).

iso6391Name
iso6391Name string

Двухбуквенный представление обнаруженного языка в соответствии со стандартом ISO 639-1 (например, en, fr).

confidenceScore
confidenceScore double

Оценка достоверности от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true.

KeyPhraseResultV3

Имя Путь Тип Описание
Документы
documents array of DocumentKeyPhrases

Ответ по документу

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

EntitiesResultV3

Имя Путь Тип Описание
Документы
documents array of DocumentEntities

Ответ по документу

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

PiiResult

Имя Путь Тип Описание
Документы
documents array of PiiDocumentEntities

Ответ по документу

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

LanguageResultV3

Имя Путь Тип Описание
Документы
documents array of DocumentLanguage

Ответ по документу

Ошибки
errors array of DocumentError

Ошибки по идентификатору документа.

статистика
statistics RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

modelVersion
modelVersion string

Это поле указывает, какая модель используется для оценки.

KeyPhraseResults

Имя Путь Тип Описание
Документы
documents array of KeyPhraseResult

EntitiesResults

Имя Путь Тип Описание
Документы
documents array of EntitiesResult

LanguageResults

Имя Путь Тип Описание
Документы
documents array of LanguageResult

SentimentResults

Имя Путь Тип Описание
Документы
documents array of SentimentResult

KeyPhraseResult

Имя Путь Тип Описание
Ключевые фразы
keyPhrases array of string

Список репрезентативных слов или фраз. Количество возвращаемых ключевых фраз пропорционально количеству слов в входном документе.

Идентификатор
id string

Уникальный идентификатор документа.

EntitiesResult

Имя Путь Тип Описание
Entities
entities array of object

Список несообщенных сущностей со ссылками на дополнительные сведения в Интернете (Википедия и Bing).

Имя
entities.name string

Имя сущности.

Совпадения
entities.matches array of object

Список совпадений для сущности.

items
entities.matches object
Язык Википедии
entities.wikipediaLanguage string

Язык Википедии сущности.

Идентификатор Википедии
entities.wikipediaId string

Идентификатор Википедии сущности.

URL-адрес Википедии
entities.wikipediaUrl string

URL-адрес Википедии сущности.

Идентификатор Bing
entities.bingId string

Идентификатор Bing сущности.

Тип
entities.type string

Тип сущности.

Подтип
entities.subType string

Подтип сущности.

Идентификатор
id string

Уникальный идентификатор документа.

LanguageResult

Имя Путь Тип Описание
Идентификатор
id string

Уникальный идентификатор документа.

detectedLanguages
detectedLanguages array of DetectedLanguageV2

Список извлеченных языков.

SentimentResult

Имя Путь Тип Описание
Балл
score double

Десятичное число от 0 до 1, обозначающее тональность документа. Оценка выше 0,7 обычно относится к положительному документу, а оценка ниже 0,3 обычно имеет отрицательное коннотирование. Средние значения относятся к нейтральному тексту.

Идентификатор
id string

Уникальный идентификатор документа.

DetectedLanguageV2

Имя Путь Тип Описание
Имя
name string

Длинное имя обнаруженного языка (например, английский, французский).

Код языка
iso6391Name string

Двухбуквенный представление обнаруженного языка в соответствии со стандартом ISO 639-1 (например, en, fr).

Балл
score double

Оценка достоверности от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true.

AnalyzeConversationTaskResultsKind

Перечисление поддерживаемых результатов задачи беседы

Перечисление поддерживаемых результатов задачи беседы

ConversationalTaskResult

Результаты задачи беседы.

Имя Путь Тип Описание
добрый
kind AnalyzeConversationTaskResultsKind

Перечисление поддерживаемых результатов задачи беседы

результат
result AnalyzeConversationResult

Представляет ответ на анализ беседы.

ConversationalTaskResult_Orchestration

Результаты задачи беседы.

Имя Путь Тип Описание
добрый
kind AnalyzeConversationTaskResultsKind

Перечисление поддерживаемых результатов задачи беседы

результат
result AnalyzeConversationResult_Orchestration

Представляет ответ на анализ беседы.

AnalyzeConversationResult

Представляет ответ на анализ беседы.

Имя Путь Тип Описание
query
query string

Речевой фрагмент беседы, предоставленный вызывающим абонентом.

detectedLanguage
detectedLanguage string

Система обнаружила язык для запроса в представлении языка BCP 47..

prediction
prediction ConversationPrediction

Представляет раздел прогнозирования проекта беседы.

AnalyzeConversationResult_Orchestration

Представляет ответ на анализ беседы.

Имя Путь Тип Описание
query
query string

Речевой фрагмент беседы, предоставленный вызывающим абонентом.

detectedLanguage
detectedLanguage string

Система обнаружила язык для запроса в представлении языка BCP 47..

prediction
prediction OrchestrationPrediction

Это представляет собой результат прогнозирования проекта оркестрации.

ConversationPrediction

Представляет раздел прогнозирования проекта беседы.

Имя Путь Тип Описание
намерения
intents array of ConversationIntent

Результаты классификации намерений.

entities
entities array of ConversationEntity

Результаты извлечения сущностей.

типПроекта
projectKind string

Тип проекта.

topIntent
topIntent string

Намерение с наивысшей оценкой.

ConversationIntent

Результат классификации намерений проекта Conversation.

Имя Путь Тип Описание
категория
category string

Прогнозируемый класс.

confidenceScore
confidenceScore float

Оценка достоверности класса от 0,0 до 1.0.

ConversationEntity

Результат извлечения сущностей проекта Conversation.

Имя Путь Тип Описание
категория
category string

Категория сущностей.

текст
text string

Прогнозируемый текст сущности.

offset
offset integer

Начальный индекс этой сущности в запросе.

length
length integer

Длина текста.

confidenceScore
confidenceScore float

Оценка достоверности сущностей.

Резолюций
resolutions array of BaseResolution

Коллекция объектов разрешения сущностей.

extraInformation
extraInformation array of BaseExtraInformation

Коллекция дополнительных информационных объектов сущностей.

topResolution
topResolution BaseResolution

Абстрактный базовый класс для разрешения сущностей.

multipleResolutions
multipleResolutions boolean

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

BaseExtraInformation

Абстрактный базовый объект для дополнительной информации сущности.

Имя Путь Тип Описание
extraInformationKind
extraInformationKind string

Тип объекта дополнительной информации.

BaseResolution

Абстрактный базовый класс для разрешения сущностей.

Имя Путь Тип Описание
resolutionKind
resolutionKind string

Тип объекта разрешения сущностей.

ОркестрацияPrediction

Это представляет собой результат прогнозирования проекта оркестрации.

Имя Путь Тип Описание
намерения
intents object

Словарь, содержащий все намерения. Ключ — это имя намерения, а значение — это его оценка достоверности и целевой тип. Значение верхнего намерения также содержит фактический ответ целевого проекта.

типПроекта
projectKind string

Тип проекта.

topIntent
topIntent string

Намерение с наивысшей оценкой.

ExtractiveSummarizationResult

Имя Путь Тип Описание
Документы
documents array of ExtractedSummaryDocumentResultWithDetectedLanguage

Ответ по документу

ExtractedSummaryDocumentResultWithDetectedLanguage

Имя Путь Тип Описание
Предложения
sentences array of ExtractedSummarySentence

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

detectedLanguage
detectedLanguage DetectedLanguage

ExtractedSummarySentence

Имя Путь Тип Описание
текст
text string

Извлеченный текст предложения.

rankScore
rankScore double

Двойное значение, представляющее релевантность предложения в сводке. Более высокие значения указывают на более высокую важность.

offset
offset integer

Смещение предложения от начала документа на основе значения параметра StringIndexType.

length
length integer

Длина предложения.

ExtractiveSummarizationLROResult

Имя Путь Тип Описание
results
results ExtractiveSummarizationResult

AbstractiveSummarizationLROResult

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

Имя Путь Тип Описание
results
results AbstractiveSummarizationResult

Объект, представляющий результаты сводки предварительной сборки каждого документа.

АбстрактнаяSummarizationResult

Объект, представляющий результаты сводки предварительной сборки каждого документа.

Имя Путь Тип Описание
Документы
documents array of AbstractiveSummaryDocumentResultWithDetectedLanguage

Ответ по документу

AbstractiveSummaryDocumentResultWithDetectedLanguage

Объект, представляющий результат суммирования одного документа с обнаруженным языком.

Имя Путь Тип Описание
summaries
summaries array of AbstractiveSummary

Список абстрактных сводок.

id
id string

Уникальный, непустый идентификатор документа.

Предупреждения
warnings array of LanguageDocumentWarning

Предупреждения, возникающие при обработке документа.

статистика
statistics DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

detectedLanguage
detectedLanguage DetectedLanguage

SummaryContext

Контекст сводки.

Имя Путь Тип Описание
offset
offset integer

Начальная позиция для контекста. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.

length
length integer

Длина контекста. Использование различных значений stringIndexType может повлиять на возвращаемую длину.

Абстрактныйsummary

Объект, представляющий одну сводку с контекстом для данного документа.

Имя Путь Тип Описание
текст
text string

Текст сводки.

contexts
contexts array of SummaryContext

Список контекстов сводки.

AnswersResult

Представляет список ответов на вопросы.

Имя Путь Тип Описание
ответы
answers array of KnowledgeBaseAnswer

Представляет список результатов ответа.

isUserQuestionAmbiguous
isUserQuestionAmbiguous boolean

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

KnowledgeBaseAnswer

Представляет ответ проекта.

Имя Путь Тип Описание
Вопросы
questions array of string

Список вопросов, связанных с ответом.

ответ
answer string

Текст ответа.

Порог достоверности
confidenceScore float

Оценка достоверности ответа, значение диапазонов от 0 до 1.

Идентификатор QnA
id integer

Идентификатор результата QnA.

source
source string

Источник результата QnA.

metadata
metadata object

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

диалоговое окно
dialog KnowledgeBaseAnswerDialog

Диалоговое окно, связанное с ответом.

answerSpan
answerSpan AnswerSpan

Объект диапазона ответов QnA.

KnowledgeBaseAnswerDialog

Диалоговое окно, связанное с ответом.

Имя Путь Тип Описание
isContextOnly
isContextOnly boolean

Чтобы пометить, относится ли запрос только к предыдущему вопросу или нет. Если значение true, не включите этот QnA в качестве результата поиска запросов без контекста; в противном случае, если значение false, игнорирует контекст и включает этот QnA в результат поиска.

Запросы
prompts array of KnowledgeBaseAnswerPrompt

Список запросов, связанных с ответом.

KnowledgeBaseAnswerPrompt

Запрос ответа.

Имя Путь Тип Описание
displayOrder
displayOrder integer

Индекс запроса — используется в порядке запросов.

qnaId
qnaId integer

Идентификатор QnA, соответствующий запросу.

displayText
displayText string

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

Область ответов

Объект диапазона ответов QnA.

Имя Путь Тип Описание
текст
text string

Прогнозируемый текст точного ответа.

Порог достоверности
confidenceScore float

Прогнозируемая оценка точного ответа, значения варьируются от 0 до 1.

offset
offset integer

Смещение точного ответа от начала ответа.

length
length integer

Длина точного ответа.