Document Classifiers - Get Classify Result

Служба:

Azure AI Services

Версия API:

2024-07-31-preview

Возвращает результат классификатора документов.

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
classifierId	path	True	string	Уникальное имя классификатора документов. Шаблон регулярного выражения: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string uri	Конечная точка службы аналитики документов.
resultId	path	True	string uuid	Анализ идентификатора результата операции.
api-version	query	True	string	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeResultOperation	Запрос выполнен успешно.
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

Примеры

Get Classify Document Result

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

HTTP

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

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

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

200

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-07-31-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

Определения

Имя	Описание
AddressValue	Значение поля адреса.
AnalyzeResult	Результат анализа документов.
AnalyzeResultOperation	Состояние и результат операции анализа.
BoundingRegion	Ограничивающий многоугольник на определенной странице входных данных.
ContentFormat	Формат содержимого в проанализированном результате.
CurrencyValue	Значение поля валюты.
Document	Объект, описывающий расположение и семантическое содержимое документа.
DocumentBarcode	Объект штрихкода.
DocumentBarcodeKind	Вид штрихкода.
DocumentCaption	Объект заголовка, описывающий таблицу или рисунок.
DocumentField	Объект, представляющий содержимое и расположение значения поля.
DocumentFieldType	Семантический тип данных значения поля.
DocumentFigure	Объект, представляющий фигуру в документе.
DocumentFootnote	Объект сноски, описывающий таблицу или рисунок.
DocumentFormula	Объект формулы.
DocumentFormulaKind	Тип формулы.
DocumentKeyValueElement	Объект, представляющий ключ поля или значение в паре "ключ-значение".
DocumentKeyValuePair	Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым).
DocumentLanguage	Объект, представляющий обнаруженный язык для заданного диапазона текста.
DocumentLine	Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и знаки выделения.
DocumentPage	Элементы содержимого и макета, извлеченные на странице из входных данных.
DocumentParagraph	Объект абзаца, состоящий с смежными линиями, как правило, с общим выравниванием и интервалами.
DocumentSection	Объект, представляющий раздел в документе.
DocumentSelectionMark	Объект метки выбора, представляющий флажки, переключатели и другие элементы, указывающие на выделение.
DocumentSelectionMarkState	Состояние знака выделения.
DocumentSignatureType	Наличие подписи.
DocumentSpan	Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина.
DocumentStyle	Объект, представляющий наблюдаемые стили текста.
DocumentTable	Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.
DocumentTableCell	Объект, представляющий расположение и содержимое ячейки таблицы.
DocumentTableCellKind	Тип ячейки таблицы.
DocumentWord	Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
Error	Объект ошибки.
ErrorResponse	Объект ответа об ошибке.
FontStyle	Стиль шрифта.
FontWeight	Вес шрифта.
InnerError	Объект, содержащий более конкретные сведения об ошибке.
LengthUnit	Единица, используемая свойствами ширины, высоты и многоугольника. Для изображений единица — "пиксель". Для PDF единица — "дюйм".
OperationStatus	Состояние операции.
ParagraphRole	Семантическая роль абзаца.
StringIndexType	Метод, используемый для вычисления смещения и длины строки.
Warning	Объект ошибки.

AddressValue

Значение поля адреса.

Имя	Тип	Описание
city	string	Имя города, города, деревни и т. д.
cityDistrict	string	Районы или районы в городе, такие как Бруклин в Нью-Йорке или городе Вестминстер в Лондоне.
countryRegion	string	Страна или регион.
house	string	Имя сборки, например World Trade Center.
houseNumber	string	Номер дома или здания.
level	string	Номер этажа, например 3F.
poBox	string	Номер почтового ящика.
postalCode	string	Почтовый индекс, используемый для сортировки почты.
road	string	Имя улицы.
state	string	Административное подразделение первого уровня.
stateDistrict	string	Административное подразделение второго уровня, используемое в определенных языковых стандартах.
streetAddress	string	Адрес уровня улицы, за исключением города, штата, countryRegion и почтового кода.
suburb	string	Неофициальное название района, как Chinatown.
unit	string	Номер квартиры или офиса

AnalyzeResult

Результат анализа документов.

