Document Models - Analyze Document

Service:

Azure AI Services

API Version:

2024-02-29-preview

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

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview

With optional parameters:

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages={pages}&locale={locale}&stringIndexType={stringIndexType}&features={features}&queryFields={queryFields}&outputContentFormat={outputContentFormat}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Конечная точка службы аналитики документов.
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).
outputContentFormat	query		ContentFormat	Формат содержимого результата анализа верхнего уровня.
pages	query		string	Список 1 номеров страниц для анализа. Например: "1-3,5,7-9" Regex pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$
queryFields	query		string[]	Список дополнительных полей для извлечения. Например: "NumberOfGuests,StoreNumber"
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

Примеры

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

Sample Response

Status code:

202

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

Analyze Document from Url

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-02-29-preview&pages=1-2,4&locale=en-US&stringIndexType=textElements

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

Sample Response

Status code:

202

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

Определения

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

AnalyzeDocumentRequest

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

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

ContentFormat

Формат содержимого в анализируемом результате.

Имя	Тип	Описание
markdown	string	Представление markdown содержимого документа с заголовками разделов, таблицами и т. д.
text	string	Представление содержимого документа в виде обычного текста без форматирования.

DocumentAnalysisFeature

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

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