Conversational Analysis Authoring - Train

Référence

Service:: Cognitive Services - Language

Version d'API:: 2022-05-01

Déclenche un travail de formation pour un projet.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nom du projet à utiliser.
api-version	query	True	string	Version d’API client.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Clé d’abonnement pour une ressource de service Language.

Corps de la demande

Nom	Obligatoire	Type	Description
modelLabel	True	string	Représente l’étiquette du modèle de sortie.
trainingMode	True	TrainingMode	Représente le mode de l’opération d’entraînement.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Représente les options d’évaluation. Par défaut, le type d’évaluation est pourcentage, le pourcentage de fractionnement d’entraînement étant de 80 et le pourcentage fractionné de test étant 20.
trainingConfigVersion		string	Représente la version de configuration d’entraînement. Par défaut, la valeur « latest » est utilisée, qui utilise la dernière version de la configuration d’entraînement publiée.

Réponses

Nom	Type	Description
202 Accepted		Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail. En-têtes operation-location: string
Other Status Codes	ErrorResponse	Réponse d’erreur.

Nom

Type

Description

202 Accepted

Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail.

En-têtes

operation-location: string

Other Status Codes

ErrorResponse

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Clé d’abonnement pour une ressource de service Language.

Type: apiKey
Dans: header

Exemples

Successful Train Project

Exemple de requête

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

Exemple de réponse

Code d’état:: 202

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

Définitions

Nom	Description
ConversationalAnalysisAuthoringEvaluationOptions	Représente les options utilisées pour exécuter l’évaluation.
ConversationalAnalysisAuthoringTrainingJobOptions	Représente les options de démarrage d’un nouveau travail d’entraînement.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’utilisateur.
ErrorResponse	Réponse d’erreur.
EvaluationKind	Représente le type d’évaluation. Par défaut, le type d’évaluation est défini sur pourcentage.
InnerErrorCode	Code d’erreur lisible par l’utilisateur.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Représente le mode de l’opération d’entraînement.

ConversationalAnalysisAuthoringEvaluationOptions

Représente les options utilisées pour exécuter l’évaluation.

Nom	Type	Description
kind	EvaluationKind	Représente le type d’évaluation. Par défaut, le type d’évaluation est défini sur pourcentage.
testingSplitPercentage	integer	Représente le pourcentage de fractionnement du jeu de données de test. Nécessaire uniquement dans le cas où le type d’évaluation est pourcentage.
trainingSplitPercentage	integer	Représente le pourcentage de fractionnement du jeu de données d’entraînement. Nécessaire uniquement dans le cas où le type d’évaluation est pourcentage.

ConversationalAnalysisAuthoringTrainingJobOptions

Représente les options de démarrage d’un nouveau travail d’entraînement.

Nom	Type	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Représente les options d’évaluation. Par défaut, le type d’évaluation est pourcentage, le pourcentage de fractionnement d’entraînement étant de 80 et le pourcentage fractionné de test étant 20.
modelLabel	string	Représente l’étiquette du modèle de sortie.
trainingConfigVersion	string	Représente la version de configuration d’entraînement. Par défaut, la valeur « latest » est utilisée, qui utilise la dernière version de la configuration d’entraînement publiée.
trainingMode	TrainingMode	Représente le mode de l’opération d’entraînement.

Error

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un des codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Code d’erreur lisible par l’utilisateur.

Nom	Type	Description
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

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

EvaluationKind

Représente le type d’évaluation. Par défaut, le type d’évaluation est défini sur pourcentage.

Nom	Type	Description
manual	string	Fractionnez les données en fonction du jeu de données choisi pour chaque exemple dans les données.
percentage	string	Fractionnez les données en groupes d’entraînement et de test en fonction des pourcentages définis par l’utilisateur.

InnerErrorCode

Code d’erreur lisible par l’utilisateur.

Nom	Type	Description
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

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un des codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

TrainingMode

Représente le mode de l’opération d’entraînement.

Nom	Type	Description
advanced	string	S’entraîne à l’aide de modèles de transformateur de réseau neuronal affinés. Peut entraîner des projets multilingues.
standard	string	Temps d’entraînement plus rapides pour des itérations plus rapides.

Partager via

Conversational Analysis Authoring - Train

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Successful Train Project

Exemple de requête

Exemple de réponse

Définitions

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Ressources supplémentaires