Document Models - Analyze Document

Служба:

Azure AI Services

Версия API:

2024-11-30

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

POST {endpoint}/documentintelligence/documentModels/{modelId}:analyze?_overload=analyzeDocument&api-version=2024-11-30

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка службы аналитики документов.
modelId	path	True	string maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Уникальное имя модели документа.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.
features	query		DocumentAnalysisFeature[]	Список необязательных функций анализа.
locale	query		string	Указание языкового стандарта для распознавания текста и анализа документов. Значение может содержать только языковой код (например, en, fr) или тег языка BCP 47 (например, "en-US").
output	query		AnalyzeOutputOption[]	Дополнительные выходные данные для создания во время анализа.
outputContentFormat	query		DocumentContentFormat	Формат содержимого результата анализа верхнего уровня.
pages	query		string pattern: ^(\d+(-\d+)?)(,\s*(\d+(-\d+)?))*$	Число страниц на основе 1 для анализа. Бывший. "1-3,5,7-9"
queryFields	query		string[]	Список дополнительных полей для извлечения. Бывший. "NumberOfGuests,StoreNumber"
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

Примеры

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-11-30&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-11-30

Analyze Document from Url

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

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel:analyze?_overload=analyzeDocument&api-version=2024-11-30&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-11-30

Определения

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

AnalyzeDocumentRequest

Object

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

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

AnalyzeOutputOption

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

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

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

DocumentAnalysisFeature

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

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

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

DocumentContentFormat

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

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

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

DocumentIntelligenceError

Object

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

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceInnerError

Object

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

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

StringIndexType

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

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

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