Document Classifiers - Get Classify Result
Возвращает результат классификатора документов.
GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-02-29-preview
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
classifier
|
path | True |
string |
Уникальное имя классификатора документов. Regex pattern: |
endpoint
|
path | True |
string |
Конечная точка службы аналитики документов. |
result
|
path | True |
string uuid |
Анализ идентификатора результата операции. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Запрос выполнен успешно. |
|
Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
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 |
Примеры
Get Classify Document Result
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview
Sample Response
{
"status": "succeeded",
"createdDateTime": "2021-09-24T13:00:46Z",
"lastUpdatedDateTime": "2021-09-24T13:00:49Z",
"analyzeResult": {
"apiVersion": "2024-02-29-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": []
}
]
}
}
Определения
Имя | Описание |
---|---|
Address |
Значение поля адреса. |
Analyze |
Результат анализа документов. |
Analyze |
Состояние и результат операции анализа. |
Bounding |
Ограничивающий многоугольник на определенной странице входных данных. |
Content |
Формат содержимого в анализируемом результате. |
Currency |
Значение поля валюты. |
Document |
Объект , описывающий расположение и семантическое содержимое документа. |
Document |
Объект штрихкода. |
Document |
Вид штрихкода. |
Document |
Объект подпись, описывающий таблицу или рисунок. |
Document |
Объект , представляющий содержимое и расположение значения поля. |
Document |
Семантический тип данных значения поля. |
Document |
Объект , представляющий рисунок в документе. |
Document |
Объект сноски, описывающий таблицу или рисунок. |
Document |
Объект формулы. |
Document |
Тип формулы. |
Document |
Объект , представляющий ключ поля или значение в паре "ключ-значение". |
Document |
Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым). |
Document |
Объект , представляющий обнаруженный язык для заданного текстового диапазона. |
Document |
Объект строки содержимого, состоящий из смежной последовательности элементов содержимого, таких как слова и метки выделения. |
Document |
Объект , представляющий список в документе. |
Document |
Объект , представляющий элемент списка в документе. |
Document |
Элементы содержимого и макета, извлеченные из страницы из входных данных. |
Document |
Объект абзаца, состоящий из смежных строк, как правило, с общим выравниванием и интервалом. |
Document |
Объект , представляющий раздел в документе. |
Document |
Объект метки выделения, представляющий проверка прямоугольники, переключатели и другие элементы, указывающие на выделение. |
Document |
Состояние выделенной метки. |
Document |
Наличие подписи. |
Document |
Непрерывная область сцепленного свойства содержимого, указанная в виде смещения и длины. |
Document |
Объект , представляющий наблюдаемые стили текста. |
Document |
Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете. |
Document |
Объект , представляющий расположение и содержимое ячейки таблицы. |
Document |
Тип ячейки таблицы. |
Document |
Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово. |
Error |
Объект ошибки. |
Error |
Объект ответа об ошибке. |
Font |
Стиль шрифта. |
Font |
Вес шрифта. |
Inner |
Объект , содержащий более конкретные сведения об ошибке. |
Length |
Единица измерения, используемая свойствами ширины, высоты и многоугольника. Для изображений единицей является пиксель. Для PDF единица имеет значение "дюйм". |
Operation |
Состояние операции. |
Paragraph |
Семантическая роль абзаца. |
String |
Метод, используемый для вычисления смещения и длины строки. |
AddressValue
Значение поля адреса.
Имя | Тип | Описание |
---|---|---|
city |
string |
Название города, города, деревни и т. д. |
cityDistrict |
string |
Районы или районы в пределах города, такие как Бруклин в Нью-йорке или Вестминстер в Лондоне. |
countryRegion |
string |
Страна или регион. |
house |
string |
Имя сборки, например Всемирный торговый центр. |
houseNumber |
string |
Номер дома или здания. |
level |
string |
Номер этажа, например 3F. |
poBox |
string |
Почтовый ящик. |
postalCode |
string |
Почтовый индекс, используемый для сортировки почты. |
road |
string |
Название улицы. |
state |
string |
Административное деление первого уровня. |
stateDistrict |
string |
Административное деление второго уровня, используемое в определенных языковых стандартах. |
streetAddress |
string |
Адрес на уровне улицы, за исключением города, штата, страныРегион и почтовый индекс. |
suburb |
string |
Неофициальное название района, как Чайнатаун. |
unit |
string |
Номер квартиры или офиса |
AnalyzeResult
Результат анализа документов.
Имя | Тип | Описание |
---|---|---|
apiVersion |
string |
Версия API, используемая для получения этого результата. |
content |
string |
Сцепить строковое представление всех текстовых и визуальных элементов в порядке чтения. |
contentFormat |
Формат содержимого результата анализа верхнего уровня. |
|
documents |
Document[] |
Извлеченные документы. |
figures |
Извлеченные цифры. |
|
keyValuePairs |
Извлеченные пары "ключ-значение". |
|
languages |
Обнаруженные языки. |
|
lists |
Извлеченные списки. |
|
modelId |
string |
Идентификатор модели документа, используемый для получения этого результата. |
pages |
Проанализированные страницы. |
|
paragraphs |
Извлеченные абзацы. |
|
sections |
Извлеченные разделы. |
|
stringIndexType |
Метод, используемый для вычисления смещения и длины строки. |
|
styles |
Извлеченные стили шрифтов. |
|
tables |
Извлеченные таблицы. |
AnalyzeResultOperation
Состояние и результат операции анализа.
Имя | Тип | Описание |
---|---|---|
analyzeResult |
Результат анализа документов. |
|
createdDateTime |
string |
Дата и время (UTC) отправки операции анализа. |
error |
Произошла ошибка во время анализа документа. |
|
lastUpdatedDateTime |
string |
Дата и время (UTC) последнего обновления состояния. |
status |
Состояние операции. notStarted, Running, Succeeded или Failed |
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 |
Ограничивающие области, охватывающие документ. |
|
confidence |
number |
Уверенность в правильном извлечении документа. |
docType |
string |
Тип документа. |
fields |
<string,
Document |
Словарь именованных значений полей. |
spans |
Расположение документа в порядке чтения сцепленного содержимого. |
DocumentBarcode
Объект штрихкода.
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильном извлечении штрихкода. |
kind |
Вид штрихкода. |
|
polygon |
number[] |
Ограничивающий многоугольник штрихкода с указанными координатами относительно левого верхнего углу страницы. Числа представляют значения x, y вершин многоугольников по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
span |
Расположение штрихкода в сцепленном содержимом порядка чтения. |
|
value |
string |
Значение штрихкода. |
DocumentBarcodeKind
Вид штрихкода.
Имя | Тип | Описание |
---|---|---|
Aztec |
string |
Код ацтеков, как определено в 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 |
Ограничивающие области, охватывающие подпись. |
|
content |
string |
Содержимое подпись. |
elements |
string[] |
Дочерние элементы подпись. |
spans |
Расположение подпись в сцепленном содержимом в порядке чтения. |
DocumentField
Объект , представляющий содержимое и расположение значения поля.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие поле. |
|
confidence |
number |
Уверенность в правильном извлечении поля. |
content |
string |
Содержимое поля. |
spans |
Расположение поля в сцепленном содержимом порядка чтения. |
|
type |
Тип данных значения поля. |
|
valueAddress |
Значение адреса. |
|
valueArray |
Массив значений полей. |
|
valueBoolean |
boolean |
. |
valueCountryRegion |
string |
3-буквное значение кода страны (ISO 3166-1 alpha-3). |
valueCurrency |
Значение валюты. |
|
valueDate |
string |
Значение даты в формате ГГГГ-ММ-ДД (ISO 8601). |
valueInteger |
integer |
Целое значение. |
valueNumber |
number |
Значение с плавающей запятой. |
valueObject |
<string,
Document |
Словарь именованных значений полей. |
valuePhoneNumber |
string |
Значение номера телефона в формате E.164 (например, +19876543210). |
valueSelectionGroup |
string[] |
Значение группы выбора. |
valueSelectionMark |
Значение метки выбора. |
|
valueSignature |
Наличие подписи. |
|
valueString |
string |
Строковое значение. |
valueTime |
string |
Значение времени в формате чч:мм:сс (ISO 8601). |
DocumentFieldType
Семантический тип данных значения поля.
Имя | Тип | Описание |
---|---|---|
address |
string |
Проанализированный адрес. |
array |
string |
Список подполей того же типа. |
boolean |
string |
Логическое значение, нормализованное до true или false. |
countryRegion |
string |
Страна или регион, нормализованный в формате ISO 3166-1 alpha-3 (например, США). |
currency |
string |
Сумма валюты с необязательным символом валюты и единицей измерения. |
date |
string |
Дата, нормализованная в формате ISO 8601 (ГГГГ-ММ-ДД). |
integer |
string |
Целочисленное число, нормализованное до 64-разрядного целого числа со знаком. |
number |
string |
Число с плавающей запятой, нормализованное до двойной точности с плавающей запятой. |
object |
string |
Именованный список подполей потенциально различных типов. |
phoneNumber |
string |
Номер телефона, нормализованный до формата E.164 (+{CountryCode}{SubscriberNumber}). |
selectionGroup |
string |
Массив выбранных строковых значений. |
selectionMark |
string |
Выбрано ли поле? |
signature |
string |
Существует ли подпись? |
string |
string |
Обычный текст. |
time |
string |
Время, нормализованное до формата ISO 8601 (чч:мм:сс). |
DocumentFigure
Объект , представляющий рисунок в документе.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие фигуру. |
|
caption |
Заголовок, связанный с рисунком. |
|
elements |
string[] |
Дочерние элементы рисунка, за исключением подпись или сносок. |
footnotes |
Список сносок, связанных с рисунком. |
|
spans |
Расположение рисунка в сцепленном содержимом порядка чтения. |
DocumentFootnote
Объект сноски, описывающий таблицу или рисунок.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие сноску. |
|
content |
string |
Содержимое сноски. |
elements |
string[] |
Дочерние элементы сноски. |
spans |
Расположение сноски в сцепленном содержимом в порядке чтения. |
DocumentFormula
Объект формулы.
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильном извлечении формулы. |
kind |
Тип формулы. |
|
polygon |
number[] |
Ограничивающий многоугольник формулы с указанными координатами относительно левого верхнего углу страницы. Числа представляют значения x, y вершин многоугольников по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
span |
Расположение формулы в сцепленном содержимом порядка чтения. |
|
value |
string |
Выражение LaTex, описывающее формулу. |
DocumentFormulaKind
Тип формулы.
Имя | Тип | Описание |
---|---|---|
display |
string |
Формула в режиме отображения, которая занимает всю строку. |
inline |
string |
Формула, внедренная в содержимое абзаца. |
DocumentKeyValueElement
Объект , представляющий ключ поля или значение в паре "ключ-значение".
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие элемент "ключ—значение". |
|
content |
string |
Сцепленное содержимое элемента "ключ-значение" в порядке чтения. |
spans |
Расположение элемента "ключ-значение" в сцепленном содержимом порядка чтения. |
DocumentKeyValuePair
Объект, представляющий поле формы с отдельной меткой поля (ключом) и значением поля (может быть пустым).
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильном извлечении пары "ключ-значение". |
key |
Метка поля пары "ключ-значение". |
|
value |
Значение поля пары "ключ-значение". |
DocumentLanguage
Объект , представляющий обнаруженный язык для заданного текстового диапазона.
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильной идентификации языка. |
locale |
string |
Обнаруженный язык. Значение может содержать код языка ISO 639-1 (например, "en", "fr") или тег языка BCP 47 (например, "zh-Hans"). |
spans |
Расположение текстовых элементов в сцепленном содержимом, к которому применяется язык. |
DocumentLine
Объект строки содержимого, состоящий из смежной последовательности элементов содержимого, таких как слова и метки выделения.
Имя | Тип | Описание |
---|---|---|
content |
string |
Сцепленное содержимое содержащихся элементов в порядке чтения. |
polygon |
number[] |
Ограничивающий многоугольник линии с указанными координатами относительно левого верхнего углу страницы. Числа представляют значения x, y вершин многоугольников по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
spans |
Расположение строки в сцепленном содержимом порядка чтения. |
DocumentList
Объект , представляющий список в документе.
Имя | Тип | Описание |
---|---|---|
items |
Элементы в списке. |
|
spans |
Расположение списка в сцепленном содержимом порядка чтения. |
DocumentListItem
Объект , представляющий элемент списка в документе.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие элемент списка. |
|
content |
string |
Содержимое элемента списка. |
elements |
string[] |
Дочерние элементы элемента списка. |
level |
integer |
Уровень элемента списка (с индексированием 1). |
spans |
Расположение элемента списка в сцепленном содержимом порядка чтения. |
DocumentPage
Элементы содержимого и макета, извлеченные из страницы из входных данных.
Имя | Тип | Описание |
---|---|---|
angle |
number |
Общая ориентация содержимого по часовой стрелке, измеряемая в градусах между (-180, 180]. |
barcodes |
Извлеченные штрихкоды со страницы. |
|
formulas |
Извлеченные формулы со страницы. |
|
height |
number |
Высота изображения/PDF в пикселях/дюймах соответственно. |
lines |
Извлеченные строки со страницы, потенциально содержащие как текстовые, так и визуальные элементы. |
|
pageNumber |
integer |
1 номер страницы во входном документе. |
selectionMarks |
Извлеченные метки выделения со страницы. |
|
spans |
Расположение страницы в сцепленном содержимом в порядке чтения. |
|
unit |
Единица измерения, используемая свойствами ширины, высоты и многоугольника. Для изображений единицей является пиксель. Для PDF единица имеет значение "дюйм". |
|
width |
number |
Ширина изображения/PDF в пикселях/дюймах соответственно. |
words |
Извлеченные слова со страницы. |
DocumentParagraph
Объект абзаца, состоящий из смежных строк, как правило, с общим выравниванием и интервалом.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие абзац. |
|
content |
string |
Сцепленное содержимое абзаца в порядке чтения. |
role |
Семантическая роль абзаца. |
|
spans |
Расположение абзаца в сцепленном содержимом в порядке чтения. |
DocumentSection
Объект , представляющий раздел в документе.
Имя | Тип | Описание |
---|---|---|
elements |
string[] |
Дочерние элементы раздела. |
spans |
Расположение раздела в сцепленном содержимом порядка чтения. |
DocumentSelectionMark
Объект метки выделения, представляющий проверка прямоугольники, переключатели и другие элементы, указывающие на выделение.
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильном извлечении выделенной метки. |
polygon |
number[] |
Ограничивающий многоугольник выделенной метки с координатами, указанными относительно левого верхнего углу страницы. Числа представляют значения x, y вершин многоугольников по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
span |
Расположение выделенной метки в сцепленном содержимом порядка чтения. |
|
state |
Состояние выделенной метки. |
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 |
Стиль шрифта. |
|
fontWeight |
Вес шрифта. |
|
isHandwritten |
boolean |
Является ли содержимое рукописным? |
similarFontFamily |
string |
Визуально наиболее похожий шрифт из набора поддерживаемых семейств шрифтов, а резервные шрифты соответствуют соглашению CSS (например, Arial, sans-serif). |
spans |
Расположение текстовых элементов в сцепленном содержимом, к которому применяется стиль. |
DocumentTable
Объект таблицы, состоящий из ячеек таблицы, расположенных в прямоугольном макете.
Имя | Тип | Описание |
---|---|---|
boundingRegions |
Ограничивающие области, охватывающие таблицу. |
|
caption |
Заголовок, связанный с таблицей. |
|
cells |
Ячейки, содержащиеся в таблице. |
|
columnCount |
integer |
Число столбцов в таблице. |
footnotes |
Список сносок, связанных с таблицей. |
|
rowCount |
integer |
Количество строк в таблице. |
spans |
Расположение таблицы в сцепленном содержимом порядка чтения. |
DocumentTableCell
Объект , представляющий расположение и содержимое ячейки таблицы.
Имя | Тип | Значение по умолчанию | Описание |
---|---|---|---|
boundingRegions |
Ограничивающие области, охватывающие ячейку таблицы. |
||
columnIndex |
integer |
Индекс столбца ячейки. |
|
columnSpan |
integer |
1 |
Число столбцов, охватываемых этой ячейкой. |
content |
string |
Сцепленное содержимое ячейки таблицы в порядке чтения. |
|
elements |
string[] |
Дочерние элементы ячейки таблицы. |
|
kind | content |
Тип ячейки таблицы. |
|
rowIndex |
integer |
Индекс строки ячейки. |
|
rowSpan |
integer |
1 |
Число строк, охватываемых этой ячейкой. |
spans |
Расположение ячейки таблицы в сцепленном содержимом порядка чтения. |
DocumentTableCellKind
Тип ячейки таблицы.
Имя | Тип | Описание |
---|---|---|
columnHeader |
string |
Описывает содержимое столбца. |
content |
string |
Содержит main содержимого или данных. |
description |
string |
Описывает содержимое (части) таблицы. |
rowHeader |
string |
Описывает содержимое строки. |
stubHead |
string |
Описывает заголовки строк, обычно расположенные в левом верхнем углу таблицы. |
DocumentWord
Объект слова, состоящий из непрерывной последовательности символов. Для языков, не разделенных пробелами, таких как китайский, японский и корейский, каждый символ представлен как собственное слово.
Имя | Тип | Описание |
---|---|---|
confidence |
number |
Уверенность в правильном извлечении слова. |
content |
string |
Текстовое содержимое слова. |
polygon |
number[] |
Ограничивающий многоугольник слова с указанными координатами относительно левого верхнего углу страницы. Числа представляют значения x, y вершин многоугольников по часовой стрелке слева (-180 градусов включительно) относительно ориентации элемента. |
span |
Расположение слова в сцепленном содержимом в порядке чтения. |
Error
Объект ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из серверных наборов кодов ошибок. |
details |
Error[] |
Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке. |
innererror |
Объект , содержащий более конкретные сведения об ошибке, чем текущий объект. |
|
message |
string |
Понятное представление ошибки. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Объект ответа об ошибке.
Имя | Тип | Описание |
---|---|---|
error |
Сведения об ошибке. |
FontStyle
Стиль шрифта.
Имя | Тип | Описание |
---|---|---|
italic |
string |
Символы визуально наклоняются вправо. |
normal |
string |
Символы представлены в обычном режиме. |
FontWeight
Вес шрифта.
Имя | Тип | Описание |
---|---|---|
bold |
string |
Символы представлены более толстыми штрихами. |
normal |
string |
Символы представлены в обычном режиме. |
InnerError
Объект , содержащий более конкретные сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
code |
string |
Один из серверных наборов кодов ошибок. |
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 |
Заметка, как правило, помещается после main содержимого на странице. |
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. |