Miscellaneous - List Operations

Referentie

Service:: Azure AI Services

API Version:: 2022-08-31

Lijsten alle bewerkingen.

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

URI-parameters

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

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

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

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

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}"
}

Definities

Name	Description
ApiVersion	API-versie.
Error	Foutgegevens.
ErrorResponse	Foutreactieobject.
GetOperationsResponse	Het antwoordobject Voor bewerkingen weergeven.
InnerError	Gedetailleerde fout.
OperationKind	Type bewerking.
OperationStatus	Bewerkingsstatus.
OperationSummary	Bewerkingsgegevens.

ApiVersion

API-versie.

Name	Type	Description
2022-08-31	string

Error

Foutgegevens.

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

GetOperationsResponse

Het 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
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Bewerkingsstatus.

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

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