Document Classifiers - Classify Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

Классифицирует документ с помощью классификатора документов.

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-02-29-preview&stringIndexType={stringIndexType}&split={split}

Параметры URI

Имя	В	Обязательно	Тип	Описание
classifierId	path	True	string	Уникальное имя классификатора документов. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Конечная точка службы аналитики документов.
api-version	query	True	string	Версия API, используемая для данной операции.
split	query		SplitMode	Режим разделения документов.
stringIndexType	query		StringIndexType	Метод, используемый для вычисления смещения и длины строки.

Текст запроса

Имя	Тип	Описание
base64Source	string	Кодировка Base64 документа для классификации. Необходимо указать urlSource или base64Source.
urlSource	string	URL-адрес документа для классификации. Необходимо указать urlSource или base64Source.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос принят к обработке, но обработка еще не завершена. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

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

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Classify Document from Url

Sample Request

HTTP

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

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

Sample Response

Status code:

202

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

Определения

Имя	Описание
ClassifyDocumentRequest	Параметры классификации документов.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
InnerError	Объект , содержащий более конкретные сведения об ошибке.
SplitMode	Режим разделения документов.
StringIndexType	Метод, используемый для вычисления смещения и длины строки.

ClassifyDocumentRequest

Параметры классификации документов.

Имя	Тип	Описание
base64Source	string	Кодировка Base64 документа для классификации. Необходимо указать urlSource или base64Source.
urlSource	string	URL-адрес документа для классификации. Необходимо указать urlSource или base64Source.

Error

Объект ошибки.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorResponse

Объект ответа об ошибке.

Имя	Тип	Описание
error	Error	Сведения об ошибке.

InnerError

Объект , содержащий более конкретные сведения об ошибке.

Имя	Тип	Описание
code	string	Один из серверных наборов кодов ошибок.
innererror	InnerError	Внутренняя ошибка.
message	string	Понятное представление ошибки.

SplitMode

Режим разделения документов.

Имя	Тип	Описание
auto	string	Автоматическое разделение файла на документы.
none	string	Рассматривайте весь файл как один документ.
perPage	string	Обрабатывать каждую страницу в файле как отдельный документ.

StringIndexType

Метод, используемый для вычисления смещения и длины строки.

Имя	Тип	Описание
textElements	string	Отображаемый символ, воспринимаемый пользователем, или кластер grapheme, как определено в Юникоде 8.0.0.
unicodeCodePoint	string	Символьная единица, представленная одной кодовой точкой Юникода. Используется Python 3.
utf16CodeUnit	string	Символьная единица, представленная 16-разрядной единицей кода Юникода. Используется в JavaScript, Java и .NET.