Conversational Analysis Authoring - Train

Ссылка

Служба:: Cognitive Services - Language

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

Активирует задание обучения для проекта.

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

Параметры URI

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

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

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

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

Имя	Обязательно	Тип	Описание
modelLabel	True	string	Представляет метку выходной модели.
trainingMode	True	TrainingMode	Представляет режим операции обучения.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Представляет параметры оценки. По умолчанию типом оценки является процент, а процент разбиения обучения — 80, а процент разделения тестирования — 20.
trainingConfigVersion		string	Представляет версию конфигурации обучения. По умолчанию используется значение latest, которое использует последнюю выпущенную версию конфигурации обучения.

Ответы

Имя	Тип	Описание
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 Train Project

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

HTTP

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


{
  "modelLabel": "model1",
  "trainingMode": "standard",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

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

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

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

Определения

Имя	Описание
ConversationalAnalysisAuthoringEvaluationOptions	Представляет параметры, используемые при выполнении оценки.
ConversationalAnalysisAuthoringTrainingJobOptions	Представляет параметры для запуска нового задания обучения.
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
EvaluationKind	Представляет тип оценки. По умолчанию для типа оценки задано значение в процентах.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Представляет режим операции обучения.

ConversationalAnalysisAuthoringEvaluationOptions

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

Имя	Тип	Описание
kind	EvaluationKind	Представляет тип оценки. По умолчанию для типа оценки задано значение в процентах.
testingSplitPercentage	integer	Представляет процент разделения тестового набора данных. Требуется только в том случае, если тип оценки равен проценту.
trainingSplitPercentage	integer	Представляет процент разделения набора данных для обучения. Требуется только в том случае, если тип оценки равен проценту.

ConversationalAnalysisAuthoringTrainingJobOptions

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

Имя	Тип	Описание
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Представляет параметры оценки. По умолчанию типом оценки является процент, а процент разбиения обучения — 80, а процент разделения тестирования — 20.
modelLabel	string	Представляет метку выходной модели.
trainingConfigVersion	string	Представляет версию конфигурации обучения. По умолчанию используется значение latest, которое использует последнюю выпущенную версию конфигурации обучения.
trainingMode	TrainingMode	Представляет режим операции обучения.

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	Объект ошибки.

EvaluationKind

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

Имя	Тип	Описание
manual	string	Разделите данные в соответствии с выбранным набором данных для каждого примера данных.
percentage	string	Разделите данные на обучающие и тестовые наборы в соответствии с определяемыми пользователем процентными значениями.

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	Целевой объект ошибки.

TrainingMode

Представляет режим операции обучения.

Имя	Тип	Описание
advanced	string	Обучение с использованием точно настроенных моделей преобразователя нейронной сети. Возможно обучение многоязычных проектов.
standard	string	Более быстрое время обучения для более быстрых итераций.

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

Conversational Analysis Authoring - Train

Параметры URI

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

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Successful Train Project

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

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

Определения

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

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