Conversational Analysis Authoring - Import

Ссылка

Service:: Cognitive Services - Language

API Version:: 2023-04-01

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

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01

With optional parameters:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2023-04-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия API клиента.
format	query		ExportedProjectFormat	Формат экспортированного файла проекта для использования.

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

Имя	Обязательно	Тип	Описание
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	Представляет метаданные проекта.
projectFileVersion	True	string	Версия экспортированного файла.
stringIndexType	True	StringIndexType	Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Представляет ресурсы проекта.

Ответы

Имя	Тип	Описание
202 Accepted		Ответ будет содержать заголовок Operation-Location, используемый для проверки состояния задания. Headers operation-location: string
Other Status Codes	ErrorResponse	Ответ об ошибке.

Имя

Тип

Описание

202 Accepted

Ответ будет содержать заголовок Operation-Location, используемый для проверки состояния задания.

Headers

operation-location: string

Other Status Codes

ErrorResponse

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

Безопасность

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Type: apiKey
In: header

Примеры

Successful Import Project

Sample Request

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2023-04-01

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "EmailApp",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "en-us"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "Read"
      },
      {
        "category": "Delete"
      }
    ],
    "entities": [
      {
        "category": "Sender"
      },
      {
        "category": "Number",
        "regex": {
          "expressions": [
            {
              "regexKey": "UK Phone numbers",
              "language": "en-us",
              "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/"
            }
          ]
        }
      }
    ],
    "utterances": [
      {
        "text": "Open Blake's email",
        "dataset": "Train",
        "intent": "Read",
        "entities": [
          {
            "category": "Sender",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "Delete last email",
        "language": "en-gb",
        "dataset": "Test",
        "intent": "Delete",
        "entities": []
      }
    ]
  }
}

Sample Response

Status code:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

Определения

Имя	Описание
CompositionSetting	Поведение, которое следует следовать, когда компоненты сущности перекрываются друг с другом.
ConversationalAnalysisAuthoringConversationExportedEntity	Представляет сущность с ее компонентами.
ConversationalAnalysisAuthoringConversationExportedIntent	Представляет экспортируемое намерение диалогового проекта.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Представляет экспортированные ресурсы диалогового проекта.
ConversationalAnalysisAuthoringConversationExportedUtterance	Представляет экспортируемый речевой фрагмент для проекта беседы.
ConversationalAnalysisAuthoringCreateProjectOptions	Представляет параметры, используемые для создания или обновления проекта.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Определяет сведения о оркестрации для целевого проекта conversational.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Представляет параметры оркестрации для целевого объекта проекта conversational.
ConversationalAnalysisAuthoringExportedEntityList	Представляет компонент списка сущности.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Представляет список синонимов в компоненте списка.
ConversationalAnalysisAuthoringExportedEntityRegex	Представляет компонент регулярных выражений сущности.
ConversationalAnalysisAuthoringExportedEntityRegexExpression	Представляет выражение регулярного выражения внутри компонента регулярных выражений. Это выражение следует синтаксису регулярных выражений .NET. Для справки проверка здесь:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
ConversationalAnalysisAuthoringExportedEntitySublist	Представляет вложенный список внутри компонента списка.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Определяет сведения о оркестрации для целевого объекта приложения LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Представляет параметры оркестрации для целевого объекта приложения LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Представляет экспортируемый предварительно созданный компонент сущности
ConversationalAnalysisAuthoringExportedProject	Представляет экспортируемый проект.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Определяет сведения о оркестрации для целевого объекта проекта "Ответы на вопросы".
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Представляет параметры оркестрации для целевого объекта проекта "Ответы на вопросы".
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Представляет метку сущности для высказывания.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Представляет экспортируемое намерение для проекта оркестрации.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Представляет ресурсы проекта оркестрации.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Представляет речевой фрагмент проекта оркестрации.
ConversationalAnalysisAuthoringProjectSettings	Представляет параметры, используемые для определения поведения проекта.
Error	Объект error.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
ExportedProjectFormat	Формат экспортированного файла проекта для использования.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Представляет тип проекта.
StringIndexType	Задает метод, используемый для интерпретации смещений строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

CompositionSetting

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

