Udostępnij za pośrednictwem


Document Classifiers - Get Classifier

Pobiera szczegółowe informacje o klasyfikatorach dokumentów.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
classifierId
path True

string

Unikatowa nazwa klasyfikatora dokumentu.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

endpoint
path True

string

Punkt końcowy usługi Analizy dokumentów.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-request-id

string

uuid

Nieprzezroczysty, unikatowy globalnie, wygenerowany przez klienta identyfikator ciągu dla żądania.

Odpowiedzi

Nazwa Typ Opis
200 OK

DocumentClassifierDetails

Żądanie zakończyło się pomyślnie.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

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

Nazwa Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Document Classifier

Sample Request

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

Sample Response

{
  "classifierId": "myClassifier",
  "description": "Classifier description",
  "createdDateTime": "2022-07-30T00:00:00Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "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"
      }
    }
  }
}

Definicje

Nazwa Opis
AzureBlobContentSource

Azure Blob Storage zawartości.

AzureBlobFileListContentSource

Lista plików w Azure Blob Storage.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

ContentSourceKind

Typ źródła zawartości.

DocumentClassifierDetails

Informacje o klasyfikatorze dokumentu.

Error

Obiekt błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Warning

Obiekt błędu.

AzureBlobContentSource

Azure Blob Storage zawartości.

Nazwa Typ Opis
containerUrl

string

Azure Blob Storage adres URL kontenera.

prefix

string

Prefiks nazwy obiektu blob.

AzureBlobFileListContentSource

Lista plików w Azure Blob Storage.

Nazwa Typ Opis
containerUrl

string

Azure Blob Storage adres URL kontenera.

fileList

string

Ścieżka do pliku JSONL w kontenerze określającym podzestaw dokumentów.

ClassifierDocumentTypeDetails

Informacje o typie dokumentu klasyfikatora.

Nazwa Typ Opis
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob Storage lista plików określająca dane treningowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.

azureBlobSource

AzureBlobContentSource

Azure Blob Storage lokalizacji zawierającej dane szkoleniowe dla typu dokumentu klasyfikatora. Należy określić element azureBlobSource lub azureBlobFileListSource.

sourceKind

ContentSourceKind

Typ źródła danych trenowania.

ContentSourceKind

Typ źródła zawartości.

Nazwa Typ Opis
azureBlob

string

Pliki w ścieżce w kontenerze Azure Blob Storage.

azureBlobFileList

string

Lista plików określająca poszczególne pliki w kontenerze Azure Blob Storage.

base64

string

Zawartość reprezentowana za pomocą kodowania Base64.

url

string

Zawartość pod określonym adresem URL.

DocumentClassifierDetails

Informacje o klasyfikatorze dokumentu.

Nazwa Typ Opis
apiVersion

string

Wersja interfejsu API używana do tworzenia klasyfikatora dokumentów.

baseClassifierId

string

Base classifierId, na podstawie którego klasyfikator został wytrenowany.

classifierId

string

Unikatowa nazwa klasyfikatora dokumentu.

createdDateTime

string

Data i godzina (UTC) utworzenia klasyfikatora dokumentów.

description

string

Opis klasyfikatora dokumentu.

docTypes

<string,  ClassifierDocumentTypeDetails>

Lista typów dokumentów do klasyfikowania.

expirationDateTime

string

Data i godzina (UTC), kiedy klasyfikator dokumentu wygaśnie.

warnings

Warning[]

Lista ostrzeżeń napotkanych podczas tworzenia klasyfikatora.

Error

Obiekt błędu.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

details

Error[]

Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.

innererror

InnerError

Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

message

string

Czytelna dla człowieka reprezentacja błędu.

target

string

Element docelowy błędu.

ErrorResponse

Błąd obiektu odpowiedzi.

Nazwa Typ Opis
error

Error

Informacje o błędzie.

InnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

innererror

InnerError

Błąd wewnętrzny.

message

string

Czytelna dla człowieka reprezentacja błędu.

Warning

Obiekt błędu.

Nazwa Typ Opis
code

string

Jeden z zdefiniowanych przez serwer zestaw kodów ostrzegawczych.

message

string

Czytelna dla człowieka reprezentacja ostrzeżenia.

target

string

Element docelowy błędu.