Document Classifiers - Get Classify Result
Obtiene el resultado del clasificador de documentos.
GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-07-31-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
classifier
|
path | True |
string |
Nombre único del clasificador de documentos. Patrón de Regex: |
endpoint
|
path | True |
string uri |
Punto de conexión del servicio De inteligencia de documentos. |
result
|
path | True |
string uuid |
Analice el identificador de resultado de la operación. |
api-version
|
query | True |
string |
Versión de la API que se va a usar para esta operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
La solicitud se ha realizado correctamente. |
|
Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
Ocp-Apim-Subscription-Key
Tipo:
apiKey
En:
header
OAuth2Auth
Tipo:
oauth2
Flujo:
accessCode
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token:
https://login.microsoftonline.com/common/oauth2/token
Ámbitos
Nombre | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Ejemplos
Get Classify Document Result
Solicitud de ejemplo
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview
Respuesta de muestra
{
"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": []
}
]
}
}
Definiciones
Nombre | Description |
---|---|
Address |
Valor del campo de dirección. |
Analyze |
Resultado del análisis de documentos. |
Analyze |
Estado y resultado de la operación de análisis. |
Bounding |
Polígono delimitador en una página específica de la entrada. |
Content |
Formato del contenido en el resultado analizado. |
Currency |
Valor del campo moneda. |
Document |
Objeto que describe la ubicación y el contenido semántico de un documento. |
Document |
Objeto de código de barras. |
Document |
Tipo de código de barras. |
Document |
Objeto caption que describe una tabla o una figura. |
Document |
Objeto que representa el contenido y la ubicación de un valor de campo. |
Document |
Tipo de datos semántico del valor de campo. |
Document |
Objeto que representa una figura del documento. |
Document |
Objeto de nota al pie que describe una tabla o una figura. |
Document |
Objeto de fórmula. |
Document |
Tipo de fórmula. |
Document |
Objeto que representa la clave de campo o el valor de un par clave-valor. |
Document |
Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío). |
Document |
Objeto que representa el idioma detectado para un intervalo de texto determinado. |
Document |
Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección. |
Document |
Elementos de contenido y diseño extraídos de una página de la entrada. |
Document |
Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes. |
Document |
Objeto que representa una sección del documento. |
Document |
Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección. |
Document |
Estado de la marca de selección. |
Document |
Presencia de firma. |
Document |
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud. |
Document |
Objeto que representa estilos de texto observados. |
Document |
Objeto table que consta de celdas de tabla organizadas en un diseño rectangular. |
Document |
Objeto que representa la ubicación y el contenido de una celda de tabla. |
Document |
Tipo de celda de tabla. |
Document |
Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra. |
Error |
Objeto de error. |
Error |
Objeto de respuesta de error. |
Font |
Estilo de fuente. |
Font |
Peso de fuente. |
Inner |
Objeto que contiene información más específica sobre el error. |
Length |
Unidad usada por las propiedades width, height y polygon. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada". |
Operation |
Estado de la operación. |
Paragraph |
Rol semántico del párrafo. |
String |
Método usado para calcular el desplazamiento y la longitud de la cadena. |
Warning |
Objeto de error. |
AddressValue
Valor del campo de dirección.
Nombre | Tipo | Description |
---|---|---|
city |
string |
Nombre de la ciudad, ciudad, pueblo, etcetera. |
cityDistrict |
string |
Distritos o distritos dentro de una ciudad, como Brooklyn en La Ciudad de Nueva York o Ciudad de Westminster en Londres. |
countryRegion |
string |
País o región. |
house |
string |
Nombre de compilación, como World Trade Center. |
houseNumber |
string |
Número de casa o edificio. |
level |
string |
Número de piso, como 3F. |
poBox |
string |
Número de cuadro de oficina de correos. |
postalCode |
string |
Código postal usado para la ordenación de correo. |
road |
string |
Nombre de la calle. |
state |
string |
División administrativa de primer nivel. |
stateDistrict |
string |
División administrativa de segundo nivel usada en determinadas configuraciones regionales. |
streetAddress |
string |
Dirección de nivel de calle, excepto ciudad, estado, countryRegion y postalCode. |
suburb |
string |
Nombre de barrio no oficial, como Chinatown. |
unit |
string |
Número de apartamento u oficina |
AnalyzeResult
Resultado del análisis de documentos.
Nombre | Tipo | Description |
---|---|---|
apiVersion |
string |
Versión de API que se usa para generar este resultado. |
content |
string |
Concatene la representación de cadena de todos los elementos textuales y visuales en orden de lectura. |
contentFormat |
Formato del contenido de nivel superior de análisis de resultados. |
|
documents |
Document[] |
Documentos extraídos. |
figures |
Figuras extraídas. |
|
keyValuePairs |
Pares clave-valor extraídos. |
|
languages |
Idiomas detectados. |
|
modelId |
string |
Identificador del modelo de documento usado para generar este resultado. |
pages |
Páginas analizadas. |
|
paragraphs |
Párrafos extraídos. |
|
sections |
Secciones extraídas. |
|
stringIndexType |
Método usado para calcular el desplazamiento y la longitud de la cadena. |
|
styles |
Estilos de fuente extraídos. |
|
tables |
Tablas extraídas. |
|
warnings |
Warning[] |
Lista de advertencias encontradas. |
AnalyzeResultOperation
Estado y resultado de la operación de análisis.
Nombre | Tipo | Description |
---|---|---|
analyzeResult |
Resultado del análisis de documentos. |
|
createdDateTime |
string |
Fecha y hora (UTC) cuando se envió la operación de análisis. |
error |
Se encontró un error durante el análisis de documentos. |
|
lastUpdatedDateTime |
string |
Fecha y hora (UTC) cuando se actualizó por última vez el estado. |
status |
Estado de la operación. notStarted, running, succeeded o failed |
BoundingRegion
Polígono delimitador en una página específica de la entrada.
Nombre | Tipo | Description |
---|---|---|
pageNumber |
integer |
Número de página basado en 1 página que contiene la región de límite. |
polygon |
number[] |
Polígono delimitador en la página o toda la página si no se especifica. Coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
ContentFormat
Formato del contenido en el resultado analizado.
Nombre | Tipo | Description |
---|---|---|
markdown |
string |
Representación de Markdown del contenido del documento con encabezados de sección, tablas etcetera. |
text |
string |
Representación de texto sin formato del contenido del documento sin formato. |
CurrencyValue
Valor del campo moneda.
Nombre | Tipo | Description |
---|---|---|
amount |
number |
Importe de moneda. |
currencyCode |
string |
Código de moneda resuelto (ISO 4217), si existe. |
currencySymbol |
string |
Etiqueta de símbolo de moneda, si existe. |
Document
Objeto que describe la ubicación y el contenido semántico de un documento.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan el documento. |
|
confidence |
number |
Confianza de extraer correctamente el documento. |
docType |
string |
Tipo de documento. |
fields |
<string,
Document |
Diccionario de valores de campo con nombre. |
spans |
Ubicación del documento en el contenido concatenado del orden de lectura. |
DocumentBarcode
Objeto de código de barras.
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de extraer correctamente el código de barras. |
kind |
Tipo de código de barras. |
|
polygon |
number[] |
Polígono delimitador del código de barras, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
span |
Ubicación del código de barras en el contenido concatenado del orden de lectura. |
|
value |
string |
Valor de código de barras. |
DocumentBarcodeKind
Tipo de código de barras.
Nombre | Tipo | Description |
---|---|---|
Aztec |
string |
Código primitivo, tal como se define en ISO/IEC 24778:2008. |
Codabar |
string |
Código de barras codabar, tal como se define en ANSI/AIM BC3-1995. |
Code128 |
string |
Código de barras 128, tal como se define en ISO/IEC 15417:2007. |
Code39 |
string |
Código de barras 39, tal como se define en ISO/IEC 16388:2007. |
Code93 |
string |
Código de barras 93, tal como se define en ANSI/AIM BC5-1995. |
DataBar |
string |
Código de barras de barra de datos GS1. |
DataBarExpanded |
string |
Código de barras expandido de la barra de datos GS1. |
DataMatrix |
string |
Código de matriz de datos, tal como se define en ISO/IEC 16022:2006. |
EAN13 |
string |
Número de artículo internacional de 13 dígitos de GS1 (número de artículo europeo). |
EAN8 |
string |
Número de artículo internacional de 8 dígitos del GS1 (número de artículo europeo). |
ITF |
string |
Intercalado 2 de 5 códigos de barras, tal como se define en ANSI/AIM BC2-1995. |
MaxiCode |
string |
MaxiCode, tal como se define en ISO/IEC 16023:2000. |
MicroQRCode |
string |
Código QR micro, tal como se define en ISO/IEC 23941:2022. |
PDF417 |
string |
PDF417, tal como se define en ISO 15438. |
QRCode |
string |
Código QR, tal como se define en ISO/IEC 18004:2015. |
UPCA |
string |
Código de producto universal de GS1 de 12 dígitos. |
UPCE |
string |
Código de producto universal de 6 dígitos GS1. |
DocumentCaption
Objeto caption que describe una tabla o una figura.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan el título. |
|
content |
string |
Contenido del título. |
elements |
string[] |
Elementos secundarios del título. |
spans |
Ubicación del título en el contenido concatenado del orden de lectura. |
DocumentField
Objeto que representa el contenido y la ubicación de un valor de campo.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan el campo. |
|
confidence |
number |
Confianza de extraer correctamente el campo. |
content |
string |
Contenido del campo. |
spans |
Ubicación del campo en el contenido concatenado del orden de lectura. |
|
type |
Tipo de datos del valor del campo. |
|
valueAddress |
Valor de dirección. |
|
valueArray |
Matriz de valores de campo. |
|
valueBoolean |
boolean |
Valor booleano. |
valueCountryRegion |
string |
Valor de código de país de 3 letras (ISO 3166-1 alfa-3). |
valueCurrency |
Valor de moneda. |
|
valueDate |
string |
Valor de fecha en formato AAAA-MM-DD (ISO 8601). |
valueInteger |
integer |
Valor entero. |
valueNumber |
number |
Valor de punto flotante. |
valueObject |
<string,
Document |
Diccionario de valores de campo con nombre. |
valuePhoneNumber |
string |
Valor de número de teléfono en formato E.164 (por ejemplo, +19876543210). |
valueSelectionGroup |
string[] |
Valor del grupo de selección. |
valueSelectionMark |
Valor de marca de selección. |
|
valueSignature |
Presencia de firma. |
|
valueString |
string |
Valor de cadena. |
valueTime |
string |
Valor de hora en formato hh:mm:ss (ISO 8601). |
DocumentFieldType
Tipo de datos semántico del valor de campo.
Nombre | Tipo | Description |
---|---|---|
address |
string |
Dirección analizada. |
array |
string |
Lista de subcampos del mismo tipo. |
boolean |
string |
Valor booleano, normalizado en true o false. |
countryRegion |
string |
País o región, normalizado con el formato ISO 3166-1 alfa-3 (por ejemplo, EE. UU.). |
currency |
string |
Importe de moneda con símbolo de moneda opcional y unidad. |
date |
string |
Fecha, normalizada con formato ISO 8601 (AAAA-MM-DD). |
integer |
string |
Número entero, normalizado a entero de 64 bits con signo. |
number |
string |
Número de punto flotante, normalizado a punto flotante de precisión doble. |
object |
string |
Lista con nombre de subcampos de tipos potencialmente diferentes. |
phoneNumber |
string |
Número de teléfono, normalizado en formato E.164 (+{CountryCode}{SubscriberNumber}). |
selectionGroup |
string |
Matriz de valores de cadena seleccionados. |
selectionMark |
string |
¿Está seleccionado el campo? |
signature |
string |
¿Está presente la firma? |
string |
string |
Texto sin formato. |
time |
string |
Hora, normalizada a formato ISO 8601 (hh:mm:ss). |
DocumentFigure
Objeto que representa una figura del documento.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones delimitador que abarcan la ilustración. |
|
caption |
Título asociado a la figura. |
|
elements |
string[] |
Elementos secundarios de la ilustración, excepto cualquier título o nota al pie. |
footnotes |
Lista de notas al pie asociadas a la figura. |
|
id |
string |
Id. de figura. |
spans |
Ubicación de la figura en el contenido concatenado del orden de lectura. |
DocumentFootnote
Objeto de nota al pie que describe una tabla o una figura.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan la nota al pie. |
|
content |
string |
Contenido de la nota al pie. |
elements |
string[] |
Elementos secundarios de la nota al pie. |
spans |
Ubicación de la nota al pie en el orden de lectura contenido concatenado. |
DocumentFormula
Objeto de fórmula.
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de extraer correctamente la fórmula. |
kind |
Tipo de fórmula. |
|
polygon |
number[] |
Polígono delimitador de la fórmula, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
span |
Ubicación de la fórmula en el orden de lectura contenido concatenado. |
|
value |
string |
Expresión LaTex que describe la fórmula. |
DocumentFormulaKind
Tipo de fórmula.
Nombre | Tipo | Description |
---|---|---|
display |
string |
Fórmula en modo de presentación que ocupa una línea completa. |
inline |
string |
Fórmula incrustada dentro del contenido de un párrafo. |
DocumentKeyValueElement
Objeto que representa la clave de campo o el valor de un par clave-valor.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan el elemento clave-valor. |
|
content |
string |
Contenido concatenado del elemento clave-valor en orden de lectura. |
spans |
Ubicación del elemento clave-valor en el contenido concatenado del orden de lectura. |
DocumentKeyValuePair
Objeto que representa un campo de formulario con una etiqueta de campo (clave) y un valor de campo distintos (puede estar vacío).
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de extraer correctamente el par clave-valor. |
key |
Etiqueta de campo del par clave-valor. |
|
value |
Valor de campo del par clave-valor. |
DocumentLanguage
Objeto que representa el idioma detectado para un intervalo de texto determinado.
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de identificar correctamente el idioma. |
locale |
string |
Idioma detectado. El valor puede ser un código de idioma ISO 639-1 (por ejemplo, "en", "fr") o una etiqueta de idioma BCP 47 (por ejemplo, "zh-Hans"). |
spans |
Ubicación de los elementos de texto del contenido concatenado al que se aplica el idioma. |
DocumentLine
Objeto de línea de contenido que consta de una secuencia adyacente de elementos de contenido, como palabras y marcas de selección.
Nombre | Tipo | Description |
---|---|---|
content |
string |
Contenido concatenado de los elementos contenidos en orden de lectura. |
polygon |
number[] |
Polígono delimitador de la línea, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
spans |
Ubicación de la línea en el contenido concatenado del orden de lectura. |
DocumentPage
Elementos de contenido y diseño extraídos de una página de la entrada.
Nombre | Tipo | Description |
---|---|---|
angle |
number |
Orientación general del contenido en dirección a las agujas del reloj, medida en grados entre (-180, 180]. |
barcodes |
Códigos de barras extraídos de la página. |
|
formulas |
Fórmulas extraídas de la página. |
|
height |
number |
Alto de la imagen/PDF en píxeles/pulgadas, respectivamente. |
lines |
Líneas extraídas de la página, que pueden contener elementos textuales y visuales. |
|
pageNumber |
integer |
Número de página basado en 1 en el documento de entrada. |
selectionMarks |
Se extrajeron marcas de selección de la página. |
|
spans |
Ubicación de la página en el contenido concatenado del orden de lectura. |
|
unit |
Unidad usada por las propiedades width, height y polygon. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada". |
|
width |
number |
Ancho de la imagen/PDF en píxeles/pulgadas, respectivamente. |
words |
Palabras extraídas de la página. |
DocumentParagraph
Un objeto de párrafo que consta de líneas contiguas generalmente con alineación y espaciado comunes.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan el párrafo. |
|
content |
string |
Contenido concatenado del párrafo en orden de lectura. |
role |
Rol semántico del párrafo. |
|
spans |
Ubicación del párrafo en el contenido concatenado en orden de lectura. |
DocumentSection
Objeto que representa una sección del documento.
Nombre | Tipo | Description |
---|---|---|
elements |
string[] |
Elementos secundarios de la sección. |
spans |
Ubicación de la sección en el contenido concatenado del orden de lectura. |
DocumentSelectionMark
Objeto de marca de selección que representa casillas, botones de radio y otros elementos que indican una selección.
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de extraer correctamente la marca de selección. |
polygon |
number[] |
Polígono delimitador de la marca de selección, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
span |
Ubicación de la marca de selección en el contenido concatenado del orden de lectura. |
|
state |
Estado de la marca de selección. |
DocumentSelectionMarkState
Estado de la marca de selección.
Nombre | Tipo | Description |
---|---|---|
selected |
string |
La marca de selección está seleccionada, a menudo indicada por una marca check ✓ o cross X dentro de la marca de selección. |
unselected |
string |
La marca de selección no está seleccionada. |
DocumentSignatureType
Presencia de firma.
Nombre | Tipo | Description |
---|---|---|
signed |
string |
Se detecta una firma. |
unsigned |
string |
No se detecta ninguna firma. |
DocumentSpan
Región contigua de la propiedad de contenido concatenada, especificada como desplazamiento y longitud.
Nombre | Tipo | Description |
---|---|---|
length |
integer |
Número de caracteres del contenido representado por el intervalo. |
offset |
integer |
Índice de base cero del contenido representado por el intervalo. |
DocumentStyle
Objeto que representa estilos de texto observados.
Nombre | Tipo | Description |
---|---|---|
backgroundColor |
string |
Color de fondo en formato hexadecimal #rrggbb. |
color |
string |
Color de primer plano en #rrggbb formato hexadecimal. |
confidence |
number |
Confianza de identificar correctamente el estilo. |
fontStyle |
Estilo de fuente. |
|
fontWeight |
Peso de fuente. |
|
isHandwritten |
boolean |
¿Está escrito el contenido a mano? |
similarFontFamily |
string |
Visualmente, la fuente más similar del conjunto de familias de fuentes admitidas, con fuentes de reserva después de la convención CSS (por ejemplo, "Arial, sans-serif"). |
spans |
Ubicación de los elementos de texto en el contenido concatenado al que se aplica el estilo. |
DocumentTable
Objeto table que consta de celdas de tabla organizadas en un diseño rectangular.
Nombre | Tipo | Description |
---|---|---|
boundingRegions |
Regiones de límite que abarcan la tabla. |
|
caption |
Título asociado a la tabla. |
|
cells |
Celdas contenidas en la tabla. |
|
columnCount |
integer |
Número de columnas de la tabla. |
footnotes |
Lista de notas al pie asociadas a la tabla. |
|
rowCount |
integer |
Número de filas de la tabla. |
spans |
Ubicación de la tabla en el contenido concatenado del orden de lectura. |
DocumentTableCell
Objeto que representa la ubicación y el contenido de una celda de tabla.
Nombre | Tipo | Valor predeterminado | Description |
---|---|---|---|
boundingRegions |
Regiones de límite que abarcan la celda de la tabla. |
||
columnIndex |
integer |
Índice de columna de la celda. |
|
columnSpan |
integer |
1 |
Número de columnas distribuidas por esta celda. |
content |
string |
Contenido concatenado de la celda de tabla en orden de lectura. |
|
elements |
string[] |
Elementos secundarios de la celda de tabla. |
|
kind | content |
Tipo de celda de tabla. |
|
rowIndex |
integer |
Índice de fila de la celda. |
|
rowSpan |
integer |
1 |
Número de filas distribuidas por esta celda. |
spans |
Ubicación de la celda de tabla en el contenido concatenado del orden de lectura. |
DocumentTableCellKind
Tipo de celda de tabla.
Nombre | Tipo | Description |
---|---|---|
columnHeader |
string |
Describe el contenido de la columna. |
content |
string |
Contiene el contenido o los datos principales. |
description |
string |
Describe el contenido de (partes de) de la tabla. |
rowHeader |
string |
Describe el contenido de la fila. |
stubHead |
string |
Describe los encabezados de fila, normalmente ubicados en la esquina superior izquierda de una tabla. |
DocumentWord
Objeto de palabra que consta de una secuencia contigua de caracteres. Para idiomas no delimitados por espacios, como chino, japonés y coreano, cada carácter se representa como su propia palabra.
Nombre | Tipo | Description |
---|---|---|
confidence |
number |
Confianza de extraer correctamente la palabra. |
content |
string |
Contenido de texto de la palabra. |
polygon |
number[] |
Polígono delimitador de la palabra, con coordenadas especificadas en relación con la parte superior izquierda de la página. Los números representan los valores x, y de los vértices del polígono, en el sentido de las agujas del reloj de la izquierda (-180 grados inclusivos) con respecto a la orientación del elemento. |
span |
Ubicación de la palabra en el orden de lectura contenido concatenado. |
Error
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
details |
Error[] |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
message |
string |
Representación legible del error. |
target |
string |
Destino del error. |
ErrorResponse
Objeto de respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Información de error. |
FontStyle
Estilo de fuente.
Nombre | Tipo | Description |
---|---|---|
italic |
string |
Los caracteres se inclinan visualmente a la derecha. |
normal |
string |
Los caracteres se representan normalmente. |
FontWeight
Peso de fuente.
Nombre | Tipo | Description |
---|---|---|
bold |
string |
Los caracteres se representan con trazos más gruesos. |
normal |
string |
Los caracteres se representan normalmente. |
InnerError
Objeto que contiene información más específica sobre el error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
innererror |
Error interno. |
|
message |
string |
Representación legible del error. |
LengthUnit
Unidad usada por las propiedades width, height y polygon. En el caso de las imágenes, la unidad es "píxel". Para PDF, la unidad es "pulgada".
Nombre | Tipo | Description |
---|---|---|
inch |
string |
Unidad de longitud para archivos PDF. |
pixel |
string |
Unidad de longitud para archivos de imagen. |
OperationStatus
Estado de la operación.
Nombre | Tipo | Description |
---|---|---|
canceled |
string |
Se ha cancelado la operación. |
completed |
string |
La operación se ha completado. |
failed |
string |
Error en la operación. |
notStarted |
string |
La operación aún no se ha iniciado. |
running |
string |
La operación está en curso. |
succeeded |
string |
La operación se ha realizado correctamente. |
ParagraphRole
Rol semántico del párrafo.
Nombre | Tipo | Description |
---|---|---|
footnote |
string |
Una nota se suele colocar después del contenido principal de una página. |
formulaBlock |
string |
Bloque de fórmulas, a menudo con alineación compartida. |
pageFooter |
string |
Texto situado cerca del borde inferior de la página. |
pageHeader |
string |
Texto cerca del borde superior de la página. |
pageNumber |
string |
Número de página. |
sectionHeading |
string |
Sub encabezado que describe una sección del documento. |
title |
string |
Título de nivel superior que describe todo el documento. |
StringIndexType
Método usado para calcular el desplazamiento y la longitud de la cadena.
Nombre | Tipo | Description |
---|---|---|
textElements |
string |
Carácter de visualización percibido por el usuario o clúster de grafos, tal como se define en Unicode 8.0.0. |
unicodeCodePoint |
string |
Unidad de caracteres representada por un único punto de código unicode. Usado por Python 3. |
utf16CodeUnit |
string |
Unidad de caracteres representada por una unidad de código Unicode de 16 bits. Se usa en JavaScript, Java y .NET. |
Warning
Objeto de error.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Uno de un conjunto definido por el servidor de códigos de advertencia. |
message |
string |
Representación legible de la advertencia. |
target |
string |
Destino del error. |