Miscellaneous - List Operations

Referentie

Service:: Azure AI Services

API-versie:: 2023-07-31

Lijsten alle bewerkingen.

GET {endpoint}/formrecognizer/operations?api-version=2023-07-31

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Antwoorden

Name	Type	Description
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

De geheime sleutel voor uw Azure Cognitive Services-abonnement.

Type: apiKey
In: header

Voorbeelden

Get Operations

Voorbeeldaanvraag

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?api-version=2023-07-31

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
      "status": "running",
      "percentCompleted": 0,
      "createdDateTime": "2021-09-23T09:12:57Z",
      "lastUpdatedDateTime": "2021-09-23T09:12:58Z",
      "kind": "documentModelBuild",
      "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
      "apiVersion": "2023-07-31"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations?nextLink=nextLinkData"
}

Definities

Name	Description
Error	Foutinformatie.
ErrorResponse	Foutreactieobject.
GetOperationsResponse	Antwoordobject Voor bewerkingen weergeven.
InnerError	Gedetailleerde fout.
OperationKind	Type bewerking.
OperationStatus	Bewerkingsstatus.
OperationSummary	Bewerkingsgegevens.

Error

Foutinformatie.

Name	Type	Description
code	string	Foutcode.
details	Error[]	Lijst met gedetailleerde fouten.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.
target	string	Doel van de fout.

ErrorResponse

Foutreactieobject.

Name	Type	Description
error	Error	Foutinformatie.

GetOperationsResponse

Antwoordobject Voor bewerkingen weergeven.

Name	Type	Description
nextLink	string	Koppeling naar de volgende pagina met bewerkingen.
value	OperationSummary[]	Lijst met bewerkingen.

InnerError

Gedetailleerde fout.

Name	Type	Description
code	string	Foutcode.
innererror	InnerError	Gedetailleerde fout.
message	string	Foutbericht.

OperationKind

Type bewerking.

Name	Type	Description
documentClassifierBuild	string	Bouw een nieuw aangepast classificatiemodel.
documentModelBuild	string	Bouw een nieuw aangepast documentmodel.
documentModelCompose	string	Een nieuw aangepast documentmodel opstellen op basis van bestaande modellen.
documentModelCopyTo	string	Kopieer een bestaand documentmodel naar een mogelijk andere resource, regio of abonnement.

OperationStatus

Bewerkingsstatus.

Name	Type	Description
canceled	string	De bewerking is geannuleerd.
failed	string	De bewerking is mislukt.
notStarted	string	De bewerking is nog niet gestart.
running	string	De bewerking wordt uitgevoerd.
succeeded	string	De bewerking is voltooid.

OperationSummary

Bewerkingsgegevens.

Name	Type	Description
apiVersion	string	API-versie die wordt gebruikt om deze bewerking te maken.
createdDateTime	string	De datum en tijd (UTC) waarop de bewerking is gemaakt.
kind	OperationKind	Type bewerking.
lastUpdatedDateTime	string	De datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
status	OperationStatus	Bewerkingsstatus.
tags	object	Lijst met sleutel-waardetagkenmerken die zijn gekoppeld aan het documentmodel.

Delen via