Text Analysis Authoring - Train

Referens

Tjänst:: Azure AI Services

API-version:: 2023-04-01

Utlöser ett träningsjobb för ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string url	Cognitive Services-slutpunkt som stöds, t.ex. https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Namnet på projektet som ska användas.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
modelLabel	True	string	Representerar utdatamodelletiketten.
trainingConfigVersion	True	string	Representerar träningskonfigurationsversion.
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	Representerar utvärderingsalternativen. Som standard är utvärderingstypen procent, med träningsuppdelningsprocent som 80, och testning av delad procentandel som 20.

Svar

Name	Typ	Description
202 Accepted		Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

202 Accepted

Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Sidhuvuden

Operation-Location: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default

Exempel

SuccessfulTrainProject

Exempelbegäran

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
  }
}

Exempelsvar

Statuskod:: 202

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
EvaluationKind
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringEvaluationOptions	Representerar de alternativ som används för att köra utvärderingen.
TextAnalysisAuthoringTrainingJobOptions	Representerar alternativen för att starta ett nytt träningsjobb.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

EvaluationKind

Name	Typ	Description
manual	string	Dela upp data enligt den valda datauppsättningen för varje exempel i data.
percentage	string	Dela upp data i tränings- och testuppsättningar enligt användardefinierade procentsatser.

InnerErrorCode

Felkod som kan läsas av människor.

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

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

TextAnalysisAuthoringEvaluationOptions

Representerar de alternativ som används för att köra utvärderingen.

Name	Typ	Description
kind	EvaluationKind	Representerar utvärderingstyp. Som standard är utvärderingstypen inställd på procent.
testingSplitPercentage	integer	Representerar delningsprocenten för testdatauppsättningen. Behövs bara om utvärderingstyp är procent.
trainingSplitPercentage	integer	Representerar delningsprocenten för träningsdatauppsättningen. Behövs bara om utvärderingstyp är procent.