Имя	Тип	Описание
apiVersion	string	Версия API, используемая для получения этого результата.
content	string	Объединение строковых представлений всех текстовых и визуальных элементов в порядке чтения.
contentFormat	ContentFormat	Формат содержимого результата анализа верхнего уровня.
documents	Document[]	Извлеченные документы.
figures	DocumentFigure[]	Извлеченные цифры.
keyValuePairs	DocumentKeyValuePair[]	Извлеченные пары "ключ-значение".
languages	DocumentLanguage[]	Обнаруженные языки.
modelId	string	Идентификатор модели документа, используемый для получения этого результата.
pages	DocumentPage[]	Проанализированные страницы.
paragraphs	DocumentParagraph[]	Извлеченные абзацы.
sections	DocumentSection[]	Извлеченные разделы.
stringIndexType	StringIndexType	Метод, используемый для вычисления смещения и длины строки.
styles	DocumentStyle[]	Извлеченные стили шрифтов.
tables	DocumentTable[]	Извлеченные таблицы.
warnings	Warning[]	Список предупреждений.

AnalyzeResultOperation

Состояние и результат операции анализа.

Имя	Тип	Описание
analyzeResult	AnalyzeResult	Результат анализа документов.
createdDateTime	string	Дата и время (UTC) при отправке операции анализа.
error	Error	Обнаружена ошибка во время анализа документов.
lastUpdatedDateTime	string	Дата и время (UTC) при последнем обновлении состояния.
status	OperationStatus	Состояние операции. notStarted, запуск, успешное выполнение или сбой

BoundingRegion

Ограничивающий многоугольник на определенной странице входных данных.

Имя	Тип	Описание
pageNumber	integer	Номер страницы на основе 1, содержащий ограничивающий регион.
polygon	number[]	Ограничивающий многоугольник на странице или всю страницу, если он не указан. Координаты, указанные относительно левого верхнего края страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.

ContentFormat

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

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

CurrencyValue

Значение поля валюты.

Имя	Тип	Описание
amount	number	Сумма валюты.
currencyCode	string	Разрешенный код валюты (ISO 4217), если таковой есть.
currencySymbol	string	Метка символа валюты, если она есть.

Document

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

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие документ.
confidence	number	Уверенность в правильном извлечении документа.
docType	string	Тип документа.
fields	<string,  DocumentField>	Словарь именованных значений полей.
spans	DocumentSpan[]	Расположение документа в порядке чтения сцепленного содержимого.

DocumentBarcode

Объект штрихкода.

Имя	Тип	Описание
confidence	number	Уверенность в правильном извлечении штрихкода.
kind	DocumentBarcodeKind	Вид штрихкода.
polygon	number[]	Ограничивающий многоугольник штрихкода с координатами, указанными относительно верхней левой части страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
span	DocumentSpan	Расположение штрихкода в сцепленном содержимом порядка чтения.
value	string	Значение штрихкода.

DocumentBarcodeKind

Вид штрихкода.

Имя	Тип	Описание
Aztec	string	Код Aztec, определенный в ISO/IEC 24778:2008.
Codabar	string	Штрихкод Codabar, как определено в ANSI/AIM BC3-1995.
Code128	string	Код 128 штрихкодов, как определено в ISO/IEC 15417:2007.
Code39	string	Код 39 штрихкодов, определенный в ISO/IEC 16388:2007.
Code93	string	Код 93 штрихкода, как определено в ANSI/AIM BC5-1995.
DataBar	string	Штрихкод GS1 DataBar.
DataBarExpanded	string	Расширенный штрихкод GS1 DataBar.
DataMatrix	string	Код матрицы данных, определенный в ISO/IEC 16022:2006.
EAN13	string	GS1 13-значный международный номер статьи (номер европейской статьи).
EAN8	string	GS1 8-значный международный номер статьи (европейский номер статьи).
ITF	string	Чередуется 2 из 5 штрихкодов, как определено в ANSI/AIM BC2-1995.
MaxiCode	string	MaxiCode, как определено в ISO/IEC 16023:2000.
MicroQRCode	string	Микро QR-код, определенный в ISO/IEC 23941:2022.
PDF417	string	PDF417, как определено в ISO 15438.
QRCode	string	QR-код, определенный в ISO/IEC 18004:2015.
UPCA	string	GS1 12-значный универсальный код продукта.
UPCE	string	GS1 6-значный универсальный код продукта.

DocumentCaption

