Text Analysis Authoring - Train

Referentie

Service:: Azure AI Services

API-versie:: 2022-05-01

Hiermee activeert u een trainingstaak voor een project.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een Taalserviceresource.

Aanvraagbody

Name	Vereist	Type	Description
modelLabel	True	string	Vertegenwoordigt het label van het uitvoermodel.
trainingConfigVersion	True	string	Vertegenwoordigt de configuratieversie van de training.
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	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		Een geslaagde aanroep met een Operation-Location header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string
Other Status Codes	ErrorResponse	Foutreactie.

Name

Type

Description

202 Accepted

Een geslaagde aanroep met een Operation-Location header die wordt gebruikt om de status van de taak te controleren.

Kopteksten

operation-location: string

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een Taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Train Project

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 202

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
EvaluationKind	Vertegenwoordigt het type evaluatie. Standaard is het type evaluatie ingesteld op percentage.
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.
TextAnalysisAuthoringEvaluationOptions	Vertegenwoordigt de opties die worden gebruikt voor het uitvoeren van de evaluatie.
TextAnalysisAuthoringTrainingJobOptions	Vertegenwoordigt de opties voor het starten van een nieuwe trainingstaak.

Error

Object

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

Inventarisatie

Leesbare foutcode.

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

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

EvaluationKind

Inventarisatie

Vertegenwoordigt het type evaluatie. Standaard is het type evaluatie ingesteld op percentage.

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

InnerErrorCode

Inventarisatie

Leesbare foutcode.

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

InnerErrorModel

Object

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.

TextAnalysisAuthoringEvaluationOptions

Object

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 (int32)	Vertegenwoordigt het gesplitste percentage van de testgegevensset. Alleen nodig voor het geval het type evaluatie percentage is.
trainingSplitPercentage	integer (int32)	Vertegenwoordigt het gesplitste percentage van de trainingsgegevensset. Alleen nodig voor het geval het type evaluatie percentage is.