Partager via


Conversational Analysis Authoring - Get Project Deletion Status

Obtient l’état d’une tâche de suppression de projet.

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}?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).

jobId
path True

string

ID du travail.

api-version
query True

string

Version d’API client.

Réponses

Nom Type Description
200 OK

ConversationalAnalysisAuthoringProjectDeletionJobState

Résultat du travail de suppression de projet.

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 ressource 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.

est Authorization URL 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, kits 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 Get Project Deletion Status

Exemple de requête

GET {Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-01

Exemple de réponse

{
  "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000",
  "createdDateTime": "2022-04-18T14:02:34Z",
  "lastUpdatedDateTime": "2022-04-18T14:02:34Z",
  "expirationDateTime": "2022-04-25T14:02:34Z",
  "status": "succeeded"
}

Définitions

Nom Description
ConversationalAnalysisAuthoringProjectDeletionJobState

Représente l’état d’un travail de suppression de projet.

ConversationalAnalysisAuthoringWarning

Représente un avertissement rencontré lors de l’exécution de la demande.

Error

Objet error.

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 de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

JobStatus

Le travail status.

ConversationalAnalysisAuthoringProjectDeletionJobState

Représente l’état d’un travail de suppression de projet.

Nom Type Description
createdDateTime

string

Date de création heure du travail.

errors

Error[]

Erreurs rencontrées lors de l’exécution du travail.

expirationDateTime

string

Date d’expiration heure du travail.

jobId

string

ID du travail.

lastUpdatedDateTime

string

Date de la dernière mise à jour du travail.

status

JobStatus

Le travail status.

warnings

ConversationalAnalysisAuthoringWarning[]

Avertissements rencontrés lors de l’exécution du travail.

ConversationalAnalysisAuthoringWarning

Représente un avertissement rencontré lors de l’exécution de la demande.

Nom Type Description
code

string

Code d’avertissement.

message

string

Message d'avertissement.

Error

Objet error.

Nom Type Description
code

ErrorCode

Un des ensembles de 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 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 error.

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 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 des ensembles 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.

JobStatus

Le travail status.

Nom Type Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string