Объект заголовка, описывающий таблицу или рисунок.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие подпись.
content	string	Содержимое заголовка.
elements	string[]	Дочерние элементы заголовка.
spans	DocumentSpan[]	Расположение заголовка в сцепленном содержимом порядка чтения.

DocumentField

Объект, представляющий содержимое и расположение значения поля.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие поле.
confidence	number	Уверенность в правильном извлечении поля.
content	string	Содержимое поля.
spans	DocumentSpan[]	Расположение поля в сцепленном содержимом порядка чтения.
type	DocumentFieldType	Тип данных значения поля.
valueAddress	AddressValue	Значение адреса.
valueArray	DocumentField[]	Массив значений полей.
valueBoolean	boolean	Логическое значение.
valueCountryRegion	string	3-буквенный код страны (ISO 3166-1 alpha-3).
valueCurrency	CurrencyValue	Значение валюты.
valueDate	string	Значение даты в формате YYY-MM-DD (ISO 8601).
valueInteger	integer	Целочисленное значение.
valueNumber	number	Значение с плавающей запятой.
valueObject	<string,  DocumentField>	Словарь именованных значений полей.
valuePhoneNumber	string	Значение номера телефона в формате E.164 (например, +19876543210).
valueSelectionGroup	string[]	Значение группы выбора.
valueSelectionMark	DocumentSelectionMarkState	Значение метки выделения.
valueSignature	DocumentSignatureType	Наличие подписи.
valueString	string	Строковое значение.
valueTime	string	Значение времени в формате hh:mm:ss (ISO 8601).

DocumentFieldType

Семантический тип данных значения поля.

Имя	Тип	Описание
address	string	Проанализированный адрес.
array	string	Список подфилдов одного типа.
boolean	string	Логическое значение, нормализованное значение true или false.
countryRegion	string	Страна или регион, нормализованный до формата ISO 3166-1 alpha-3 (например, США).
currency	string	Сумма валюты с необязательным символом валюты и единицей.
date	string	Дата, нормализованная до формата ISO 8601 (ГГГГ-MM-DD) .
integer	string	Целочисленное число, нормализованное до 64-разрядного целого числа со знаком.
number	string	Число с плавающей запятой, нормализованное для двойной точности с плавающей запятой.
object	string	Именованный список подфилдов потенциально разных типов.
phoneNumber	string	Номер телефона, нормализованный по формату E.164 (+{CountryCode}{SubscriptionNumber}).
selectionGroup	string	Массив выбранных строковых значений.
selectionMark	string	Выбрано ли поле?
signature	string	Присутствует ли подпись?
string	string	Обычный текст.
time	string	Время, нормализованное по формату ISO 8601 (hh:mm:ss).

DocumentFigure

Объект, представляющий фигуру в документе.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие фигуру.
caption	DocumentCaption	Подпись, связанная с рисунком.
elements	string[]	Дочерние элементы фигуры, за исключением подписей или сносок.
footnotes	DocumentFootnote[]	Список сносок, связанных с рисунком.
id	string	Идентификатор рисунка.
spans	DocumentSpan[]	Расположение рисунка в сцепленном содержимом порядка чтения.

DocumentFootnote

Объект сноски, описывающий таблицу или рисунок.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие сноску.
content	string	Содержимое сноски.
elements	string[]	Дочерние элементы сноски.
spans	DocumentSpan[]	Расположение сноски в порядке чтения сцепленного содержимого.

DocumentFormula

Объект формулы.

Имя	Тип	Описание
confidence	number	Уверенность в правильном извлечении формулы.
kind	DocumentFormulaKind	Тип формулы.
polygon	number[]	Ограничивающий многоугольник формулы с координатами, указанными относительно верхней левой части страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
span	DocumentSpan	Расположение формулы в сцепленном содержимом порядка чтения.
value	string	Выражение LaTex, описывающее формулу.

DocumentFormulaKind

Тип формулы.

Имя	Тип	Описание
display	string	Формула в режиме отображения, которая занимает всю строку.
inline	string	Формула, внедренная в содержимое абзаца.

DocumentKeyValueElement

Объект, представляющий ключ поля или значение в паре "ключ-значение".

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие элемент key-value.
content	string	Сцепленное содержимое элемента key-value в порядке чтения.
spans	DocumentSpan[]	Расположение элемента key-value в сцепленном содержимом порядка чтения.

DocumentKeyValuePair

Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым).

