Поделиться через

Document Classifiers - Classify Document

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-11-30

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

POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30
С использованием необязательных параметров: 
POST {endpoint}/documentintelligence/documentClassifiers/{classifierId}:analyze?_overload=classifyDocument&api-version=2024-11-30&stringIndexType={stringIndexType}&split={split}&pages={pages}

Параметры URI

Имя В Обязательно Тип Описание
classifierId
 path True

string

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

Уникальное имя классификатора документов.
endpoint
 path True

string (uri)

Конечная точка службы аналитики документов.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.
pages
 query

string

pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$

Число страниц на основе 1 для анализа. Бывший. "1-3,5,7-9"
split
 query

SplitMode

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

StringIndexType

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

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

Имя Тип Описание
base64Source

string (byte)

Кодировка Base64 документа для классификации. Необходимо указать urlSource или base64Source.
urlSource

string (uri)

URL-адрес документа для классификации. Необходимо указать urlSource или base64Source.

Ответы

Имя Тип Описание
202 Accepted

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

  • Operation-Location: string
  • Retry-After: integer
Other Status Codes

DocumentIntelligenceErrorResponse

Непредвиденное сообщение об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

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

Примеры

Classify Document from Url

Образец запроса

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"
}

Пример ответа

Код состояния:
202 
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-11-30

Определения

Имя Описание
ClassifyDocumentRequest

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

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

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

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

Поведение разделения файлов.
StringIndexType

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

ClassifyDocumentRequest

Object

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

Имя Тип Описание
base64Source

string (byte)

Кодировка Base64 документа для классификации. Необходимо указать urlSource или base64Source.
urlSource

string (uri)

URL-адрес документа для классификации. Необходимо указать urlSource или base64Source.

DocumentIntelligenceError

Object

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

DocumentIntelligenceError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

DocumentIntelligenceInnerError

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

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

DocumentIntelligenceErrorResponse

Object

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

Имя Тип Описание
error

DocumentIntelligenceError

Сведения об ошибке.

DocumentIntelligenceInnerError

Object

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

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
innererror

DocumentIntelligenceInnerError

Внутренняя ошибка.
message

string

Читаемое пользователем представление ошибки.

SplitMode

Перечисление

Поведение разделения файлов.

Значение Описание
auto

Автоматически разделенный файл на документы.
none

Обрабатывает весь файл как один документ.
perPage

Обрабатывать каждую страницу в файле как отдельный документ.

StringIndexType

Перечисление

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

Значение Описание
textElements

Отображаемый пользователем символ или кластер grapheme, как определено в Юникоде 8.0.0.
unicodeCodePoint

Единица символов, представленная одной точкой кода юникода. Используется Python 3.
utf16CodeUnit

Единица символов, представленная 16-разрядной единицей кода Юникода. Используется JavaScript, Java и .NET.