Conversational Analysis Authoring - List Projects

Référence

Service:: Cognitive Services - Language

Version d'API:: 2023-04-01

Listes les projets existants.

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

Avec des paramètres facultatifs:

GET {Endpoint}/language/authoring/analyze-conversations/projects?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).
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	ConversationalAnalysisAuthoringProjectsMetadata	Métadonnées des projets.
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 Projects

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "createdDateTime": "2022-04-18T14:03:16Z",
      "lastModifiedDateTime": "2022-04-18T14:03:16Z",
      "projectKind": "Conversation",
      "projectName": "myproject1",
      "multilingual": false,
      "description": "This is a sample conversation project.",
      "language": "en"
    },
    {
      "createdDateTime": "2022-04-18T14:03:12Z",
      "lastModifiedDateTime": "2022-04-18T14:03:12Z",
      "projectKind": "Conversation",
      "projectName": "myproject",
      "multilingual": false,
      "description": "This is a sample conversation project.",
      "language": "en"
    }
  ],
  "nextLink": null
}

Définitions

Nom	Description
ConversationalAnalysisAuthoringProjectMetadata	Représente les métadonnées d’un projet.
ConversationalAnalysisAuthoringProjectSettings	Représente les paramètres utilisés pour définir le comportement du projet.
ConversationalAnalysisAuthoringProjectsMetadata	Représente une liste des métadonnées des projets 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.
ProjectKind	Représente le type de projet.

ConversationalAnalysisAuthoringProjectMetadata

Représente les métadonnées d’un projet.

Nom	Type	Description
createdDateTime	string	Représente la date heure de création du projet.
description	string	Description du projet.
language	string	Langue du projet. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, « en-gb » pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
lastDeployedDateTime	string	Représente le projet datetime du dernier déploiement.
lastModifiedDateTime	string	Représente la date heure de création du projet.
lastTrainedDateTime	string	Représente le dateheure de la dernière formation du projet.
multilingual	boolean	Indique si le projet doit être utilisé pour plusieurs langues ou non.
projectKind	ProjectKind	Représente le type de projet.
projectName	string	Nom du nouveau projet.
settings	ConversationalAnalysisAuthoringProjectSettings	Paramètres du projet.

ConversationalAnalysisAuthoringProjectSettings

Représente les paramètres utilisés pour définir le comportement du projet.

Nom	Type	Description
confidenceThreshold	number	Seuil de l’intention avec le niveau de confiance le plus élevé, auquel la prédiction sera automatiquement remplacée par « Aucun ». La valeur du seuil doit être comprise entre 0 et 1 inclus.

ConversationalAnalysisAuthoringProjectsMetadata

Représente une liste des métadonnées des projets récupérés.

Nom	Type	Description
nextLink	string	Lien de la page suivante.
value	ConversationalAnalysisAuthoringProjectMetadata[]	Liste des projets.

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