Miscellaneous - List Operations

Tjänst:

Azure AI Services

API-version:

2022-08-31

Listor alla åtgärder.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	ApiVersion	Begärd API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	GetOperationsResponse	OK.
Other Status Codes	ErrorResponse	Fel påträffades.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

GetOperations

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
ApiVersion	API-version.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
GetOperationsResponse	Svarsobjekt för liståtgärder.
InnerError	Detaljerat fel.
OperationKind	Typ av åtgärd.
OperationStatus	Åtgärdsstatus.
OperationSummary	Åtgärdsinformation.

ApiVersion

API-version.

Name	Typ	Description
2022-08-31	string

Error

Felinformation.

Name	Typ	Description
code	string	Felkod.
details	Error[]	Lista över detaljerade fel.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

GetOperationsResponse

Svarsobjekt för liståtgärder.

Name	Typ	Description
nextLink	string	Länka till nästa sida med åtgärder.
value	OperationSummary[]	Lista över åtgärder.

InnerError

Detaljerat fel.

Name	Typ	Description
code	string	Felkod.
innererror	InnerError	Detaljerat fel.
message	string	Felmeddelande.

OperationKind

Typ av åtgärd.

Name	Typ	Description
documentModelBuild	string
documentModelCompose	string
documentModelCopyTo	string

OperationStatus

Åtgärdsstatus.

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

OperationSummary

Åtgärdsinformation.

Name	Typ	Description
apiVersion	string	API-version som används för att skapa den här åtgärden.
createdDateTime	string	Datum och tid (UTC) när åtgärden skapades.
kind	OperationKind	Typ av åtgärd.
lastUpdatedDateTime	string	Datum och tid (UTC) när statusen senast uppdaterades.
operationId	string	Åtgärds-ID
percentCompleted	integer	Åtgärdsförlopp (0–100).
resourceLocation	string	URL för den resurs som åtgärden riktar sig till.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.