Text Analysis Authoring - Train

Служба:

Azure AI Services

Версия API:

2023-04-01

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

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

Параметры URI

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

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

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

Ответы

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

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

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

Примеры

SuccessfulTrainProject

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

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01

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

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

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

202

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

Определения

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

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	Разделить данные на наборы для обучения и тестирования в соответствии с определяемыми пользователем процентными значениями.

EvaluationOptions

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

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

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

TrainingJobOptions

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

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