Miscellaneous Operations - Get Operation

Service:

Azure AI Services

API-versie:

2024-07-31-preview

Hiermee haalt u bewerkingsgegevens op.

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getOperation&api-version=2024-07-31-preview

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string uri	Het Eindpunt van de Document Intelligence-service.
operationId	path	True	string	Bewerkings-id
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	De aanvraag is voltooid. Kopteksten x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Get Operation

Voorbeeldaanvraag

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getOperation&api-version=2024-07-31-preview

Voorbeeldrespons

Statuscode:

200

{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentModelBuild",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel",
  "result": {
    "modelId": "myCustomModel",
    "description": "Custom model description",
    "createdDateTime": "2021-09-23T09:13:01Z",
    "apiVersion": "2024-07-31-preview"
  }
}

Definities

Name	Description
AzureBlobContentSource	Azure Blob Storage-inhoud.
AzureBlobFileListContentSource	Bestandslijst in Azure Blob Storage.
ClassifierDocumentTypeDetails	Informatie over het type classificatiedocument.
ContentSourceKind	Type inhoudsbron.
DocumentAnalysisFeature	Documentanalysefuncties die u wilt inschakelen.
DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
DocumentClassifierBuildOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentClassifierCopyToOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentClassifierDetails	Informatie over documentclassificatie.
DocumentFieldSchema	Beschrijving van het semantische veldschema met behulp van een syntaxis van de JSON-schemastijl.
DocumentFieldType	Semantisch gegevenstype van de veldwaarde.
DocumentModelBuildOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentModelComposeOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentModelCopyToOperationDetails	Bewerkingsantwoordobject ophalen.
DocumentModelDetails	Documentmodelgegevens.
DocumentTypeDetails	Informatie over documenttype.
Error	Het foutobject.
ErrorResponse	Foutantwoordobject.
InnerError	Een object met meer specifieke informatie over de fout.
OperationKind	Type bewerking.
OperationStatus	Bewerkingsstatus.
SplitMode	Gedrag voor het splitsen van bestanden.
Warning	Het foutobject.

AzureBlobContentSource

Azure Blob Storage-inhoud.

Name	Type	Description
containerUrl	string	Url van Azure Blob Storage-container.
prefix	string	Voorvoegsel van blobnaam.

AzureBlobFileListContentSource

Bestandslijst in Azure Blob Storage.

Name	Type	Description
containerUrl	string	Url van Azure Blob Storage-container.
fileList	string	Pad naar een JSONL-bestand in de container die een subset van documenten opgeeft.

ClassifierDocumentTypeDetails

Informatie over het type classificatiedocument.

Name	Type	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Lijst met Azure Blob Storage-bestanden waarin de trainingsgegevens voor een classificatiedocumenttype worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-locatie met de trainingsgegevens voor een classificatiedocumenttype. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
sourceKind	ContentSourceKind	Type trainingsgegevensbron.

ContentSourceKind

Type inhoudsbron.

Name	Type	Description
azureBlob	string	Bestanden in een pad binnen een Azure Blob Storage-container.
azureBlobFileList	string	Een bestandslijst waarin afzonderlijke bestanden in een Azure Blob Storage-container worden opgegeven.
base64	string	Inhoud die wordt weergegeven via Base64-codering.
url	string	Inhoud op een specifieke URL.

DocumentAnalysisFeature

Documentanalysefuncties die u wilt inschakelen.

Name	Type	Description
barcodes	string	Schakel de detectie van streepjescodes in het document in.
formulas	string	Schakel de detectie van wiskundige expressies in het document in.
keyValuePairs	string	Schakel de detectie van algemene sleutelwaardeparen (formuliervelden) in het document in.
languages	string	Schakel de detectie van de tekstinhoudstaal in.
ocrHighResolution	string	Voer OCR uit met een hogere resolutie om documenten met een kleine afdruk af te handelen.
queryFields	string	Schakel de extractie van extra velden in via de queryveld-queryparameter.
styleFont	string	Schakel de herkenning van verschillende lettertypestijlen in.

