Conversational Analysis Authoring - Get Training Status
Ruft den Status für einen Trainingsauftrag ab.
GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
Die Auftrags-ID. |
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Client-API-Version. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Das Ergebnis des Trainingsauftrags. |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
Der Authorization URL
ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Typ:
apiKey
In:
header
Beispiele
Successful Get Train Status
Beispielanforderung
GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01
Beispiel für eine Antwort
{
"result": {
"modelLabel": "model1",
"trainingConfigVersion": "2022-05-01",
"trainingMode": "standard",
"estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
"trainingStatus": {
"percentComplete": 3,
"startDateTime": "2022-04-18T15:45:06.8190649Z",
"status": "running"
},
"evaluationStatus": {
"percentComplete": 0,
"status": "notStarted"
}
},
"jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
"createdDateTime": "2022-04-18T15:44:44Z",
"lastUpdatedDateTime": "2022-04-18T15:45:48Z",
"expirationDateTime": "2022-04-25T15:44:44Z",
"status": "running"
}
Definitionen
Name | Beschreibung |
---|---|
Conversational |
Stellt den detaillierten Zustand eines Trainingsteilvorgangs dar. |
Conversational |
Stellt die Ausgabe eines Trainingsauftrags dar. |
Conversational |
Stellt den Status eines Trainingsauftrags dar. |
Conversational |
Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist. |
Error |
Das Fehlerobjekt. |
Error |
Für Menschen lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Inner |
Für Menschen lesbarer Fehlercode. |
Inner |
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. |
Job |
Der Auftrag status. |
Training |
Stellt den Modus des Trainingsvorgangs dar. |
ConversationalAnalysisAuthoringSubTrainingJobState
Stellt den detaillierten Zustand eines Trainingsteilvorgangs dar.
Name | Typ | Beschreibung |
---|---|---|
endDateTime |
string |
Stellt die Enddatumszeit dar. |
percentComplete |
integer |
Stellt den Fortschrittsprozentsatz dar. |
startDateTime |
string |
Stellt die Startdatumszeit dar. |
status |
Stellt die status des Untervorgangs dar. |
ConversationalAnalysisAuthoringTrainingJobResult
Stellt die Ausgabe eines Trainingsauftrags dar.
Name | Typ | Beschreibung |
---|---|---|
estimatedEndDateTime |
string |
Stellt die geschätzte Enddatumszeit für Training und Auswertung dar. |
evaluationStatus |
Stellt status der Modellauswertung dar. |
|
modelLabel |
string |
Stellt eine trainierte Modellbezeichnung dar. |
trainingConfigVersion |
string |
Stellt die Trainingskonfigurationsversion dar. |
trainingMode |
Stellt den Modus des Trainingsvorgangs dar. |
|
trainingStatus |
Stellt das modelltraining status dar. |
ConversationalAnalysisAuthoringTrainingJobState
Stellt den Status eines Trainingsauftrags dar.
Name | Typ | Beschreibung |
---|---|---|
createdDateTime |
string |
Die Erstellungsdatumszeit des Auftrags. |
errors |
Error[] |
Die Beim Ausführen des Auftrags aufgetretenen Fehler. |
expirationDateTime |
string |
Die Ablaufdatumszeit des Auftrags. |
jobId |
string |
Die Auftrags-ID. |
lastUpdatedDateTime |
string |
Das Datum, an dem der Auftrag zuletzt aktualisiert wurde. |
result |
Stellt das detaillierte Ergebnis von Trainingsaufgaben dar. |
|
status |
Der Auftrag status. |
|
warnings |
Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind. |
ConversationalAnalysisAuthoringWarning
Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Warncode. |
message |
string |
Die Warnmeldung. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer der vom Server definierten Fehlercodes. |
|
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine für Menschen lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCode
Für Menschen 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 |
Das Fehlerobjekt. |
InnerErrorCode
Für Menschen 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 |
Einer der vom Server definierten Fehlercodes. |
|
details |
object |
Fehlerdetails. |
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Fehlermeldung. |
target |
string |
Fehlerziel. |
JobStatus
Der Auftrag status.
Name | Typ | Beschreibung |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TrainingMode
Stellt den Modus des Trainingsvorgangs dar.
Name | Typ | Beschreibung |
---|---|---|
advanced |
string |
Züge mit fein abgestimmten neuronalen Netztransformatorenmodellen. Kann mehrsprachige Projekte trainieren. |
standard |
string |
Schnellere Trainingszeiten für schnellere Iterationen. |