Text Analysis Authoring - Train

Référence

Service:: Azure AI Services

Version d'API:: 2022-05-01

Déclenche un travail de formation pour un projet.

POST {Endpoint}/language/authoring/analyze-text/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 maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

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

Corps de la demande

Nom	Obligatoire	Type	Description
modelLabel	True	string	Représente l’étiquette du modèle de sortie.
trainingConfigVersion	True	string	Représente la version de configuration d’entraînement.
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	Représente les options d’évaluation. Par défaut, le type d’évaluation est pourcentage, avec le pourcentage de fractionnement de l’entraînement sur 80 et le pourcentage de fractionnement de test sur 20.

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 de langage.

Type: apiKey
Dans: header

Exemples

Successful Train Project

Exemple de requête

HTTP

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


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

Exemple de réponse

Code d’état:: 202

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

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
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’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringEvaluationOptions	Représente les options utilisées pour exécuter l’évaluation.
TextAnalysisAuthoringTrainingJobOptions	Représente les options de démarrage d’un nouveau travail d’entraînement.

Error

Object

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des 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

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

EvaluationKind

Énumération

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

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

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

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

Nom	Type	Description
code	InnerErrorCode	Un ensemble de 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.

TextAnalysisAuthoringEvaluationOptions

Object

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 (int32)	Représente le pourcentage de fractionnement du jeu de données de test. Uniquement nécessaire au cas où le type d’évaluation était pourcentage.
trainingSplitPercentage	integer (int32)	Représente le pourcentage de fractionnement du jeu de données d’entraînement. Uniquement nécessaire au cas où le type d’évaluation était pourcentage.