Conversational Analysis Authoring - Export

Service:

Cognitive Services - Language

Version d'API:

2023-04-01

Déclenche un travail pour exporter les données d’un projet.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01

Avec des paramètres facultatifs:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}&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.
stringIndexType	query	True	StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
assetKind	query		string	Type de ressource à exporter.
format	query		ExportedProjectFormat	Format du fichier projet exporté à utiliser.
trainedModelLabel	query		string	Étiquette de modèle entraînée à exporter. Si la valeur trainedModelLabel est null, le comportement par défaut consiste à exporter la copie de travail actuelle.

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.

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 Export Project

Exemple de requête

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01

Exemple de réponse

Code d’état:

202

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

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’utilisateur.
ErrorResponse	Réponse d’erreur.
ExportedProjectFormat	Format du fichier projet exporté à utiliser.
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.
StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

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.

ExportedProjectFormat

Format du fichier projet exporté à utiliser.

Nom	Type	Description
Conversation	string	Spécifie le format d’un projet conversationnel.
Luis	string	Spécifie le format d’une application qui a été exportée à partir de LUIS.

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.

StringIndexType

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

Nom	Type	Description
Utf16CodeUnit	string	Les valeurs de décalage et de longueur correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Java, JavaScript.