Miscellaneous - List Operations

Referens

Tjänst:: Azure AI Services

API-version:: 2023-07-31

Listor alla åtgärder.

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

URI-parametrar

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

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Svar

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

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure Cognitive Services-prenumeration.

Typ: apiKey
I: header

Exempel

Get Operations

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
GetOperationsResponse	Liståtgärdssvarsobjekt.
InnerError	Detaljerat fel.
OperationKind	Typ av åtgärd.
OperationStatus	Åtgärdsstatus.
OperationSummary	Åtgärdsinformation.

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

Liståtgärdssvarsobjekt.

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
documentClassifierBuild	string	Skapa en ny anpassad klassificerarmodell.
documentModelBuild	string	Skapa en ny anpassad dokumentmodell.
documentModelCompose	string	Skapa en ny anpassad dokumentmodell från befintliga modeller.
documentModelCopyTo	string	Kopiera en befintlig dokumentmodell till en annan resurs, region eller prenumeration.

OperationStatus

Åtgärdsstatus.

Name	Typ	Description
canceled	string	Åtgärden har avbrutits.
failed	string	Åtgärden misslyckades.
notStarted	string	Åtgärden har inte startats än.
running	string	Åtgärden pågår.
succeeded	string	Åtgärden har slutförts.

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 mot.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över nyckel/värde-taggattribut som är associerade med dokumentmodellen.

Dela via