Document Models - Analyze Document

Служба:

Azure AI Services

Версия API:

2024-07-31-preview

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

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string uri	Конечная точка службы аналитики документов.
modelId	path	True	string	Уникальное имя модели документа. Шаблон регулярного выражения: ^[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").
output	query		AnalyzeOutputOption[]	Дополнительные выходные данные для создания во время анализа.
outputContentFormat	query		ContentFormat	Формат содержимого результата анализа верхнего уровня.
pages	query		string	Список 1-х номеров страниц для анализа. Бывший. "1-3,5,7-9" Шаблон регулярного выражения: ^(\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		Запрос был принят для обработки, но обработка еще не завершена. Заголовки Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

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

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

Примеры

Analyze Document from Base64

Analyze Document from Url

Analyze Document from Base64

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

HTTP

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

{
  "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9"
}

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

Код состояния:

202

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

Analyze Document from Url

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

HTTP

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

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

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

Код состояния:

202

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

Определения

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

AnalyzeDocumentRequest

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

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

AnalyzeOutputOption

Дополнительные выходные данные для создания во время анализа.

Имя	Тип	Описание
figures	string	Создайте обрезанные изображения обнаруженных цифр.
pdf	string	Создание выходных данных PDF с возможностью поиска.

ContentFormat

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

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

DocumentAnalysisFeature

Функции анализа документов для включения.

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