Имя	Тип	Описание
confidence	number	Уверенность в правильном извлечении пары "ключ-значение".
key	DocumentKeyValueElement	Метка поля пары "ключ-значение".
value	DocumentKeyValueElement	Значение поля пары "ключ-значение".

DocumentLanguage

Объект, представляющий обнаруженный язык для заданного диапазона текста.

Имя	Тип	Описание
confidence	number	Уверенность в правильном определении языка.
locale	string	Обнаруженный язык. Значение может содержать код языка ISO 639-1 (например, en, fr) или тег языка BCP 47 (например, "zh-Hans").
spans	DocumentSpan[]	Расположение текстовых элементов в сцепленном содержимом, к который применяется язык.

DocumentLine

Объект строки содержимого, состоящий из соседней последовательности элементов содержимого, таких как слова и знаки выделения.

Имя	Тип	Описание
content	string	Сцепленное содержимое содержащихся элементов в порядке чтения.
polygon	number[]	Ограничивающий многоугольник линии с координатами, указанными относительно верхней левой части страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
spans	DocumentSpan[]	Расположение строки в сцепленном содержимом порядка чтения.

DocumentPage

Элементы содержимого и макета, извлеченные на странице из входных данных.

Имя	Тип	Описание
angle	number	Общая ориентация содержимого в часовом направлении, измеряемая в градусах между (-180, 180].
barcodes	DocumentBarcode[]	Извлеченные штрихкоды на странице.
formulas	DocumentFormula[]	Извлеченные формулы на странице.
height	number	Высота изображения/PDF в пикселях/дюймах соответственно.
lines	DocumentLine[]	Извлеченные строки из страницы, потенциально содержащие текстовые и визуальные элементы.
pageNumber	integer	Номер страницы на основе 1 в входном документе.
selectionMarks	DocumentSelectionMark[]	Извлеченные метки выделения на странице.
spans	DocumentSpan[]	Расположение страницы в сцепленном содержимом порядка чтения.
unit	LengthUnit	Единица, используемая свойствами ширины, высоты и многоугольника. Для изображений единица — "пиксель". Для PDF единица — "дюйм".
width	number	Ширина изображения/PDF в пикселях/дюймах соответственно.
words	DocumentWord[]	Извлеченные слова из страницы.

DocumentParagraph

Объект абзаца, состоящий с смежными линиями, как правило, с общим выравниванием и интервалами.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие регионы, охватывающие абзац.
content	string	Сцепленное содержимое абзаца в порядке чтения.
role	ParagraphRole	Семантическая роль абзаца.
spans	DocumentSpan[]	Расположение абзаца в сцепленном содержимом порядка чтения.

DocumentSection

Объект, представляющий раздел в документе.

Имя	Тип	Описание
elements	string[]	Дочерние элементы раздела.
spans	DocumentSpan[]	Расположение раздела в сцепленном содержимом порядка чтения.

DocumentSelectionMark

Объект метки выбора, представляющий флажки, переключатели и другие элементы, указывающие на выделение.

Имя	Тип	Описание
confidence	number	Уверенность в правильном извлечении метки выделения.
polygon	number[]	Ограничивающий многоугольник знака выделения с координатами, указанными относительно левого верхнего слева страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
span	DocumentSpan	Расположение знака выделения в порядке чтения сцепленного содержимого.
state	DocumentSelectionMarkState	Состояние знака выделения.

DocumentSelectionMarkState

Состояние знака выделения.

Имя	Тип	Описание
selected	string	Выбрана метка выбора, часто указываемая флажкой ✓ или крестом X внутри знака выделения.
unselected	string	Метка выбора не выбрана.

DocumentSignatureType

Наличие подписи.

Имя	Тип	Описание
signed	string	Обнаружена подпись.
unsigned	string	Подписи не обнаружены.

DocumentSpan

Непрерывная область сцепленного свойства содержимого, указанная как смещение и длина.

Имя	Тип	Описание
length	integer	Количество символов в содержимом, представленных диапазоном.
offset	integer	Отсчитываемый от нуля индекс содержимого, представленный диапазоном.

DocumentStyle

Объект, представляющий наблюдаемые стили текста.

