Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2023-07-31

Анализирует документ с помощью модели документов.

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?api-version=2023-07-31

With optional parameters:

POST {endpoint}/formrecognizer/documentModels/{modelId}:analyze?pages={pages}&locale={locale}&stringIndexType={stringIndexType}&api-version=2023-07-31&features={features}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string url	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string	Уникальное имя модели документа. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
api-version	query	True	string	Запрошенная версия API.
features	query		DocumentAnalysisFeature[]	Список необязательных функций анализа.
locale	query		string	Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, en-US).
pages	query		string	Список 1 номеров страниц для анализа. Например: "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
stringIndexType	query		StringIndexType	Метод, используемый для вычисления смещения и длины строки.

Заголовок запроса

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Секретный ключ для подписки Azure Cognitive Services.

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

Media Types: "application/json", "application/octet-stream", "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", "image/heif", "text/html", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation"

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

Ответы

Имя	Тип	Описание
202 Accepted		Запрос успешно поставлен в очередь. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Ошибка.

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

Ocp-Apim-Subscription-Key

Секретный ключ для подписки Azure Cognitive Services.

Type: apiKey
In: header

Примеры

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel:analyze?pages=1-2,4&locale=en-US&stringIndexType=textElements&api-version=2023-07-31

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

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2023-07-31

Определения

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

AnalyzeDocumentRequest

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

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

DocumentAnalysisFeature

Список необязательных функций анализа.

Имя	Тип	Описание
barcodes	string	Включите обнаружение штрихкодов в документе.
formulas	string	Включите обнаружение математических выражений в документе.
keyValuePairs	string	Включите обнаружение пар общих значений ключей (полей форм) в документе.
languages	string	Включите обнаружение языка текстового содержимого.
ocrHighResolution	string	Выполняйте распознавание текста с более высоким разрешением для обработки документов с тонкой печатью.
styleFont	string	Включите распознавание различных стилей шрифтов.

Error

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

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

ErrorResponse

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

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

InnerError

Подробная ошибка.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	InnerError	Подробная ошибка.
message	string	Сообщение об ошибке.

StringIndexType

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

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