Document Classifiers - Classify Document

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-30

Klasyfikuje dokument za pomocą klasyfikatora dokumentów.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30

Z parametrami opcjonalnymi:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
classifierId	path	True	string	Unikatowa nazwa klasyfikatora dokumentów. Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
pages	query		string	1 numery stron do przeanalizowania. Ex. "1-3,5,7-9" Wzorzec wyrażenia regularnego: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
split	query		SplitMode	Tryb dzielenia dokumentów.
stringIndexType	query		StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

Treść żądania

Nazwa	Typ	Opis
base64Source	string	Kodowanie base64 dokumentu do klasyfikowania. Należy określić wartość urlSource lub base64Source.
urlSource	string	Adres URL dokumentu do klasyfikowania. Należy określić wartość urlSource lub base64Source.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało zaakceptowane do przetwarzania, ale przetwarzanie nie zostało jeszcze ukończone. Nagłówki Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

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

Przykłady

Classify Document from Url

Przykładowe żądanie

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/classifierId:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType=textElements

{
  "urlSource": "http://host.com/doc.pdf"
}

Przykładowa odpowiedź

Kod stanu:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Definicje

Nazwa	Opis
ClassifyDocumentRequest	Parametry klasyfikacji dokumentów.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
SplitMode	Zachowanie dzielenia plików.
StringIndexType	Metoda używana do obliczania przesunięcia i długości ciągu.

ClassifyDocumentRequest

Parametry klasyfikacji dokumentów.

Nazwa	Typ	Opis
base64Source	string	Kodowanie base64 dokumentu do klasyfikowania. Należy określić wartość urlSource lub base64Source.
urlSource	string	Adres URL dokumentu do klasyfikowania. Należy określić wartość urlSource lub base64Source.

DocumentIntelligenceError

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	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.

DocumentIntelligenceErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

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	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

SplitMode

Zachowanie dzielenia plików.

Nazwa	Typ	Opis
auto	string	Automatycznie podziel plik na dokumenty.
none	string	Traktuj cały plik jako pojedynczy dokument.
perPage	string	Traktuj każdą stronę w pliku jako oddzielny dokument.

StringIndexType

Metoda używana do obliczania przesunięcia i długości ciągu.

Nazwa	Typ	Opis
textElements	string	Postrzegany przez użytkownika znak wyświetlania lub klaster grafu, zgodnie z definicją w standardze Unicode 8.0.0.
unicodeCodePoint	string	Jednostka znaku reprezentowana przez pojedynczy punkt kodu Unicode. Używany przez język Python 3.
utf16CodeUnit	string	Jednostka znaków reprezentowana przez 16-bitową jednostkę kodu Unicode. Używane przez języki JavaScript, Java i .NET.