Document Classifiers - Get Classifier

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-30

Získá podrobné informace klasifikátoru dokumentu.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}?api-version=2024-11-30

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
classifierId	path	True	string	Jedinečný název klasifikátoru dokumentu Vzor regulárního výrazu: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Koncový bod služby Document Intelligence
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	DocumentClassifierDetails	Požadavek byl úspěšný. Hlavičky x-ms-client-request-id: string
Other Status Codes	DocumentIntelligenceErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

Get Document Classifier

Ukázkový požadavek

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier?api-version=2024-11-30

Ukázková odpověď

Stavový kód:

200

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-11-30",
  "docTypes": {
    "formA": {
      "azureBlobSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "prefix": "formADocs/"
      }
    },
    "formB": {
      "azureBlobFileListSource": {
        "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
        "fileList": "formB.jsonl"
      }
    }
  }
}

Definice

Name	Description
AzureBlobContentSource	Obsah služby Azure Blob Storage
AzureBlobFileListContentSource	Seznam souborů ve službě Azure Blob Storage
ClassifierDocumentTypeDetails	Informace o typu dokumentu klasifikátoru
ContentSourceKind	Typ zdroje obsahu
DocumentClassifierDetails	Informace o klasifikátoru dokumentů
DocumentIntelligenceError	Objekt chyby.
DocumentIntelligenceErrorResponse	Objekt odpovědi na chybu
DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace o chybě.
DocumentIntelligenceWarning	Objekt chyby.

AzureBlobContentSource

Obsah služby Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
prefix	string	Předpona názvu objektu blob

AzureBlobFileListContentSource

Seznam souborů ve službě Azure Blob Storage

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru služby Azure Blob Storage
fileList	string	Cesta k souboru JSONL v kontejneru určujícím podmnožinu dokumentů

ClassifierDocumentTypeDetails

Informace o typu dokumentu klasifikátoru

Name	Typ	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Seznam souborů Azure Blob Storage určující trénovací data pro typ dokumentu klasifikátoru Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Umístění služby Azure Blob Storage obsahující trénovací data pro typ dokumentu klasifikátoru Je nutné zadat azureBlobSource nebo azureBlobFileListSource.
sourceKind	ContentSourceKind	Typ trénovacího zdroje dat

ContentSourceKind

Typ zdroje obsahu

Name	Typ	Description
azureBlob	string	Soubory v cestě v kontejneru Azure Blob Storage
azureBlobFileList	string	Seznam souborů určující jednotlivé soubory v kontejneru Azure Blob Storage.
base64	string	Obsah reprezentovaný kódováním Base64
url	string	Obsah na konkrétní adrese URL

DocumentClassifierDetails

Informace o klasifikátoru dokumentů

Name	Typ	Description
apiVersion	string	Verze rozhraní API použitá k vytvoření tohoto klasifikátoru dokumentu
baseClassifierId	string	Base classifierId nad kterým byl klasifikátor natrénován.
classifierId	string	Jedinečný název klasifikátoru dokumentu
createdDateTime	string	Datum a čas (UTC) při 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.
modifiedDateTime	string	Datum a čas (UTC) při poslední změně modelu dokumentu
warnings	DocumentIntelligenceWarning[]	Seznam upozornění, ke kterým došlo při sestavování klasifikátoru

DocumentIntelligenceError

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	DocumentIntelligenceError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	DocumentIntelligenceInnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

DocumentIntelligenceErrorResponse

Objekt odpovědi na chybu

Name	Typ	Description
error	DocumentIntelligenceError	Informace o chybě

DocumentIntelligenceInnerError

Objekt obsahující konkrétnější informace o chybě.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	DocumentIntelligenceInnerError	Vnitřní chyba.
message	string	Čitelné znázornění chyby člověkem.

DocumentIntelligenceWarning

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů upozornění.
message	string	Čitelné znázornění varování člověkem.
target	string	Cíl chyby.