Miscellaneous Operations - List Operations

Service:

Azure AI Services

API Version:

2024-02-29-preview

Listák minden műveletet.

GET {endpoint}/documentintelligence/operations?api-version=2024-02-29-preview

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	A kérés átlátszatlan, globálisan egyedi, ügyfél által létrehozott sztringazonosítója.

Válaszok

Name	Típus	Description
200 OK	PagedOperationDetails	A kérés sikeres volt. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Példák

Get Operations

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?api-version=2024-02-29-preview

Sample Response

Status code:

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/documentintelligence/documentModels/myCustomModel",
      "apiVersion": "2024-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations?nextLink=nextLinkData"
}

Definíciók

Name	Description
AzureBlobContentSource	Azure Blob Storage tartalmat.
AzureBlobFileListContentSource	Fájllista Azure Blob Storage.
ClassifierDocumentTypeDetails	Az osztályozó dokumentumtípusának adatai.
ContentSourceKind	A tartalomforrás típusa.
DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
DocumentClassifierBuildOperationDetails	Művelet válaszobjektumának lekérése.
DocumentClassifierDetails	Dokumentumosztályozó adatai.
DocumentFieldSchema	A mező szemantikai sémájának leírása JSON sémastílus-szintaxissal.
DocumentFieldType	A mezőérték szemantikai adattípusa.
DocumentModelBuildOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelComposeOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelCopyToOperationDetails	Művelet válaszobjektumának lekérése.
DocumentModelDetails	Dokumentummodell adatai.
DocumentTypeDetails	Dokumentumtípus adatai.
Error	A hibaobjektum.
ErrorResponse	Hibaválasz-objektum.
InnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról.
OperationKind	A művelet típusa.
OperationStatus	Művelet állapota.
PagedOperationDetails	OperationDetails elemek lapozott gyűjteménye
Warning	A hibaobjektum.

AzureBlobContentSource

Azure Blob Storage tartalmat.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
prefix	string	Blobnév előtagja.

AzureBlobFileListContentSource

Fájllista Azure Blob Storage.

Name	Típus	Description
containerUrl	string	Azure Blob Storage tároló URL-címe.
fileList	string	Egy JSONL-fájl elérési útja a tárolóban, amely a dokumentumok egy részhalmazát adja meg.

ClassifierDocumentTypeDetails

Az osztályozó dokumentumtípusának adatai.

Name	Típus	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage fájllista, amely megadja az osztályozó dokumentumtípus betanítási adatait. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage osztályozó dokumentumtípus betanítási adatait tartalmazó hely. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
sourceKind	ContentSourceKind	A betanítási adatforrás típusa.

ContentSourceKind

A tartalomforrás típusa.

Name	Típus	Description
azureBlob	string	Fájlok egy Azure Blob Storage tárolóban lévő elérési úton.
azureBlobFileList	string	Egy Azure Blob Storage tároló egyes fájljait meghatározó fájllista.
base64	string	A Base64-kódolással ábrázolt tartalom.
url	string	Adott URL-címen lévő tartalom.

DocumentBuildMode

Egyéni dokumentummodell összeállítási módja.

Name	Típus	Description
neural	string	Különböző vizualizációs sablonokat tartalmazó dokumentumok támogatása.
template	string	Céldokumentumok hasonló vizualizációs sablonokkal.

DocumentClassifierBuildOperationDetails

Művelet válaszobjektumának lekérése.

Name	Típus	Description
apiVersion	string	A művelet létrehozásához használt API-verzió.
createdDateTime	string	A művelet létrehozásának dátuma és időpontja (UTC).
error	Error	Hiba történt.
kind	string: documentClassifierBuild	A művelet típusa.
lastUpdatedDateTime	string	Az állapot legutóbbi frissítésének dátuma és időpontja (UTC).
operationId	string	Művelet azonosítója
percentCompleted	integer	Művelet állapota (0-100).
resourceLocation	string	A művelet által megcélzott erőforrás URL-címe.
result	DocumentClassifierDetails	A művelet sikeres lesz.
status	OperationStatus	Művelet állapota. notStarted, running, completed vagy failed
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentClassifierDetails

