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 매개 변수

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

요청 본문

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

응답

Name	형식	Description
202 Accepted		처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다. 헤더 Operation-Location: string
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

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

OAuth2Auth

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

Name	Description
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

정의

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

오류 개체입니다.

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

ErrorCode

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

Name	형식	Description
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

오류 응답입니다.

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

EvaluationKind

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

InnerErrorCode

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

Name	형식	Description
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

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. 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

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

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

TextAnalysisAuthoringTrainingJobOptions

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

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