Analyzer - Analyze Layout
Извлекает текст и сведения о макете из заданного документа. Входной документ должен относиться к одному из поддерживаемых типов контента : "application/pdf", "image/jpeg", "image/png", "image/tiff" или "image/bmp". Кроме того, используйте тип application/json, чтобы указать расположение (URI или локальный путь) анализируемого документа.
POST {endpoint}/formrecognizer/v2.1/layout/analyzePOST {endpoint}/formrecognizer/v2.1/layout/analyze?pages={pages}&language={language}&readingOrder={readingOrder}Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus2.api.cognitive.microsoft.com |
|
language
|
query |
В настоящее время только африкаанс ('af'), албанский ('sq'), астурийский ('ast'), баскский ('eu'), Бислама ('bi'), Бретон ('br'), каталанский ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Корниш ('kw'), Корсикан ('co'), крымская монгольская - латинская азбука('crh'), чешский ('cs'), датский ('da'), голландский ('nl'), английский ('en'), эстонский ('et'), фиджианский ('fj'), филиппинский ('fil'), финский ('fi'), французский ('fr'), фриульский ('fur'), галийский ('gl'), немецкий ('de'), gilbertese ('gil'), гренландский ('kl'), Гаитянский креол ('ht'), Хани ('hni'), Хмонг Дау ('mww'), венгерский ('hu'), индонезийский ('id'), Interlingua ('ia'), Inuktitut ('iu'), ирландский ('ga'), итальянский ('it'), японский ('ja'), javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), кашубский ('csb'), хаси ('kha'), корейский ('ko'), курдский - латинский ('ku'), k'iche' ('quc'), люксембургский ('lb'), малайский ('ms'), Manx ('gv'), неаполитанский ('nap'), норвежский ('no'), occitan ('oc'), польский ('pl'), Португальский ('pt'), romansh ('rm'), шотландцы ('sco'), шотландский гэльский ('gd'), упрощенный китайский ('zh-Hans'), словенский ('sl'), испанский ('es'), суахили ('sw'), шведский ('sv'), латиница ('tt'), тетум ('tet'), традиционный китайский ('zh-Hant'), Поддерживаются турецкий ('tr'), верхнелужипский ('hsb'), узбекский ('uz'), volapük ('vo'), walser ('wae'), западный фризский ('fy'), yucatec maya ('yua'), чжуанг ('za') и zulu ('zu') поддерживаются (печать — семьдесят три языка и рукописный текст — только английский). Макет поддерживает автоматическую идентификацию языка и многоязычные документы, поэтому предоставляйте код языка только в том случае, если требуется принудительно обработать документированную документацию как конкретный язык. |
||
|
pages
|
query |
string[] |
Пользовательские номера страниц для многостраничных документов (PDF/TIFF), введите количество страниц, которые вы хотите получить результат OCR. Для диапазона страниц используйте дефис. Разделите каждую страницу или диапазон с помощью запятой. |
|
|
reading
|
query |
Алгоритм порядка чтения для сортировки возвращаемых строк текста. Поддерживаемые порядок чтения: basic(default), natural. |
Заголовок запроса
Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
Текст запроса
Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"
| Имя | Тип | Описание |
|---|---|---|
| source |
string |
Путь к исходному файлу. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 202 Accepted |
Запрос успешно поставлен в очередь. Заголовки Operation-Location: string |
|
| Other Status Codes |
Сущность ответа, сопровождающая несвоевременные ответы, содержащие дополнительные сведения об ошибке. |
Безопасность
Ocp-Apim-Subscription-Key
Тип:
apiKey
В:
header
Примеры
Analyze layout
Образец запроса
POST {endpoint}/formrecognizer/v2.1/layout/analyze?language=en
Пример ответа
Operation-Location: {endpoint}/formrecognizer/v2.1/layout/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050fОпределения
| Имя | Описание |
|---|---|
|
Error |
|
|
Error |
|
| Language |
В настоящее время только африкаанс ('af'), албанский ('sq'), астурийский ('ast'), баскский ('eu'), Бислама ('bi'), Бретон ('br'), каталанский ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Корниш ('kw'), Корсикан ('co'), крымская монгольская - латинская азбука('crh'), чешский ('cs'), датский ('da'), голландский ('nl'), английский ('en'), эстонский ('et'), фиджианский ('fj'), филиппинский ('fil'), финский ('fi'), французский ('fr'), фриульский ('fur'), галийский ('gl'), немецкий ('de'), gilbertese ('gil'), гренландский ('kl'), Гаитянский креол ('ht'), Хани ('hni'), Хмонг Дау ('mww'), венгерский ('hu'), индонезийский ('id'), Interlingua ('ia'), Inuktitut ('iu'), ирландский ('ga'), итальянский ('it'), японский ('ja'), javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), кашубский ('csb'), хаси ('kha'), корейский ('ko'), курдский - латинский ('ku'), k'iche' ('quc'), люксембургский ('lb'), малайский ('ms'), Manx ('gv'), неаполитанский ('nap'), норвежский ('no'), occitan ('oc'), польский ('pl'), Португальский ('pt'), romansh ('rm'), шотландцы ('sco'), шотландский гэльский ('gd'), упрощенный китайский ('zh-Hans'), словенский ('sl'), испанский ('es'), суахили ('sw'), шведский ('sv'), латиница ('tt'), тетум ('tet'), традиционный китайский ('zh-Hant'), Поддерживаются турецкий ('tr'), верхнелужипский ('hsb'), узбекский ('uz'), volapük ('vo'), walser ('wae'), западный фризский ('fy'), yucatec maya ('yua'), чжуанг ('za') и zulu ('zu') поддерживаются (печать — семьдесят три языка и рукописный текст — только английский). Макет поддерживает автоматическую идентификацию языка и многоязычные документы, поэтому предоставляйте код языка только в том случае, если требуется принудительно обработать документированную документацию как конкретный язык. |
|
Reading |
Алгоритм порядка чтения для сортировки возвращаемых строк текста. Поддерживаемые порядок чтения: basic(default), natural. |
|
Source |
URI или локальный путь к исходным данным. |
ErrorInformation
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
|
| message |
string |
ErrorResponse
| Имя | Тип | Описание |
|---|---|---|
| error |
Language
В настоящее время только африкаанс ('af'), албанский ('sq'), астурийский ('ast'), баскский ('eu'), Бислама ('bi'), Бретон ('br'), каталанский ('ca'), Cebuano ('ceb'), Chamorro ('ch'), Корниш ('kw'), Корсикан ('co'), крымская монгольская - латинская азбука('crh'), чешский ('cs'), датский ('da'), голландский ('nl'), английский ('en'), эстонский ('et'), фиджианский ('fj'), филиппинский ('fil'), финский ('fi'), французский ('fr'), фриульский ('fur'), галийский ('gl'), немецкий ('de'), gilbertese ('gil'), гренландский ('kl'), Гаитянский креол ('ht'), Хани ('hni'), Хмонг Дау ('mww'), венгерский ('hu'), индонезийский ('id'), Interlingua ('ia'), Inuktitut ('iu'), ирландский ('ga'), итальянский ('it'), японский ('ja'), javanese ('jv'), Kabuverdianu ('kea'), Kachin ('kac'), Kara-Kalpak ('kaa'), кашубский ('csb'), хаси ('kha'), корейский ('ko'), курдский - латинский ('ku'), k'iche' ('quc'), люксембургский ('lb'), малайский ('ms'), Manx ('gv'), неаполитанский ('nap'), норвежский ('no'), occitan ('oc'), польский ('pl'), Португальский ('pt'), romansh ('rm'), шотландцы ('sco'), шотландский гэльский ('gd'), упрощенный китайский ('zh-Hans'), словенский ('sl'), испанский ('es'), суахили ('sw'), шведский ('sv'), латиница ('tt'), тетум ('tet'), традиционный китайский ('zh-Hant'), Поддерживаются турецкий ('tr'), верхнелужипский ('hsb'), узбекский ('uz'), volapük ('vo'), walser ('wae'), западный фризский ('fy'), yucatec maya ('yua'), чжуанг ('za') и zulu ('zu') поддерживаются (печать — семьдесят три языка и рукописный текст — только английский). Макет поддерживает автоматическую идентификацию языка и многоязычные документы, поэтому предоставляйте код языка только в том случае, если требуется принудительно обработать документированную документацию как конкретный язык.
| Имя | Тип | Описание |
|---|---|---|
| af |
string |
|
| ast |
string |
|
| bi |
string |
|
| br |
string |
|
| ca |
string |
|
| ceb |
string |
|
| ch |
string |
|
| co |
string |
|
| crh |
string |
|
| cs |
string |
|
| csb |
string |
|
| da |
string |
|
| de |
string |
|
| en |
string |
|
| es |
string |
|
| et |
string |
|
| eu |
string |
|
| fi |
string |
|
| fil |
string |
|
| fj |
string |
|
| fr |
string |
|
| fur |
string |
|
| fy |
string |
|
| ga |
string |
|
| gd |
string |
|
| gil |
string |
|
| gl |
string |
|
| gv |
string |
|
| hni |
string |
|
| hsb |
string |
|
| ht |
string |
|
| hu |
string |
|
| ia |
string |
|
| id |
string |
|
| it |
string |
|
| iu |
string |
|
| ja |
string |
|
| jv |
string |
|
| kaa |
string |
|
| kac |
string |
|
| kea |
string |
|
| kha |
string |
|
| kl |
string |
|
| ko |
string |
|
| ku |
string |
|
| kw |
string |
|
| lb |
string |
|
| ms |
string |
|
| mww |
string |
|
| nap |
string |
|
| nl |
string |
|
| no |
string |
|
| oc |
string |
|
| pl |
string |
|
| pt |
string |
|
| quc |
string |
|
| rm |
string |
|
| sco |
string |
|
| sl |
string |
|
| sq |
string |
|
| sv |
string |
|
| sw |
string |
|
| tet |
string |
|
| tr |
string |
|
| tt |
string |
|
| uz |
string |
|
| vo |
string |
|
| wae |
string |
|
| yua |
string |
|
| za |
string |
|
| zh-Hans |
string |
|
| zh-Hant |
string |
|
| zu |
string |
ReadingOrder
Алгоритм порядка чтения для сортировки возвращаемых строк текста. Поддерживаемые порядок чтения: basic(default), natural.
| Имя | Тип | Описание |
|---|---|---|
| basic |
string |
|
| natural |
string |
SourcePath
URI или локальный путь к исходным данным.
| Имя | Тип | Описание |
|---|---|---|
| source |
string |
Путь к исходному файлу. |