Dokumentumosztályozó adatai.

Name	Típus	Description
apiVersion	string	A dokumentumosztályozó létrehozásához használt API-verzió.
baseClassifierId	string	Alaposztályozóazonosító, amelyre az osztályozó betanítása megtörtént.
classifierId	string	Egyedi dokumentumosztályozó neve.
createdDateTime	string	A dokumentumosztályozó létrehozásának dátuma és időpontja (UTC).
description	string	Dokumentumosztályozó leírása.
docTypes	<string,  ClassifierDocumentTypeDetails>	Az osztályozandó dokumentumtípusok listája.
expirationDateTime	string	A dokumentumosztályozó lejáratának dátuma és időpontja (UTC).
warnings	Warning[]	Az osztályozó létrehozásakor észlelt figyelmeztetések listája.

DocumentFieldSchema

A mező szemantikai sémájának leírása JSON sémastílus-szintaxissal.

Name	Típus	Description
description	string	Mező leírása.
example	string	Példamező tartalma.
items	DocumentFieldSchema	Az egyes tömbelemek mezőtípus-sémája.
properties	<string,  DocumentFieldSchema>	Az objektummező elnevezett almezői.
type	DocumentFieldType	A mezőérték szemantikai adattípusa.

DocumentFieldType

A mezőérték szemantikai adattípusa.

Name	Típus	Description
address	string	Elemzett cím.
array	string	Az azonos típusú almezők listája.
boolean	string	Logikai érték, igaz vagy hamis értékre normalizálva.
countryRegion	string	Ország/régió, iso 3166-1 alfa-3 formátumra normalizálva (pl. USA).
currency	string	Pénznem összege választható pénznemszimbólummal és egységgel.
date	string	Dátum, iso 8601 (YYYY-MM-DD) formátumra normalizálva.
integer	string	Egész szám, normalizálva 64 bites aláírt egész számra.
number	string	Lebegőpontos szám, normalizálva dupla pontosságú lebegőpontosra.
object	string	A potenciálisan különböző típusú almezők nevesített listája.
phoneNumber	string	E.164-es (+{CountryCode}{SubscriberNumber}) formátumú telefonszám.
selectionGroup	string	A kijelölt sztringértékek tömbje.
selectionMark	string	Ki van jelölve a mező?
signature	string	Jelen van aláírás?
string	string	Egyszerű szöveg.
time	string	Iso 8601 (óó:mm:ss) formátumra normalizált idő.

DocumentModelBuildOperationDetails

Művelet válaszobjektumának lekérése.

Name	Típus	Description
apiVersion	string	A művelet létrehozásához használt API-verzió.
createdDateTime	string	A művelet létrehozásának dátuma és időpontja (UTC).
error	Error	Hiba történt.
kind	string: documentModelBuild	A művelet típusa.
lastUpdatedDateTime	string	Az állapot legutóbbi frissítésének dátuma és időpontja (UTC).
operationId	string	Művelet azonosítója
percentCompleted	integer	Művelet állapota (0-100).
resourceLocation	string	A művelet által megcélzott erőforrás URL-címe.
result	DocumentModelDetails	A művelet sikeres lesz.
status	OperationStatus	Művelet állapota. notStarted, running, completed vagy failed
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentModelComposeOperationDetails

Művelet válaszobjektumának lekérése.

Name	Típus	Description
apiVersion	string	A művelet létrehozásához használt API-verzió.
createdDateTime	string	A művelet létrehozásának dátuma és időpontja (UTC).
error	Error	Hiba történt.
kind	string: documentModelCompose	A művelet típusa.
lastUpdatedDateTime	string	Az állapot legutóbbi frissítésének dátuma és időpontja (UTC).
operationId	string	Művelet azonosítója
percentCompleted	integer	Művelet állapota (0-100).
resourceLocation	string	A művelet által megcélzott erőforrás URL-címe.
result	DocumentModelDetails	A művelet sikeres lesz.
status	OperationStatus	Művelet állapota. notStarted, running, completed vagy failed
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentModelCopyToOperationDetails

Művelet válaszobjektumának lekérése.

Name	Típus	Description
apiVersion	string	A művelet létrehozásához használt API-verzió.
createdDateTime	string	A művelet létrehozásának dátuma és időpontja (UTC).
error	Error	Hiba történt.
kind	string: documentModelCopyTo	A művelet típusa.
lastUpdatedDateTime	string	Az állapot legutóbbi frissítésének dátuma és időpontja (UTC).
operationId	string	Művelet azonosítója
percentCompleted	integer	Művelet állapota (0-100).
resourceLocation	string	A művelet által megcélzott erőforrás URL-címe.
result	DocumentModelDetails	A művelet sikeres lesz.
status	OperationStatus	Művelet állapota. notStarted, running, completed vagy failed
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentModelDetails

Dokumentummodell adatai.

Name	Típus	Description
apiVersion	string	A dokumentummodell létrehozásához használt API-verzió.
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage betanítási adatokat megadva fájllistát. Meg kell adni az azureBlobSource vagy az azureBlobFileListSource értéket.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage betanítási adatokat tartalmazó helyet. Meg kell adni az azureBlobSource-t vagy az azureBlobFileListSource-t.
buildMode	DocumentBuildMode	Egyéni dokumentummodell buildelési módja.
createdDateTime	string	A dokumentummodell létrehozásának dátuma és időpontja (UTC).
description	string	Dokumentummodell leírása.
docTypes	<string,  DocumentTypeDetails>	Támogatott dokumentumtípusok.
expirationDateTime	string	A dokumentummodell lejáratának dátuma és időpontja (UTC).
modelId	string	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.
warnings	Warning[]	A modell létrehozása során észlelt figyelmeztetések listája.

DocumentTypeDetails

Dokumentumtípus adatai.

Name	Típus	Description
buildMode	DocumentBuildMode	Egyéni dokumentummodell összeállítási módja.
description	string	A dokumentummodell leírása.
fieldConfidence	object	Az egyes mezők becsült megbízhatósága.
fieldSchema	<string,  DocumentFieldSchema>	A dokumentum szemantikai sémájának leírása JSON sémastílus-szintaxissal.

Error

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerError	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorResponse

Hibaválasz-objektum.

Name	Típus	Description
error	Error	Hibainformáció.

InnerError

Egy objektum, amely részletesebb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	InnerError	Belső hiba.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.

OperationKind

A művelet típusa.

Name	Típus	Description
documentClassifierBuild	string	Hozzon létre egy új egyéni osztályozómodellt.
documentModelBuild	string	Hozzon létre egy új egyéni dokumentummodellt.
documentModelCompose	string	Hozzon létre egy új egyéni dokumentummodellt a meglévő modellekből.
documentModelCopyTo	string	Másoljon egy meglévő dokumentummodellt egy másik erőforrásba, régióba vagy előfizetésbe.

OperationStatus

Művelet állapota.

Name	Típus	Description
canceled	string	A művelet megszakadt.
completed	string	A művelet befejeződött.
failed	string	A művelet sikertelen volt.
notStarted	string	A művelet még nem indult el.
running	string	A művelet folyamatban van.
succeeded	string	A művelet sikeres volt.

PagedOperationDetails

OperationDetails elemek lapozott gyűjteménye

Name	Típus	Description
nextLink	string	Az elemek következő oldalára mutató hivatkozás
value	OperationDetails[]: DocumentClassifierBuildOperationDetails[] DocumentModelBuildOperationDetails[] DocumentModelComposeOperationDetails[] DocumentModelCopyToOperationDetails[]	Az OperationDetails elemek ezen a lapon

Warning

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált figyelmeztető kódok egyike.
message	string	A figyelmeztetés emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.