Имя	Тип	Описание
combineComponents	string	Если в тексте обнаруживается несколько компонентов и перекрываются, диапазоны компонентов объединяются в один диапазон, объединяя их все.
requireExactOverlap	string	Все компоненты должны перекрываться в точно тех же символах в тексте для возврата сущности. Если один из определенных компонентов не соответствует или не прогнозируется, сущность не будет возвращать значение.
returnLongestOverlap	string	Если в тексте найдено несколько компонентов и перекрываются, возвращается компонент с самым длинным набором символов.
separateComponents	string	Совпадение или прогноз каждого компонента возвращается как отдельный экземпляр сущности.

ConversationalAnalysisAuthoringConversationExportedEntity

Представляет сущность с ее компонентами.

Имя	Тип	Описание
category	string	Категория сущности.
compositionSetting	CompositionSetting	Поведение, которое следует следовать, когда компоненты сущности перекрываются друг с другом.
list	ConversationalAnalysisAuthoringExportedEntityList	Компонент списка сущности.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Предварительно созданные компоненты сущностей.
regex	ConversationalAnalysisAuthoringExportedEntityRegex	Компонент регулярного выражения сущности.
requiredComponents	string[]	Необходимые компоненты. Допустимые значения: "learned", "list", "prebuilts" и "regex".

ConversationalAnalysisAuthoringConversationExportedIntent

Представляет экспортируемое намерение диалогового проекта.

Имя	Тип	Описание
category	string	Категория намерений.

ConversationalAnalysisAuthoringConversationExportedProjectAssets

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

Имя	Тип	Описание
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	Сущности, определенные в проекте.
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	Намерения, определенные в проекте.
projectKind	string: Conversation	Тип проекта, содержащего ресурсы.
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	Речевые фрагменты, определенные в проекте.

ConversationalAnalysisAuthoringConversationExportedUtterance

Представляет экспортируемый речевой фрагмент для проекта беседы.

Имя	Тип	Описание
dataset	string	Набор данных для этого высказывания. Допустимые значения: Train и Test.
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	Представляет метки сущностей речевого фрагмента.
intent	string	Намерение речевого фрагмента.
language	string	Представляет язык речевого фрагмента. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского и т. д.
text	string	Текст речевого фрагмента.

ConversationalAnalysisAuthoringCreateProjectOptions

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

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык проекта. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского и т. д.
multilingual	boolean	Будет ли проект использоваться для нескольких языков или нет.
projectKind	ProjectKind	Представляет тип проекта.
projectName	string	Имя нового проекта.
settings	ConversationalAnalysisAuthoringProjectSettings	Параметры проекта.

ConversationalAnalysisAuthoringExportedConversationOrchestration

Определяет сведения о оркестрации для целевого проекта conversational.

Имя	Тип	Описание
deploymentName	string	Имя целевого развертывания.
projectName	string	Имя целевого проекта.

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Представляет параметры оркестрации для целевого объекта проекта conversational.

Имя	Тип	Описание
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Сведения о целевом проекте Conversational.
targetProjectKind	string: Conversation	Тип целевого объекта, используемого в потоке оркестрации.

ConversationalAnalysisAuthoringExportedEntityList

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

Имя	Тип	Описание
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	Вложенные списки компонента списка.

ConversationalAnalysisAuthoringExportedEntityListSynonym

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

Имя	Тип	Описание
language	string	Представляет язык синонимов. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского языка и т. д.
values	string[]	Список синонимов.

ConversationalAnalysisAuthoringExportedEntityRegex

Представляет компонент регулярных выражений сущности.

Имя	Тип	Описание
expressions	ConversationalAnalysisAuthoringExportedEntityRegexExpression[]	Регулярные выражения компонента регулярного выражения. Эти выражения следуют синтаксису регулярных выражений .NET. Для справки проверка здесь:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

Представляет выражение регулярного выражения внутри компонента регулярных выражений. Это выражение следует синтаксису регулярных выражений .NET. Для справки проверка здесь:https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

Имя	Тип	Описание
language	string	Представляет язык выражения регулярных выражений. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского языка и т. д.
regexKey	string	Ключ выражения регулярного выражения.
regexPattern	string	Шаблон регулярных выражений.

