Miscellaneous - List Operations

Référence

Service:: Azure AI Services

API Version:: 2022-08-31

Listes toutes les opérations.

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Réponses

Nom	Type	Description
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Erreur rencontrée.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

GetOperations

Sample Request

HTTP

GET {endpoint}/formrecognizer/operations?api-version=2022-08-31

Sample Response

Status code:: 200

{
  "value": [
    {
      "operationId": "{operationId}",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "{endpoint}/formrecognizer/documentModels/{modelId}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

Définitions

Nom	Description
ApiVersion	Version de l’API.
Error	Informations sur l’erreur.
ErrorResponse	Objet de réponse d’erreur.
GetOperationsResponse	Objet de réponse Opérations de liste.
InnerError	Erreur détaillée.
OperationKind	Type d’opération.
OperationStatus	État de l’opération.
OperationSummary	Informations sur l’opération.

ApiVersion

Version de l’API.

Nom	Type	Description
2022-08-31	string

Error

Informations sur l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
details	Error[]	Liste des erreurs détaillées.
innererror	InnerError	Erreur détaillée.
message	string	Message d’erreur.
target	string	Cible de l’erreur.

ErrorResponse

Objet de réponse d’erreur.

Nom	Type	Description
error	Error	Informations sur l’erreur.

GetOperationsResponse

Objet de réponse Opérations de liste.

Nom	Type	Description
nextLink	string	Lien vers la page d’opérations suivante.
value	OperationSummary[]	Liste des opérations.

InnerError

Erreur détaillée.

Nom	Type	Description
code	string	Code d’erreur.
innererror	InnerError	Erreur détaillée.
message	string	Message d’erreur.

OperationKind

Type d’opération.

Nom	Type	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

État de l’opération.

Nom	Type	Description
canceled	string
failed	string
notStarted	string
running	string
succeeded	string

OperationSummary

Informations sur l’opération.

Nom	Type	Description
apiVersion	string	Version de l’API utilisée pour créer cette opération.
createdDateTime	string	Date et heure (UTC) de création de l’opération.
kind	OperationKind	Type d’opération.
lastUpdatedDateTime	string	Date et heure (UTC) de la dernière mise à jour du status.
operationId	string	ID de l'opération
percentCompleted	integer	Progression de l’opération (0-100).
resourceLocation	string	URL de la ressource ciblée par cette opération.
status	OperationStatus	État de l’opération.
tags	object	Liste des attributs de balise clé-valeur associés au modèle de document.

Partager via