Miscellaneous - Get Operation

Reference

Service:: Azure AI Services

API Version:: 2023-07-31

Získá informace o operaci.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string url	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).
operationId	path	True	string uuid	Jedinečné ID operace. Regex pattern: `^[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	Požadovaná verze rozhraní API

endpoint

path

True

string

url

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).

operationId

path

True

string

uuid

Jedinečné ID operace.

Regex pattern: ^[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

Požadovaná verze rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

Odpovědi

Name	Typ	Description
200 OK	OperationDetails: DocumentModelBuildOperationDetails DocumentModelComposeOperationDetails DocumentModelCopyToOperationDetails DocumentClassifierBuildOperationDetails	OK.
Other Status Codes	ErrorResponse	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč vašeho předplatného služeb Azure Cognitive Services.

Type: apiKey
In: header

Příklady

Get Operation

Sample Request

HTTP

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

Sample Response

Status code:: 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"
  }
}

Definice

Name	Description
AzureBlobContentSource	Azure Blob Storage obsah.
AzureBlobFileListContentSource	Seznam souborů v Azure Blob Storage.
ClassifierDocumentTypeDetails	Informace o typu dokumentu klasifikátoru
DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
DocumentClassifierBuildOperationDetails	Získejte objekt odpovědi operace.
DocumentClassifierDetails	Informace o klasifikátoru dokumentů
DocumentFieldSchema	Popis sémantického schématu pole pomocí syntaxe stylu schématu JSON.
DocumentFieldType	Sémantický datový typ hodnoty pole.
DocumentModelBuildOperationDetails	Získejte objekt odpovědi operace.
DocumentModelComposeOperationDetails	Získejte objekt odpovědi operace.
DocumentModelCopyToOperationDetails	Získejte objekt odpovědi operace.
DocumentModelDetails	Informace o modelu dokumentu
DocumentTypeDetails	Informace o typu dokumentu.
Error	Informace o chybě.
ErrorResponse	Objekt odpovědi na chybu.
InnerError	Podrobná chyba.
OperationStatus	Stav operace.

AzureBlobContentSource

Azure Blob Storage obsah.

Name	Typ	Description
containerUrl	string	Azure Blob Storage adresu URL kontejneru.
prefix	string	Předpona názvu objektu blob.

AzureBlobFileListContentSource

Seznam souborů v Azure Blob Storage.

Name	Typ	Description
containerUrl	string	Azure Blob Storage adresu URL kontejneru.
fileList	string	Cesta k souboru JSONL v kontejneru určující podmnožinu dokumentů pro trénování

ClassifierDocumentTypeDetails

Informace o typu dokumentu klasifikátoru

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage seznam souborů určující trénovací data pro typ dokumentu klasifikátoru. Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage umístění obsahující trénovací data pro typ dokumentu klasifikátoru. Je nutné zadat azureBlobSource nebo azureBlobFileListSource.

DocumentBuildMode

Režim sestavení vlastního modelu dokumentu

Name	Typ	Description
neural	string	Podpořte dokumenty s různými vizuálními šablonami.
template	string	Zaměřte se na dokumenty s podobnými vizuálními šablonami.

DocumentClassifierBuildOperationDetails

Získejte objekt odpovědi operace.

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření této operace
createdDateTime	string	Datum a čas (UTC) vytvoření operace
error	Error	Došlo k chybě.
kind	string: documentClassifierBuild	Typ operace.
lastUpdatedDateTime	string	Datum a čas (UTC) poslední aktualizace stavu
operationId	string	ID operace
percentCompleted	integer	Průběh operace (0–100).
resourceLocation	string	Adresa URL prostředku, na který tato operace cílí.
result	DocumentClassifierDetails	Výsledek operace při úspěchu.
status	OperationStatus	Stav operace.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentClassifierDetails

Informace o klasifikátoru dokumentů

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření tohoto klasifikátoru dokumentů.
classifierId	string	Jedinečný název klasifikátoru dokumentu.
createdDateTime	string	Datum a čas (UTC) vytvoření klasifikátoru dokumentu
description	string	Popis klasifikátoru dokumentu
docTypes	<string, ClassifierDocumentTypeDetails>	Seznam typů dokumentů, které se mají klasifikovat.
expirationDateTime	string	Datum a čas (UTC), kdy vyprší platnost klasifikátoru dokumentu

DocumentFieldSchema

Popis sémantického schématu pole pomocí syntaxe stylu schématu JSON.

Name	Typ	Description
description	string	Popis pole
example	string	Příklad obsahu pole
items	DocumentFieldSchema	Schéma typu pole pro každý prvek pole.
properties	<string, DocumentFieldSchema>	Pojmenovaná dílčí pole pole objektu.
type	DocumentFieldType	Sémantický datový typ hodnoty pole.

DocumentFieldType

Sémantický datový typ hodnoty pole.

Name	Typ	Description
address	string	Parsovaná adresa.
array	string	Seznam dílčích polí stejného typu
boolean	string	Logická hodnota normalizovaná na hodnotu true nebo false.
countryRegion	string	Země/oblast normalizované na formát ISO 3166-1 alfa-3 (např. USA).
currency	string	Částka měny s volitelným symbolem měny a jednotkou.
date	string	Datum, normalizované do formátu ISO 8601 (RRRR-MM-DD).
integer	string	Celočíselné číslo normalizované na 64bitové celé číslo se signoum
number	string	Číslo s plovoucí desetinou čárkou normalizované na hodnotu s plovoucí desetinou čárkou s dvojitou přesností.
object	string	Pojmenovaný seznam dílčích polí potenciálně různých typů
phoneNumber	string	Telefonní číslo normalizované do formátu E.164 (+{Kód země}{SubscriberNumber}).
selectionMark	string	Je pole vybrané?
signature	string	Je podpis k dispozici?
string	string	Prostý text.
time	string	Čas normalizovaný do formátu ISO 8601 (hh:mm:ss).

DocumentModelBuildOperationDetails

Získejte objekt odpovědi operace.

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření této operace
createdDateTime	string	Datum a čas (UTC) vytvoření operace
error	Error	Došlo k chybě.
kind	string: documentModelBuild	Typ operace.
lastUpdatedDateTime	string	Datum a čas (UTC) poslední aktualizace stavu
operationId	string	ID operace
percentCompleted	integer	Průběh operace (0–100).
resourceLocation	string	Adresa URL prostředku, na který tato operace cílí.
result	DocumentModelDetails	Výsledek operace při úspěchu.
status	OperationStatus	Stav operace.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentModelComposeOperationDetails

Získejte objekt odpovědi operace.

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření této operace
createdDateTime	string	Datum a čas (UTC) vytvoření operace
error	Error	Došlo k chybě.
kind	string: documentModelCompose	Typ operace.
lastUpdatedDateTime	string	Datum a čas (UTC) poslední aktualizace stavu
operationId	string	ID operace
percentCompleted	integer	Průběh operace (0–100).
resourceLocation	string	Adresa URL prostředku, na který tato operace cílí.
result	DocumentModelDetails	Výsledek operace při úspěchu.
status	OperationStatus	Stav operace.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentModelCopyToOperationDetails

Získejte objekt odpovědi operace.

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření této operace
createdDateTime	string	Datum a čas (UTC) vytvoření operace
error	Error	Došlo k chybě.
kind	string: documentModelCopyTo	Typ operace.
lastUpdatedDateTime	string	Datum a čas (UTC) poslední aktualizace stavu
operationId	string	ID operace
percentCompleted	integer	Průběh operace (0–100).
resourceLocation	string	Adresa URL prostředku, na který tato operace cílí.
result	DocumentModelDetails	Výsledek operace při úspěchu.
status	OperationStatus	Stav operace.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentModelDetails

Informace o modelu dokumentu

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření tohoto modelu dokumentu.
createdDateTime	string	Datum a čas (UTC) vytvoření modelu dokumentu
description	string	Popis modelu dokumentu
docTypes	<string, DocumentTypeDetails>	Podporované typy dokumentů.
expirationDateTime	string	Datum a čas (UTC), kdy vyprší platnost modelu dokumentu
modelId	string	Jedinečný název modelu dokumentu.
tags	object	Seznam atributů značky klíč-hodnota přidružených k modelu dokumentu

DocumentTypeDetails

Informace o typu dokumentu.

Name	Typ	Description
buildMode	DocumentBuildMode	Režim sestavení vlastního modelu dokumentu
description	string	Popis modelu dokumentu
fieldConfidence	object	Odhadovaná spolehlivost pro každé pole
fieldSchema	<string, DocumentFieldSchema>	Popis sémantického schématu dokumentu pomocí syntaxe stylu schématu JSON.

Error

Informace o chybě.

Name	Typ	Description
code	string	Kód chyby
details	Error[]	Seznam podrobných chyb
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt odpovědi na chybu.

Name	Typ	Description
error	Error	Informace o chybě.

InnerError

Podrobná chyba.

Name	Typ	Description
code	string	Kód chyby
innererror	InnerError	Podrobná chyba.
message	string	Chybová zpráva.

OperationStatus

Stav operace.

Name	Typ	Description
canceled	string	Operace byla zrušena.
failed	string	Operace se nezdařila.
notStarted	string	Operace ještě nebyla spuštěna.
running	string	Operace právě probíhá.
succeeded	string	Operace byla úspěšná.

Sdílet prostřednictvím

Miscellaneous - Get Operation

Parametry identifikátoru URI

Hlavička požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Get Operation

Sample Request

Sample Response

Definice

AzureBlobContentSource

AzureBlobFileListContentSource

ClassifierDocumentTypeDetails

DocumentBuildMode

DocumentClassifierBuildOperationDetails

DocumentClassifierDetails

DocumentFieldSchema

DocumentFieldType

DocumentModelBuildOperationDetails

DocumentModelComposeOperationDetails

DocumentModelCopyToOperationDetails

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

OperationStatus

Další materiály