Conversational Analysis Authoring - Import

Ссылка

Служба:: Azure AI Services

Версия API:: 2022-05-01

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

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

С использованием необязательных параметров:

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

Параметры URI

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

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса службы языка.

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

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

Ответы

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

Имя

Тип

Описание

202 Accepted

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

Заголовки

operation-location: string

Other Status Codes

ErrorResponse

Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Примеры

Successful Import Project

Образец запроса

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-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"
      }
    ],
    "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": []
      }
    ]
  }
}

Пример ответа

Код состояния:: 202

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

Определения

Имя	Описание
CompositionSetting	Поведение, которое следует выполнять, когда компоненты сущности перекрываются друг с другом.
ConversationalAnalysisAuthoringConversationExportedEntity	Представляет сущность со своими компонентами.
ConversationalAnalysisAuthoringConversationExportedIntent	Представляет экспортируемое намерение проекта беседы.
ConversationalAnalysisAuthoringConversationExportedProjectAssets	Представляет экспортированные ресурсы беседного проекта.
ConversationalAnalysisAuthoringConversationExportedUtterance	Представляет экспортируемое высказывание для проекта беседы.
ConversationalAnalysisAuthoringCreateProjectOptions	Представляет параметры, используемые для создания или обновления проекта.
ConversationalAnalysisAuthoringExportedConversationOrchestration	Определяет сведения о оркестрации для целевого объекта проекта Conversational.
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Представляет параметры оркестрации для целевого объекта проекта Conversational.
ConversationalAnalysisAuthoringExportedEntityList	Представляет компонент списка сущности.
ConversationalAnalysisAuthoringExportedEntityListSynonym	Представляет список синонимов внутри компонента списка
ConversationalAnalysisAuthoringExportedEntitySublist	Представляет вложенный список внутри компонента списка.
ConversationalAnalysisAuthoringExportedLuisOrchestration	Определяет сведения о оркестрации для целевого объекта приложения LUIS.
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	Представляет параметры оркестрации для целевого объекта приложения LUIS.
ConversationalAnalysisAuthoringExportedPrebuiltEntity	Представляет экспортируемый предварительно созданный компонент сущности
ConversationalAnalysisAuthoringExportedProject	Представляет экспортируемый проект.
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Определяет сведения о оркестрации для целевого объекта проекта "Ответ на вопросы".
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Представляет параметры оркестрации для целевого объекта проекта "Ответ на вопросы".
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	Представляет метку сущности для речевых фрагментов.
ConversationalAnalysisAuthoringOrchestrationExportedIntent	Представляет экспортируемое намерение для проекта оркестрации.
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	Представляет ресурсы проекта оркестрации.
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	Представляет речевой фрагмент проекта оркестрации.
ConversationalAnalysisAuthoringProjectSettings	Представляет параметры, используемые для определения поведения проекта.
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	Если два или более компонентов находятся в тексте и перекрываются, диапазоны компонентов объединяются в один диапазон, объединяющий все из них.
requireExactOverlap	Все компоненты должны перекрываться с одинаковыми символами в тексте для возвращаемой сущности. Если один из определенных компонентов не соответствует или не прогнозируется, сущность не возвращается.
returnLongestOverlap	При обнаружении двух или нескольких компонентов в тексте и перекрытии возвращается компонент с самым длинным набором символов.
separateComponents	Совпадение или прогнозирование каждого компонента возвращается в виде отдельного экземпляра сущности.

ConversationalAnalysisAuthoringConversationExportedEntity

Object

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

Имя	Тип	Описание
category	string	Категория сущности.
compositionSetting	CompositionSetting	Поведение, которое следует выполнять, когда компоненты сущности перекрываются друг с другом.
list	ConversationalAnalysisAuthoringExportedEntityList	Компонент списка сущности.
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	Предварительно созданные компоненты сущностей.

ConversationalAnalysisAuthoringConversationExportedIntent

Object

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

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

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Object

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

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

ConversationalAnalysisAuthoringConversationExportedUtterance

Object

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

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

ConversationalAnalysisAuthoringCreateProjectOptions

Object

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

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

ConversationalAnalysisAuthoringExportedConversationOrchestration

Object

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

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

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Object

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

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

ConversationalAnalysisAuthoringExportedEntityList

Object

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

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

ConversationalAnalysisAuthoringExportedEntityListSynonym

Object

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

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

ConversationalAnalysisAuthoringExportedEntitySublist

Object

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

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

ConversationalAnalysisAuthoringExportedLuisOrchestration

Object

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

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

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Object

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

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

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Object

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

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

ConversationalAnalysisAuthoringExportedProject

Object

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

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

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Object

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

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

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Object

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

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

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Object

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

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

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Object

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

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

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Object

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

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

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Object

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

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

ConversationalAnalysisAuthoringProjectSettings

Object

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

Имя	Тип	Описание
confidenceThreshold	number (float)	Порог намерения с наивысшей уверенностью, при которой прогноз автоматически будет изменен на "Нет".

Error

Object

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

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

ErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Ответ на ошибку.

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

ExportedProjectFormat

Перечисление

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

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

InnerErrorCode

Перечисление

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

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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	Проект для создания естественного языка в приложениях, ботах и устройствах Интернета вещей.
Orchestration	Проект для подключения и оркестрации беседы, пользовательских ответов на вопросы и проектов LUIS вместе в одном проекте.

StringIndexType

Перечисление

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

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

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

Conversational Analysis Authoring - Import

Параметры URI

Заголовок запроса

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Successful Import Project

Образец запроса

Пример ответа

Определения

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

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