Miscellaneous - Get Operation

Tjänst:

Azure AI Services

API-version:

2023-07-31

Hämtar åtgärdsinformation.

GET {endpoint}/formrecognizer/operations/{operationId}?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).
operationId	path	True	string uuid	Unikt åtgärds-ID. Reguljärt uttrycksmönster: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
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	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	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 Operation

Exempelbegäran

HTTP

GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

Exempelsvar

Statuskod:

200

{
  "operationId": "31533879936_426a3e4c-c6fb-4c83-937c-a92414c371a4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2023-07-31"
  }
}

Definitioner

Name	Description
AzureBlobContentSource	Azure Blob Storage innehåll.
AzureBlobFileListContentSource	Fillista i Azure Blob Storage.
ClassifierDocumentTypeDetails	Information om dokumenttyp för klassificerare.
DocumentBuildMode	Anpassat byggläge för dokumentmodell.
DocumentClassifierBuildOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentClassifierDetails	Information om dokumentklassificerare.
DocumentFieldSchema	Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.
DocumentFieldType	Semantisk datatyp för fältvärdet.
DocumentModelBuildOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelComposeOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelCopyToOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentModelDetails	Dokumentmodellinformation.
DocumentTypeDetails	Information om dokumenttyp.
Error	Felinformation.
ErrorResponse	Felsvarsobjekt.
InnerError	Detaljerat fel.
OperationStatus	Åtgärdsstatus.

AzureBlobContentSource

Azure Blob Storage innehåll.

Name	Typ	Description
containerUrl	string	Azure Blob Storage container-URL.
prefix	string	Prefix för blobnamn.

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

Name	Typ	Description
containerUrl	string	Azure Blob Storage container-URL.
fileList	string	Sökväg till en JSONL-fil i containern som anger en delmängd av dokument för träning.

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage fillista som anger träningsdata för en klassificerardokumenttyp. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage plats som innehåller träningsdata för en dokumenttyp för klassificeraren. Antingen azureBlobSource eller azureBlobFileListSource måste anges.

DocumentBuildMode

Anpassat byggläge för dokumentmodell.

Name	Typ	Description
neural	string	Stöd för dokument med olika visuella mallar.
template	string	Måldokument med liknande visuella mallar.

DocumentClassifierBuildOperationDetails

Hämta åtgärdssvarsobjekt.

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.
error	Error	Fel påträffades.
kind	string: documentClassifierBuild	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.
result	DocumentClassifierDetails	Åtgärdsresultat vid lyckat resultat.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentClassifierDetails

Information om dokumentklassificerare.

Name	Typ	Description
apiVersion	string	API-version som används för att skapa den här dokumentklassificeraren.
classifierId	string	Unikt dokumentklassificerarenamn.
createdDateTime	string	Datum och tid (UTC) när dokumentklassificeraren skapades.
description	string	Beskrivning av dokumentklassificerare.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lista över dokumenttyper att klassificera mot.
expirationDateTime	string	Datum och tid (UTC) när dokumentklassificeraren upphör att gälla.

DocumentFieldSchema

Beskrivning av fältets semantiska schema med hjälp av en syntax för JSON-schemaformat.

Name	Typ	Description
description	string	Fältbeskrivning.
example	string	Exempelfältinnehåll.
items	DocumentFieldSchema	Schema för fälttyp för varje matriselement.
properties	<string,  DocumentFieldSchema>	Namngivna underfält i objektfältet.
type	DocumentFieldType	Semantisk datatyp för fältvärdet.

DocumentFieldType

Semantisk datatyp för fältvärdet.

Name	Typ	Description
address	string	Parsad adress.
array	string	Lista över underfält av samma typ.
boolean	string	Booleskt värde, normaliserat till sant eller falskt.
countryRegion	string	Land/region, normaliserat till ISO 3166-1 alfa-3-format (till exempel USA).
currency	string	Valutabelopp med valfri valutasymbol och enhet.
date	string	Datum, normaliserat till ISO 8601-format (ÅÅÅÅ-MM-DD).
integer	string	Heltalsnummer, normaliserat till 64-bitars heltal.
number	string	Flyttalsnummer, normaliserat till flyttal med dubbel precision.
object	string	Namngiven lista över underfält av potentiellt olika typer.
phoneNumber	string	Telefonnummer, normaliserat till E.164-format (+{CountryCode}{SubscriberNumber}).
selectionMark	string	Är fältet markerat?
signature	string	Finns signaturen?
string	string	Oformaterad text.
time	string	Tid, normaliserad till ISO 8601-format (hh:mm:ss).

DocumentModelBuildOperationDetails

Hämta åtgärdssvarsobjekt.

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.
error	Error	Fel påträffades.
kind	string: documentModelBuild	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.
result	DocumentModelDetails	Åtgärdsresultat vid lyckat resultat.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentModelComposeOperationDetails

Hämta åtgärdssvarsobjekt.

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.
error	Error	Fel påträffades.
kind	string: documentModelCompose	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.
result	DocumentModelDetails	Åtgärdsresultat vid lyckat resultat.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentModelCopyToOperationDetails

Hämta åtgärdssvarsobjekt.

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.
error	Error	Fel påträffades.
kind	string: documentModelCopyTo	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.
result	DocumentModelDetails	Åtgärdsresultat vid lyckat resultat.
status	OperationStatus	Åtgärdsstatus.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentModelDetails

Dokumentmodellinformation.

Name	Typ	Description
apiVersion	string	API-version som används för att skapa den här dokumentmodellen.
createdDateTime	string	Datum och tid (UTC) när dokumentmodellen skapades.
description	string	Beskrivning av dokumentmodell.
docTypes	<string,  DocumentTypeDetails>	Dokumenttyper som stöds.
expirationDateTime	string	Datum och tid (UTC) när dokumentmodellen upphör att gälla.
modelId	string	Unikt dokumentmodellnamn.
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentTypeDetails

Information om dokumenttyp.

Name	Typ	Description
buildMode	DocumentBuildMode	Anpassat byggläge för dokumentmodell.
description	string	Beskrivning av dokumentmodell.
fieldConfidence	object	Uppskattad konfidens för varje fält.
fieldSchema	<string,  DocumentFieldSchema>	Beskrivning av dokumentets semantiska schema med hjälp av en syntax för JSON-schemaformat.

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.

InnerError

Detaljerat fel.

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

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.