Conversational Analysis Authoring - Get Project

Service:

Azure AI Services

Version d'API:

2022-05-01

Obtient les détails d’un projet.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?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://< nom-ressource.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’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 de langues.

Réponses

Nom	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Les métadonnées du projet.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

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

Type: apiKey
Dans: header

Exemples

Successful Get Project

Exemple de requête

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01

Exemple de réponse

Code d’état:

200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

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.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
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.
ProjectKind	Représente le type de projet.

ConversationalAnalysisAuthoringProjectMetadata

Object

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

Nom	Type	Description
createdDateTime	string (date-time)	Représente la date 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 (date-time)	Représente la date et l’heure du dernier déploiement du projet.
lastModifiedDateTime	string (date-time)	Représente la date de création du projet.
lastTrainedDateTime	string (date-time)	Représente la dernière date/heure du dernier projet entraîné.
multilingual	boolean	Indique si le projet serait utilisé pour plusieurs langues ou non.
projectKind	ProjectKind	Représente le type de projet.
projectName	string	Nouveau nom du projet.
settings	ConversationalAnalysisAuthoringProjectSettings	Paramètres du projet.

ConversationalAnalysisAuthoringProjectSettings

Object

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

Nom	Type	Description
confidenceThreshold	number (float)	Seuil de l’intention avec le niveau de confiance le plus élevé, à partir duquel la prédiction sera automatiquement remplacée par « Aucun ».

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
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

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

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.

ProjectKind

Énumération

Représente le type de projet.

Valeur	Description
Conversation	Un projet visant à intégrer le langage naturel dans les applications, les bots et les appareils IoT.
Orchestration	Un projet pour connecter et orchestrer les projets Conversation, Questions personnalisées et LUIS en un seul projet.