DocumentBuildMode

De buildmodus voor het aangepaste documentmodel.

Name	Type	Description
generative	string	Documenten van alle typen inschakelen met behulp van generatieve AI-technieken.
neural	string	Ondersteuning voor documenten met diverse visuele sjablonen.
template	string	Doeldocumenten met vergelijkbare visuele sjablonen.

DocumentClassifierBuildOperationDetails

Bewerkingsantwoordobject ophalen.

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.
error	Error	Er is een fout opgetreden.
kind	string: documentClassifierBuild	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentClassifierDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentClassifierCopyToOperationDetails

Bewerkingsantwoordobject ophalen.

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.
error	Error	Er is een fout opgetreden.
kind	string: documentClassifierCopyTo	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentClassifierDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentClassifierDetails

Informatie over documentclassificatie.

Name	Type	Description
apiVersion	string	API-versie die wordt gebruikt om deze documentclassificatie te maken.
baseClassifierId	string	Basisclassificatie-id bovenop waarvan de classificatie is getraind.
classifierId	string	Unieke naam van documentclassificatie.
createdDateTime	string	De datum en tijd (UTC) waarop de documentclassificatie is gemaakt.
description	string	Beschrijving van documentclassificatie.
docTypes	<string,  ClassifierDocumentTypeDetails>	Lijst met documenttypen die moeten worden geclassificeerd op basis van.
expirationDateTime	string	Datum en tijd (UTC) wanneer de documentclassificatie verloopt.
warnings	Warning[]	Lijst met waarschuwingen die zijn aangetroffen tijdens het bouwen van de classificatie.

DocumentFieldSchema

Beschrijving van het semantische veldschema met behulp van een syntaxis van de JSON-schemastijl.

Name	Type	Description
description	string	Veldbeschrijving.
example	string	Voorbeeld van veldinhoud.
items	DocumentFieldSchema	Het schema van het veldtype van elk matrixelement.
properties	<string,  DocumentFieldSchema>	Benoemde subvelden van het objectveld.
type	DocumentFieldType	Semantisch gegevenstype van de veldwaarde.

DocumentFieldType

Semantisch gegevenstype van de veldwaarde.