ConversationalAnalysisAuthoringExportedEntitySublist

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

Имя	Тип	Описание
listKey	string	Ключ вложенного списка.
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	Фразы , соответствующие под-списку.

ConversationalAnalysisAuthoringExportedLuisOrchestration

Определяет сведения о оркестрации для целевого объекта приложения LUIS.

Имя	Тип	Описание
appId	string	Идентификатор приложения LUIS.
appVersion	string	Идентификатор целевой версии.
slotName	string	Имя целевого слота.

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Представляет параметры оркестрации для целевого объекта приложения LUIS.

Имя	Тип	Описание
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	Сведения о целевом объекте приложения LUIS.
targetProjectKind	string: Luis	Тип целевого объекта, используемого в потоке оркестрации.

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Представляет экспортируемый предварительно созданный компонент сущности

Имя	Тип	Описание
category	string	Предварительно созданная категория сущностей.

ConversationalAnalysisAuthoringExportedProject

Представляет экспортируемый проект.

Имя	Тип	Описание
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Представляет ресурсы проекта.
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	Представляет метаданные проекта.
projectFileVersion	string	Версия экспортированного файла.
stringIndexType	StringIndexType	Задает метод, используемый для интерпретации смещений строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Определяет сведения о оркестрации для целевого объекта проекта "Ответы на вопросы".

Имя	Тип	Описание
projectName	string	Имя целевого проекта.

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Представляет параметры оркестрации для целевого объекта проекта "Ответы на вопросы".

Имя	Тип	Описание
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Сведения о проекте "Ответы на вопросы".
targetProjectKind	string: QuestionAnswering	Тип целевого объекта, используемого в потоке оркестрации.

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

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

Имя	Тип	Описание
category	string	Категория метки сущности.
length	integer	Длина текста сущности.
offset	integer	Начальная позиция для текста сущности.

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Представляет экспортируемое намерение для проекта оркестрации.

Имя	Тип	Описание
category	string	Категория намерений.
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Указывает поведение этого намерения в потоке оркестрации.

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

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

Имя	Тип	Описание
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	Представляет намерения проекта.
projectKind	string: Orchestration	Тип проекта, содержащего ресурсы.
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	Представляет речевые фрагменты проекта.

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Представляет речевой фрагмент проекта оркестрации.

Имя	Тип	Описание
dataset	string	Набор данных для этого высказывания. Допустимые значения: Train и Test.
intent	string	Намерение речевого фрагмента.
language	string	Представляет язык речевого фрагмента. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского и т. д.
text	string	Текст речевого фрагмента.

ConversationalAnalysisAuthoringProjectSettings

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

Имя	Тип	Описание
confidenceThreshold	number	Пороговое значение намерения с наивысшей достоверностью, при котором прогноз автоматически изменится на "Нет". Пороговое значение должно находиться в диапазоне от 0 до 1 включительно.

Error

Объект error.

Имя	Тип	Описание
code	ErrorCode	Один из определяемого сервером набора кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Удобочитаемое представление ошибки.
target	string	Цель ошибки.

ErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

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

Имя	Тип	Описание
error	Error	Объект error.

ExportedProjectFormat

Формат экспортированного файла проекта для использования.

Имя	Тип	Описание
Conversation	string	Задает формат для диалогового проекта.
Luis	string	Задает формат для приложения, экспортированного из LUIS.

InnerErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

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

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемого сервером набора кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ProjectKind

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

Имя	Тип	Описание
Conversation	string	Проект по созданию естественного языка в приложениях, ботах и устройствах Интернета вещей.
Orchestration	string	Проект для объединения и оркестрации бесед, пользовательских ответов на вопросы и проектов LUIS в одном проекте.

StringIndexType

Задает метод, используемый для интерпретации смещений строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

Имя	Тип	Описание
Utf16CodeUnit	string	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java или JavaScript.

Conversational Analysis Authoring - Import

Параметры URI

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

Ответы

Безопасность

AADToken

Примечания

Scopes

Ocp-Apim-Subscription-Key

Примеры

Successful Import Project

Sample Request

Sample Response

Определения

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntityRegex

ConversationalAnalysisAuthoringExportedEntityRegexExpression

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

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