Conversational Analysis Authoring - Train

Referenz

Dienst:: Cognitive Services - Language

API-Version:: 2022-05-01

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	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	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Ein Abonnementschlüssel für eine Sprachdienstressource.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
modelLabel	True	string	Stellt die Ausgabemodellbezeichnung dar.
trainingMode	True	TrainingMode	Stellt den Modus des Trainingsvorgangs dar.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Stellt die Auswertungsoptionen dar. Standardmäßig ist die Auswertungsart Prozentsatz, wobei der Anteil der Trainingsaufteilung 80 und der Testanteil 20 ist.
trainingConfigVersion		string	Stellt die Trainingskonfigurationsversion dar. Standardmäßig wird der Wert "latest" verwendet, der die neueste veröffentlichte Version der Trainingskonfiguration verwendet.

Antworten

Name	Typ	Beschreibung
202 Accepted		Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird. Header operation-location: string
Other Status Codes	ErrorResponse	Fehlerantwort.

Name

Typ

Beschreibung

202 Accepted

Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird.

Header

operation-location: string

Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful Train Project

Beispielanforderung

HTTP

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


{
  "modelLabel": "model1",
  "trainingMode": "standard",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

Beispiel für eine Antwort

Statuscode:: 202

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

Definitionen

Name	Beschreibung
ConversationalAnalysisAuthoringEvaluationOptions	Stellt die Optionen dar, die beim Ausführen der Auswertung verwendet werden.
ConversationalAnalysisAuthoringTrainingJobOptions	Stellt die Optionen zum Starten eines neuen Trainingsauftrags dar.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
EvaluationKind	Stellt die Auswertungsart dar. Standardmäßig ist die Auswertungsart auf Prozentsatz festgelegt.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Stellt den Modus des Trainingsvorgangs dar.

ConversationalAnalysisAuthoringEvaluationOptions

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 Prozentsatz festgelegt.
testingSplitPercentage	integer	Stellt den geteilten Prozentsatz des Testdatasets dar. Nur erforderlich, wenn die Auswertungsart prozentual ist.
trainingSplitPercentage	integer	Stellt den geteilten Prozentsatz des Trainingsdatasets dar. Nur erforderlich, wenn die Auswertungsart prozentual ist.

ConversationalAnalysisAuthoringTrainingJobOptions

Stellt die Optionen zum Starten eines neuen Trainingsauftrags dar.

Name	Typ	Beschreibung
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Stellt die Auswertungsoptionen dar. Standardmäßig ist die Auswertungsart Prozentsatz, wobei der Anteil der Trainingsaufteilung 80 und der Testanteil 20 ist.
modelLabel	string	Stellt die Ausgabemodellbezeichnung dar.
trainingConfigVersion	string	Stellt die Trainingskonfigurationsversion dar. Standardmäßig wird der Wert "latest" verwendet, der die neueste veröffentlichte Version der Trainingskonfiguration verwendet.
trainingMode	TrainingMode	Stellt den Modus des Trainingsvorgangs dar.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer von einem serverdefiniertem Satz 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

Stellt die Auswertungsart dar. Standardmäßig ist die Auswertungsart auf Prozentsatz festgelegt.

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

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 Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Einer von einem serverdefiniertem Satz 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.

TrainingMode

Stellt den Modus des Trainingsvorgangs dar.

Name	Typ	Beschreibung
advanced	string	Trainiert mit fein abgestimmten neuronalen Netztransformatormodellen. Kann mehrsprachige Projekte trainieren.
standard	string	Schnellere Trainingszeiten für schnellere Iterationen.

Freigeben über

Conversational Analysis Authoring - Train

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Successful Train Project

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Zusätzliche Ressourcen