Name	Type	Description
address	string	Geparseerd adres.
array	string	Lijst met subvelden van hetzelfde type.
boolean	string	Booleaanse waarde, genormaliseerd tot waar of onwaar.
countryRegion	string	Land/regio, genormaliseerd naar ISO 3166-1 alfa-3-indeling (bijvoorbeeld VS).
currency	string	Valutabedrag met optioneel valutasymbool en -eenheid.
date	string	Datum, genormaliseerd naar ISO 8601-indeling (JJJJ-MM-DD).
integer	string	Geheel getal, genormaliseerd tot 64-bits ondertekend geheel getal.
number	string	Drijvendekommagetal, genormaliseerd tot drijvende komma met dubbele precisie.
object	string	Benoemde lijst met subvelden van mogelijk verschillende typen.
phoneNumber	string	Telefoonnummer, genormaliseerd naar E.164-indeling (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matrix van geselecteerde tekenreekswaarden.
selectionMark	string	Is het veld geselecteerd?
signature	string	Is de handtekening aanwezig?
string	string	Tekst zonder opmaak.
time	string	Tijd, genormaliseerd naar ISO 8601-indeling (uu:mm:ss).

DocumentModelBuildOperationDetails

Bewerkingsantwoordobject ophalen.

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.
error	Error	Er is een fout opgetreden.
kind	string: documentModelBuild	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentModelDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentModelComposeOperationDetails

Bewerkingsantwoordobject ophalen.

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.
error	Error	Er is een fout opgetreden.
kind	string: documentModelCompose	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentModelDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentModelCopyToOperationDetails

Bewerkingsantwoordobject ophalen.

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.
error	Error	Er is een fout opgetreden.
kind	string: documentModelCopyTo	Type bewerking.
lastUpdatedDateTime	string	Datum en tijd (UTC) waarop de status voor het laatst is bijgewerkt.
operationId	string	Bewerkings-id
percentCompleted	integer	Voortgang van de bewerking (0-100).
resourceLocation	string	URL van de resource waarop deze bewerking is gericht.
result	DocumentModelDetails	Bewerkingsresultaat bij succes.
status	OperationStatus	Bewerkingsstatus. notStarted, running, completed of failed
tags	object	Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.

DocumentModelDetails

Documentmodelgegevens.

Name	Type	Default value	Description
apiVersion	string		API-versie die wordt gebruikt om dit documentmodel te maken.
azureBlobFileListSource	AzureBlobFileListContentSource		Lijst met Azure Blob Storage-bestanden waarin de trainingsgegevens worden opgegeven. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
azureBlobSource	AzureBlobContentSource		Azure Blob Storage-locatie met de trainingsgegevens. AzureBlobSource of azureBlobFileListSource moet worden opgegeven.
buildMode	DocumentBuildMode		De buildmodus voor het aangepaste documentmodel.
classifierId	string		Voor samengestelde modellen kan de aangepaste classificatie het invoerbestand splitsen en classificeren.
createdDateTime	string		De datum en tijd (UTC) waarop het documentmodel is gemaakt.
description	string		Beschrijving van documentmodel.
docTypes	<string,  DocumentTypeDetails>		Ondersteunde documenttypen.
expirationDateTime	string		Datum en tijd (UTC) wanneer het documentmodel verloopt.
modelId	string		Unieke documentmodelnaam.
split	SplitMode	none	Voor samengestelde modellen is het gedrag van het splitsen van bestanden.
tags	object		Lijst met kenmerken van sleutel-waardetags die zijn gekoppeld aan het documentmodel.
trainingHours	number		Aantal V100-equivalente GPU-uren dat wordt gebruikt voor modeltraining.
warnings	Warning[]		Er is een lijst met waarschuwingen aangetroffen tijdens het bouwen van het model.

DocumentTypeDetails

Informatie over documenttype.

Name	Type	Description
buildMode	DocumentBuildMode	De buildmodus voor het aangepaste documentmodel.
confidenceThreshold	number	Voer alleen een analyse uit als de betrouwbaarheid van docType hoger is dan de drempelwaarde.
description	string	Beschrijving van documentmodel.
features	DocumentAnalysisFeature[]	Lijst met optionele analysefuncties.
fieldConfidence	object	Geschatte betrouwbaarheid voor elk veld.
fieldSchema	<string,  DocumentFieldSchema>	Beschrijving van het semantische documentschema met behulp van een syntaxis van de JSON-schemastijl.
maxDocumentsToAnalyze	integer	Maximum aantal documenten van het opgegeven type dat moet worden geanalyseerd. Default=all.
modelId	string	Documentmodel dat moet worden gebruikt voor het analyseren van documenten met een opgegeven type.
queryFields	string[]	Lijst met extra velden die moeten worden geëxtraheerd. Ex. "NumberOfGuests,StoreNumber"

Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorResponse

Foutantwoordobject.

Name	Type	Description
error	Error	Foutinformatie.

InnerError

Een object met meer specifieke informatie over de fout.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	InnerError	Interne fout.
message	string	Een leesbare weergave van de fout.

OperationKind

Type bewerking.

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

OperationStatus

Bewerkingsstatus.

Name	Type	Description
canceled	string	De bewerking is geannuleerd.
completed	string	De bewerking is voltooid.
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.

SplitMode

Gedrag voor het splitsen van bestanden.

Name	Type	Description
auto	string	Bestand automatisch splitsen in documenten.
none	string	Het hele bestand behandelen als één document.
perPage	string	Elke pagina in het bestand behandelen als een afzonderlijk document.

Warning

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set waarschuwingscodes.
message	string	Een leesbare weergave van de waarschuwing.
target	string	Het doel van de fout.