Text Analysis Authoring - Train

Service:

Azure AI Services

API-versie:

2023-04-01

Hiermee activeert u een trainingstaak voor een project.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string url	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het te gebruiken project.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
modelLabel	True	string	Vertegenwoordigt het label van het uitvoermodel.
trainingConfigVersion	True	string	Vertegenwoordigt de configuratieversie van de training.
evaluationOptions		EvaluationOptions	Vertegenwoordigt de evaluatieopties. Het type evaluatie is standaard een percentage, met een gesplitst percentage training als 80 en het testen van gesplitst percentage als 20.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

SuccessfulTrainProject

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

202

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
EvaluationKind
EvaluationOptions	Vertegenwoordigt de opties die worden gebruikt voor het uitvoeren van de evaluatie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingJobOptions	Vertegenwoordigt de opties voor het starten van een nieuwe trainingstaak.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Leesbare foutcode.

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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

EvaluationKind

Name	Type	Description
manual	string	Splits de gegevens op basis van de gekozen gegevensset voor elk voorbeeld in de gegevens.
percentage	string	Splits de gegevens in trainings- en testsets op basis van door de gebruiker gedefinieerde percentages.

EvaluationOptions

Vertegenwoordigt de opties die worden gebruikt voor het uitvoeren van de evaluatie.

Name	Type	Description
kind	EvaluationKind	Vertegenwoordigt het type evaluatie. Standaard is het type evaluatie ingesteld op percentage.
testingSplitPercentage	integer	Vertegenwoordigt het gesplitste percentage van de testgegevensset. Alleen nodig voor het geval het type evaluatie percentage is.
trainingSplitPercentage	integer	Vertegenwoordigt het gesplitste percentage van de trainingsgegevensset. Alleen nodig voor het geval het type evaluatie percentage is.

InnerErrorCode

Leesbare foutcode.

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

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

TrainingJobOptions

Vertegenwoordigt de opties voor het starten van een nieuwe trainingstaak.

Name	Type	Description
evaluationOptions	EvaluationOptions	Vertegenwoordigt de evaluatieopties. Het type evaluatie is standaard een percentage, met een gesplitst percentage training als 80 en het testen van gesplitst percentage als 20.
modelLabel	string	Vertegenwoordigt het label van het uitvoermodel.
trainingConfigVersion	string	Vertegenwoordigt de configuratieversie van de training.