Text Analysis Authoring - Train

서비스:

Azure AI Services

API 버전:

2022-05-01

프로젝트에 대한 학습 작업을 트리거합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	언어 서비스 리소스에 대한 구독 키입니다.

요청 본문

Name	필수	형식	Description
modelLabel	True	string	출력 모델 레이블을 나타냅니다.
trainingConfigVersion	True	string	학습 구성 버전을 나타냅니다.
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	평가 옵션을 나타냅니다. 기본적으로 평가 종류는 백분율이며 학습 분할 백분율은 80이고 테스트 분할 비율은 20입니다.

응답

Name	형식	Description
202 Accepted		작업의 상태를 확인하는 데 사용되는 Operation-Location 헤더가 포함된 성공적인 호출 결과입니다. 헤더 operation-location: string
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

형식: apiKey
In(다음 안에): header

예제

Successful Train Project

샘플 요청

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2022-05-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=2022-05-01

정의

Name	Description
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
EvaluationKind	평가 종류를 나타냅니다. 기본적으로 평가 종류는 백분율로 설정됩니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringEvaluationOptions	평가를 실행하는 데 사용되는 옵션을 나타냅니다.
TextAnalysisAuthoringTrainingJobOptions	새 학습 작업을 시작하는 옵션을 나타냅니다.

Error

Object

오류 개체입니다.

Name	형식	Description
code	ErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

값	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

EvaluationKind

열거형

평가 종류를 나타냅니다. 기본적으로 평가 종류는 백분율로 설정됩니다.

값	Description
manual	데이터의 모든 예제에 대해 선택한 데이터 세트에 따라 데이터를 분할합니다.
percentage	사용자 정의 백분율에 따라 데이터를 학습 및 테스트 집합으로 분할합니다.

InnerErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

값	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	InnerErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

TextAnalysisAuthoringEvaluationOptions

Object

평가를 실행하는 데 사용되는 옵션을 나타냅니다.

Name	형식	Description
kind	EvaluationKind	평가 종류를 나타냅니다. 기본적으로 평가 종류는 백분율로 설정됩니다.
testingSplitPercentage	integer (int32)	테스트 데이터 세트 분할 비율을 나타냅니다. 평가 종류가 백분율인 경우에만 필요합니다.
trainingSplitPercentage	integer (int32)	학습 데이터 세트 분할 비율을 나타냅니다. 평가 종류가 백분율인 경우에만 필요합니다.

TextAnalysisAuthoringTrainingJobOptions

Object

새 학습 작업을 시작하는 옵션을 나타냅니다.

Name	형식	Description
evaluationOptions	TextAnalysisAuthoringEvaluationOptions	평가 옵션을 나타냅니다. 기본적으로 평가 종류는 백분율이며 학습 분할 백분율은 80이고 테스트 분할 비율은 20입니다.
modelLabel	string	출력 모델 레이블을 나타냅니다.
trainingConfigVersion	string	학습 구성 버전을 나타냅니다.