Conversational Analysis Authoring - List Trained Models

Référence

Service:: Cognitive Services - Language

Version d'API:: 2023-04-01

Listes les modèles entraînés appartenant à un projet.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models?api-version=2023-04-01

Avec des paramètres facultatifs:

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-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.
maxpagesize	query		integer int32	Nombre maximal de ressources à inclure dans une réponse unique.
skip	query		integer int32	Décalage dans la collection de la première ressource à retourner.
top	query		integer int32	Nombre maximal de ressources à retourner à partir de la collection.

Réponses

Nom	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectTrainedModels	Liste de tous les modèles entraînés.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active directory. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

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

Type: apiKey
Dans: header

Exemples

Successful List Models

Exemple de requête

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models?api-version=2023-04-01

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "label": "model1",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49Z",
      "lastTrainingDurationInSeconds": 186,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    },
    {
      "label": "model2",
      "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99",
      "lastTrainedDateTime": "2022-04-18T17:25:22Z",
      "lastTrainingDurationInSeconds": 192,
      "modelExpirationDate": "2022-10-28",
      "modelTrainingConfigVersion": "2022-05-01",
      "hasSnapshot": true
    }
  ],
  "nextLink": null
}

Définitions

Nom	Description
ConversationalAnalysisAuthoringProjectTrainedModel	Représente un modèle entraîné.
ConversationalAnalysisAuthoringProjectTrainedModels	Représente une liste de modèles entraînés récupérés.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’utilisateur.
ErrorResponse	Réponse d’erreur.
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.

ConversationalAnalysisAuthoringProjectTrainedModel

Représente un modèle entraîné.

Nom	Type	Description
hasSnapshot	boolean	Indicateur pour indiquer si le modèle entraîné a un instantané prêt.
label	string	Étiquette du modèle entraîné.
lastTrainedDateTime	string	Date de dernière formation heure du modèle.
lastTrainingDurationInSeconds	integer	Durée de la dernière demande d’entraînement du modèle en secondes.
modelExpirationDate	string	Date d’expiration du modèle.
modelId	string	ID de modèle.
modelTrainingConfigVersion	string	Version de la configuration d’entraînement du modèle.

ConversationalAnalysisAuthoringProjectTrainedModels

Représente une liste de modèles entraînés récupérés.

Nom	Type	Description
nextLink	string	Lien de la page suivante.
value	ConversationalAnalysisAuthoringProjectTrainedModel[]	Liste des travaux récupérés.

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.

InnerErrorCode