Text Analysis Authoring - Train

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Löst einen Schulungsauftrag für ein Projekt aus.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string url	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
modelLabel	True	string	Stellt die Ausgabemodellbezeichnung dar.
trainingConfigVersion	True	string	Stellt die Schulungskonfigurationsversion dar.
evaluationOptions		EvaluationOptions	Stellt die Auswertungsoptionen dar. Standardmäßig ist die Auswertungsart Prozentsatz, wobei der Anteil der Schulung als 80 geteilt und der teilte Prozentsatz als 20 getestet wird.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen. Header Operation-Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Die Anforderung wurde zur Verarbeitung akzeptiert, die Verarbeitung wurde jedoch noch nicht abgeschlossen.

Header

Operation-Location: string

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

SuccessfulTrainProject

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 202

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

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
EvaluationKind
EvaluationOptions	Stellt die Optionen dar, die beim Ausführen der Auswertung verwendet werden.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingJobOptions	Stellt die Optionen zum Starten eines neuen Schulungsauftrags dar.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Lesbarer Fehlercode.

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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

EvaluationKind

Name	Typ	Beschreibung
manual	string	Teilen Sie die Daten nach dem ausgewählten Dataset für jedes Beispiel in den Daten.
percentage	string	Teilen Sie die Daten in Schulungs- und Testsätze gemäß benutzerdefinierten Prozentsätzen auf.

EvaluationOptions

Stellt die Optionen dar, die beim Ausführen der Auswertung verwendet werden.

Name	Typ	Beschreibung
kind	EvaluationKind	Stellt die Auswertungsart dar. Standardmäßig ist die Auswertungsart auf Prozent festgelegt.
testingSplitPercentage	integer	Stellt den geteilten Prozentsatz des Testdatensatzes dar. Wird nur benötigt, wenn der Auswertungstyp prozentual ist.
trainingSplitPercentage	integer	Stellt den geteilten Prozentsatz des Schulungsdatensatzes dar. Wird nur benötigt, wenn der Auswertungstyp prozentual ist.

InnerErrorCode

Lesbarer Fehlercode.

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

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

TrainingJobOptions

Stellt die Optionen zum Starten eines neuen Schulungsauftrags dar.

Name	Typ	Beschreibung
evaluationOptions	EvaluationOptions	Stellt die Auswertungsoptionen dar. Standardmäßig ist die Auswertungsart Prozentsatz, wobei der Anteil der Schulung als 80 geteilt und der teilte Prozentsatz als 20 getestet wird.
modelLabel	string	Stellt die Ausgabemodellbezeichnung dar.
trainingConfigVersion	string	Stellt die Schulungskonfigurationsversion dar.

Freigeben über

Text Analysis Authoring - Train

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

SuccessfulTrainProject

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorCode

ErrorResponse

EvaluationKind

EvaluationOptions

InnerErrorCode

InnerErrorModel

TrainingJobOptions

Zusätzliche Ressourcen