Имя	Тип	Описание
backgroundColor	string	Цвет фона в #rrggbb шестнадцатеричном формате..
color	string	Цвет переднего плана в #rrggbb шестнадцатеричном формате.
confidence	number	Уверенность в правильном определении стиля.
fontStyle	FontStyle	Стиль шрифта.
fontWeight	FontWeight	Вес шрифта.
isHandwritten	boolean	Является ли содержимое рукописным текстом?
similarFontFamily	string	Визуально наиболее похожий шрифт из набора поддерживаемых семейств шрифтов с резервными шрифтами после соглашения CSS (например, Arial, sans-serif).
spans	DocumentSpan[]	Расположение текстовых элементов в сцепленном содержимом, к который применяется стиль.

DocumentTable

Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.

Имя	Тип	Описание
boundingRegions	BoundingRegion[]	Ограничивающие области, охватывающие таблицу.
caption	DocumentCaption	Подпись, связанная с таблицей.
cells	DocumentTableCell[]	Ячейки, содержащиеся в таблице.
columnCount	integer	Количество столбцов в таблице.
footnotes	DocumentFootnote[]	Список сносок, связанных с таблицей.
rowCount	integer	Количество строк в таблице.
spans	DocumentSpan[]	Расположение таблицы в сцепленном содержимом порядка чтения.

DocumentTableCell

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

Имя	Тип	Default value	Описание
boundingRegions	BoundingRegion[]		Ограничивающие области, охватывающие ячейку таблицы.
columnIndex	integer		Индекс столбца ячейки.
columnSpan	integer	1	Число столбцов, охватываемых этой ячейкой.
content	string		Сцепленное содержимое ячейки таблицы в порядке чтения.
elements	string[]		Дочерние элементы ячейки таблицы.
kind	DocumentTableCellKind	content	Тип ячейки таблицы.
rowIndex	integer		Индекс строки ячейки.
rowSpan	integer	1	Количество строк, охватываемых этой ячейкой.
spans	DocumentSpan[]		Расположение ячейки таблицы в сцепленном содержимом порядка чтения.

DocumentTableCellKind

Тип ячейки таблицы.

Имя	Тип	Описание
columnHeader	string	Описывает содержимое столбца.
content	string	Содержит основное содержимое или данные.
description	string	Описывает содержимое в (частях) таблицы.
rowHeader	string	Описывает содержимое строки.
stubHead	string	Описывает заголовки строк, обычно расположенные в левом верхнем углу таблицы.

DocumentWord

Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.

Имя	Тип	Описание
confidence	number	Уверенность в правильном извлечении слова.
content	string	Текстовое содержимое слова.
polygon	number[]	Ограничивающий многоугольник слова с координатами, указанными относительно верхней левой части страницы. Числа представляют значения x, y вершин многоугольников, по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента.
span	DocumentSpan	Расположение слова в порядке чтения сцепленного содержимого.

Error

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

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

ErrorResponse

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

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

FontStyle

Стиль шрифта.

Имя	Тип	Описание
italic	string	Символы визуально наклоняются справа.
normal	string	Символы представлены обычно.

FontWeight

Вес шрифта.

Имя	Тип	Описание
bold	string	Символы представлены более толстыми штрихами.
normal	string	Символы представлены обычно.

InnerError

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

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

LengthUnit

Единица, используемая свойствами ширины, высоты и многоугольника. Для изображений единица — "пиксель". Для PDF единица — "дюйм".

Имя	Тип	Описание
inch	string	Единица длины для PDF-файлов.
pixel	string	Единица длины для файлов изображений.

OperationStatus

Состояние операции.

Имя	Тип	Описание
canceled	string	Операция отменена.
completed	string	Операция завершена.
failed	string	Операция завершилась ошибкой.
notStarted	string	Операция еще не запущена.
running	string	Операция выполняется.
succeeded	string	Операция выполнена успешно.

ParagraphRole

Семантическая роль абзаца.

Имя	Тип	Описание
footnote	string	Примечание обычно помещается после основного содержимого на странице.
formulaBlock	string	Блок формул, часто с общим выравниванием.
pageFooter	string	Текст возле нижнего края страницы.
pageHeader	string	Текст рядом с верхним краем страницы.
pageNumber	string	Номер страницы.
sectionHeading	string	Подзаголовок, описывающий раздел документа.
title	string	Заголовок верхнего уровня, описывающий весь документ.

StringIndexType

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

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

Warning

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

Имя	Тип	Описание
code	string	Один из определяемых сервером набор кодов предупреждений.
message	string	Доступное для чтения представление предупреждения.
target	string	Целевой объект ошибки.