Miscellaneous Operations - Get Operation

Referens

Tjänst:: Azure AI Services

API-version:: 2024-07-31-preview

Hämtar åtgärdsinformation.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Slutpunkten för document intelligence-tjänsten.
operationId	path	True	string	Åtgärds-ID
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name	Typ	Description
200 OK	OperationDetails: DocumentClassifierBuildOperationDetails DocumentClassifierCopyToOperationDetails DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails	Begäran har slutförts. Sidhuvuden x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Name

Typ

Description

200 OK

OperationDetails:

DocumentClassifierBuildOperationDetails
DocumentClassifierCopyToOperationDetails
DocumentModelBuildOperationDetails
DocumentModelComposeOperationDetails
DocumentModelCopyToOperationDetails

Begäran har slutförts.

Sidhuvuden

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Get Operation

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
AzureBlobContentSource	Azure Blob Storage-innehåll.
AzureBlobFileListContentSource	Fillista i Azure Blob Storage.
ClassifierDocumentTypeDetails	Information om dokumenttyp för klassificerare.
ContentSourceKind	Typ av innehållskälla.
DocumentAnalysisFeature	Funktioner för dokumentanalys som ska aktiveras.
DocumentBuildMode	Genereringsläge för anpassad dokumentmodell.
DocumentClassifierBuildOperationDetails	Hämta åtgärdssvarsobjekt.
DocumentClassifierCopyToOperationDetails	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	Felobjektet.
ErrorResponse	Felsvarsobjekt.
InnerError	Ett objekt som innehåller mer specifik information om felet.
OperationKind	Typ av åtgärd.
OperationStatus	Åtgärdsstatus.
SplitMode	Beteende för fildelning.
Warning	Felobjektet.

AzureBlobContentSource

Azure Blob Storage-innehåll.

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

AzureBlobFileListContentSource

Fillista i Azure Blob Storage.

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

ClassifierDocumentTypeDetails

Information om dokumenttyp för klassificerare.

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage-fillista som anger träningsdata för en dokumenttyp för klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage-plats som innehåller träningsdata för en dokumenttyp för klassificerare. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
sourceKind	ContentSourceKind	Typ av träningsdatakälla.

ContentSourceKind

Typ av innehållskälla.

Name	Typ	Description
azureBlob	string	Filer i en sökväg i en Azure Blob Storage-container.
azureBlobFileList	string	En fillista som anger enskilda filer i en Azure Blob Storage-container.
base64	string	Innehåll som representeras via Base64-kodning.
url	string	Innehåll på en specifik URL.

DocumentAnalysisFeature

Funktioner för dokumentanalys som ska aktiveras.

Name	Typ	Description
barcodes	string	Aktivera identifiering av streckkoder i dokumentet.
formulas	string	Aktivera identifiering av matematiska uttryck i dokumentet.
keyValuePairs	string	Aktivera identifiering av allmänna nyckelvärdepar (formulärfält) i dokumentet.
languages	string	Aktivera identifiering av textinnehållsspråket.
ocrHighResolution	string	Utför OCR med högre upplösning för att hantera dokument med finstilt.
queryFields	string	Aktivera extrahering av ytterligare fält via frågeparametern queryFields.
styleFont	string	Aktivera igenkänning av olika teckensnittsformat.

DocumentBuildMode

Genereringsläge för anpassad dokumentmodell.

Name	Typ	Description
generative	string	Aktivera dokument av alla typer med generativa AI-tekniker.
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. notStarted, running, completed eller failed
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentClassifierCopyToOperationDetails

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: documentClassifierCopyTo	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. notStarted, running, completed eller failed
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.
baseClassifierId	string	Base classifierId ovanpå vilket klassificeraren tränades.
classifierId	string	Unikt namn på dokumentklassificerare.
createdDateTime	string	Datum och tid (UTC) när dokumentklassificeraren skapades.
description	string	Beskrivning av dokumentklassificerare.
docTypes	<string, ClassifierDocumentTypeDetails>	Lista över dokumenttyper som ska klassificeras mot.
expirationDateTime	string	Datum och tid (UTC) när dokumentklassificeraren upphör att gälla.
warnings	Warning[]	Lista över varningar som påträffades när klassificeraren byggdes.

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 FORMATET ISO 8601 (ÅÅÅÅ-MM-DD).
integer	string	Heltalsnummer, normaliserat till 64-bitars signerat 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 formatet E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matris med markerade strängvärden.
selectionMark	string	Är fältet markerat?
signature	string	Finns signaturen?
string	string	Klartext.
time	string	Tid, normaliserat 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. notStarted, running, completed eller failed
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. notStarted, running, completed eller failed
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. notStarted, running, completed eller failed
tags	object	Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentModelDetails

Dokumentmodellinformation.

Name	Typ	Standardvärde	Description
apiVersion	string		API-version som används för att skapa den här dokumentmodellen.
azureBlobFileListSource	AzureBlobFileListContentSource		Azure Blob Storage-fillista som anger träningsdata. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
azureBlobSource	AzureBlobContentSource		Azure Blob Storage-plats som innehåller träningsdata. Antingen azureBlobSource eller azureBlobFileListSource måste anges.
buildMode	DocumentBuildMode		Genereringsläge för anpassad dokumentmodell.
classifierId	string		För sammansatta modeller ska den anpassade klassificeraren dela upp och klassificera indatafilen.
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.
split	SplitMode	none	För sammansatta modeller fungerar fildelningen.
tags	object		Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.
trainingHours	number		Antal V100-motsvarande GPU-timmar som förbrukats för modellträning.
warnings	Warning[]		Lista över varningar som påträffades när modellen byggdes.

DocumentTypeDetails

Information om dokumenttyp.

Name	Typ	Description
buildMode	DocumentBuildMode	Genereringsläge för anpassad dokumentmodell.
confidenceThreshold	number	Utför endast analys om docType-konfidensen är över tröskelvärdet.
description	string	Beskrivning av dokumentmodell.
features	DocumentAnalysisFeature[]	Lista över valfria analysfunktioner.
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.
maxDocumentsToAnalyze	integer	Maximalt antal dokument av den angivna typen som ska analyseras. Default=all.
modelId	string	Dokumentmodell som ska användas för att analysera dokument med angiven typ.
queryFields	string[]	Lista över ytterligare fält som ska extraheras. Ex. "NumberOfGuests,StoreNumber"

Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Felsvarsobjekt.

Name	Typ	Description
error	Error	Felinformation.

InnerError

Ett objekt som innehåller mer specifik information om felet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	InnerError	Inre fel.
message	string	En mänsklig läsbar representation av felet.

OperationKind

Typ av åtgärd.

Name	Typ	Description
documentClassifierBuild	string	Skapa en ny anpassad klassificerarmodell.
documentClassifierCopyTo	string	Kopiera en befintlig dokumentklassificerare till en annan resurs, region eller prenumeration.
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.
completed	string	Åtgärden har slutförts.
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.

SplitMode

Beteende för fildelning.

Name	Typ	Description
auto	string	Dela automatiskt upp filen i dokument.
none	string	Behandla hela filen som ett enda dokument.
perPage	string	Behandla varje sida i filen som ett separat dokument.

Warning

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning varningskoder.
message	string	En mänsklig läsbar representation av varningen.
target	string	Målet för felet.

Dela via

Miscellaneous Operations - Get Operation

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

OAuth2Auth

Omfattningar

Exempel

Get Operation

Exempelbegäran

Exempelsvar

Definitioner

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

ContentSourceKind

DocumentAnalysisFeature

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierCopyToOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationKind

OperationStatus

SplitMode

Warning

Ytterligare resurser