Conversational Analysis Authoring - Train
Löst einen Trainingsauftrag für ein Projekt aus.
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?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). |
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Client-API-Version. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
modelLabel | True |
string |
Stellt die Ausgabemodellbezeichnung dar. |
trainingMode | True |
Stellt den Modus des Trainingsvorgangs dar. |
|
evaluationOptions |
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 |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure 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 einem 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.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
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.
ist Authorization URL
spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von 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 Arbeit, Schule und Gäste, 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 Train Project
Beispielanforderung
POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2023-04-01
{
"modelLabel": "model1",
"trainingMode": "standard",
"trainingConfigVersion": "latest",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Beispiel für eine Antwort
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definitionen
Name | Beschreibung |
---|---|
Conversational |
Stellt die Optionen dar, die beim Ausführen der Auswertung verwendet werden. |
Conversational |
Stellt die Optionen zum Starten eines neuen Trainingsauftrags dar. |
Error |
Das Fehlerobjekt. |
Error |
Lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Evaluation |
Stellt die Auswertungsart dar. Standardmäßig ist die Auswertungsart auf Prozentsatz festgelegt. |
Inner |
Lesbarer Fehlercode. |
Inner |
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. |
Training |
Stellt den Modus des Trainingsvorgangs dar. |
ConversationalAnalysisAuthoringEvaluationOptions
Stellt die Optionen dar, die beim Ausführen der Auswertung verwendet werden.
Name | Typ | Beschreibung |
---|---|---|
kind |
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 |
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 |
Stellt den Modus des Trainingsvorgangs dar. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
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 |
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 |
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 |
Einer von einem serverdefiniertem Satz von 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. |
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. |