Métodos

La configuración Generar tipo de datos en la actividad Extraer datos del documento determina los tipos de salida de Datos del documento:

1. Cuando Generar datos es True, Datos del documento sale como IDocumentData<ExtractorType>.
2. Cuando Generar datos es False, Datos del documento sale como IDocumentData<DictionaryData>.

El tipo IDocumentData<DictionaryData> te permite recuperar y modificar valores de campo utilizando ciertos métodos. También puedes cambiar el tipo de documento en la Estación de validación.

Las siguientes secciones muestran los métodos disponibles para DocumentData.Data.

Nota: el parámetro fieldIdOrName se trata tanto como el identificador como el nombre del campo.

GetFields()

Devuelve toda la información de los campos dentro de un tipo de documento, excepto los campos de tabla.

Sintaxis

GetFields()

ValorDeRetorno

ResultsDataPoint[]

Una matriz de todos los campos y sus valores extraídos asociados.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método:

ResultsDataPoint[] allFields = DocumentData.Data.GetFields()

GetField(string)

Devuelve toda la información de campo, en función de un ID o nombre de campo determinado.

Sintaxis

GetField(string fieldIdOrName)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

ValorDeRetorno

ResultsDataPoint

El campo y sus valores extraídos asociados.

Ejemplo

Comprueba el siguiente ejemplo para utilizar el método, cuando el ID o nombre de campo deseado es vendor:

ResultsDataPoint vendorData = DocumentData.Data.GetField("vendor");

GetFieldValue(string)

Devuelve el primer valor de campo, en función de un ID o nombre de campo dado.

Sintaxis

GetFieldValue(string fieldIdOrName)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

ValorDeRetorno

ResultsValue

El valor informado para un campo en un resultado de extracción.

Excepciones

Si no se encuentra fieldIdOrName, se lanza la siguiente excepción: Field {FieldIDOrName} no encontrado.

Ejemplo

Comprueba el siguiente ejemplo para utilizar el método, cuando el ID o nombre del campo es vendor:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor");
    // stores the value of the fieldValue object in a string variable   
    string value = fieldValue.Value;
    // stores the confidence of the fieldValue object in a float variable
    float confidence = fieldValue.Confidence;

GetFieldValue(string, int)

Devuelve un valor de campo, en función de un ID o nombre de campo determinado, así como el campo index, para devolver un valor específico de la matriz de valores.

Este método se aplica a campos simples.

Sintaxis

GetFieldValue(string fieldIdOrName, int index)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

Índice Int

El índice de un valor específico.

ValorDeRetorno

ResultsValue

El valor informado para un campo en un resultado de extracción.

Excepciones

• Si no se encuentra fieldIdOrName, se lanza la siguiente excepción: Field {fieldIdOrName} no encontrado.
• Si no se encuentra index, se lanza la siguiente excepción: Index is out of range.

Ejemplo

Comprueba el siguiente ejemplo para utilizar el método, donde ID de campo es vendor, y el índice para el valor deseado es 2:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor", 2);
    // store the retrieved value in a string variable
    string value = fieldValue.Value;
    // retrieve and store the confidence level of the field value
    float confidence = fieldValue.Confidence

GetFieldValues(string)

Devuelve todos los valores de un campo de un tipo de documento, en función de un ID o nombre de campo determinado.

Este método se aplica no solo a los campos de varios valores, sino también a los campos para los que el modelo de extracción proporciona valores alternativos. Esto significa que un campo puede tener más de un valor para alternativas, incluso si no es inherentemente un campo de varios valores.

Sintaxis

GetFieldValues(string fieldIdOrName)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

ValorDeRetorno

ResultsValue[]

Una matriz de valores informados para un campo en un resultado de extracción.

Excepciones

Si no se encuentra fieldIdOrName, se lanza la siguiente excepción: Field {fieldIdOrName} no encontrado.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método, donde el ID de campo es vendor:

ResultsValue[] fieldValues = DocumentData.Data.GetFieldValues("vendor");

GetTables()

Devuelve toda la información de campo de todas las tablas dentro de un tipo de documento.

Sintaxis

GetTables()

ValorDeRetorno

ResultsTable[]

El campo de tabla extraído como matriz, que contiene uno o varios ResultsTableValues (para admitir tablas individuales y multivalor, respectivamente). Cada valor tiene una matriz de ResultsTableCells. Cada celda tiene una matriz de ResultsValue que es el objeto de valor estándar utilizado para campos simples.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método:

ResultsTable[] tableValues = DocumentData.Data.GetTables();

GetTable(string)

Devuelve toda la información de campo de una tabla dentro de un tipo de documento, en función de un ID determinado.

Sintaxis

GetTable(string tableID)

Parámetros

tableID Cadena

El ID de la tabla que deseas recuperar. Puedes encontrar el ID de tabla navegando a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para el documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo de tabla relevante.

ValorDeRetorno

ResultsTable

El campo de tabla extraído, que contiene uno o varios ResultsTableValues (para admitir tablas individuales y multivalor, respectivamente). Cada valor tiene una matriz de ResultsTableCells. Cada celda tiene una matriz de ResultsValue que es el objeto de valor estándar utilizado para campos simples.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método, donde el ID de tabla es prices:

var tableValues = DocumentData.Data.GetTable("prices");

SetFieldValue(string, ResultsValue)

Sobrescribe una matriz completa de valores identificados por ID de campo, con el valor especificado.

Sintaxis

SetFieldValue(string fieldID, ResultsValue value)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

valor ResultsValue

El valor que deseas establecer para un campo.

Excepciones

Si no se encuentra fieldID, se lanza la siguiente excepción: Field {FieldIDOrName} no encontrado.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método, donde primero creamos el valor de campo utilizando el método ResultsValue.CreateWithNoReference auxiliar. El método auxiliar toma los siguientes parámetros:

• El primer parámetro representa el valor.
• El segundo parámetro representa la confianza.
• El tercer parámetro representa la confianza de OCR.

Después de crear el objeto de valor de campo taxValue, reemplazamos los valores preexistentes potenciales del campo tax (si existe) por una nueva matriz que contiene solo el objeto taxValue. En esta instancia, el campo tax asumirá el nuevo valor 10, ya que utilizamos SetFieldValue.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", taxValue);

SetFieldValue(string, ResultsValue, int)

Establece un valor de campo, en función de un ID o nombre de campo determinado, y en función de un índice de campo.

Este método se aplica a campos simples.

Sintaxis

SetFieldValue(string fieldID, ResultsValue value, int index)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

valor ResultsValue

El valor que deseas establecer para un campo.

Índice Int

El índice de un valor específico.

Excepciones

• Si no se encuentra fieldID, se lanza la siguiente excepción: Field {FieldIDOrName} no encontrado.
• Si no se encuentra index, se lanza la siguiente excepción: Index is out of range.

Ejemplo

Consulta el siguiente ejemplo para utilizar el método, donde primero creamos el valor de campo utilizando el método ResultsValue.CreateWithNoReference auxiliar. El método auxiliar toma los siguientes parámetros:

• El primer parámetro representa la matriz de valores.
• El segundo parámetro representa la confianza.
• El tercer parámetro representa la confianza de OCR.

Después de crear el objeto de valor de campo taxValue, procedemos a reemplazar el valor en el índice 1 de la matriz de campo tax con este nuevo objeto taxValue. Aquí, el método SetFieldValue se utiliza para reemplazar el valor en el índice 1.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", new [] {taxValue}, 1);

SetFieldValues(string, ResultsValue[])

Reemplaza la matriz completa de valores por otra matriz de valores especificada, para un ID o nombre de campo determinado.

Sintaxis

SetFieldValues(string fieldID, ResultsValue[] values)

Parámetros

fieldIdOrName Cadena

El ID o nombre del campo que deseas recuperar o establecer. El método busca primero una coincidencia utilizando el ID. Si no se encuentra la coincidencia, busca utilizando el mismo valor que el nombre del campo.

Puedes descubrir el ID y el nombre del campo de las siguientes maneras:

• Navega a la sección Crear de tu proyecto. Selecciona Gestor de tipos de documentos para un documento de muestra. Continúa a Campos y luego selecciona Configuración avanzada para el campo relevante.
  
  

  

  
  
• Abre la Estación de validación y en Tipo de documento, busca nombres de campo existentes.
• Si utilizas las API de Document Understanding, puedes utilizar las API dentro del servicio de detección para recuperar los nombres de campo e ID. Consulta Utilizar las API de detección para comprobar las llamadas a la API disponibles.

Valores ResultsValue[]

La matriz de valores que deseas establecer para un campo.

Excepciones

Si no se encuentra fieldID, se lanza la siguiente excepción: Field {FieldIDOrName} no encontrado.

Ejemplo

Consulta el siguiente ejemplo para utilizar este método, donde primero creamos dos objetos de valor de campo utilizando el método ResultsValue.CreateWithNoReference auxiliar : total1 y total2. El método auxiliar acepta tres parámetros:

1. El primer parámetro representa el valor real.
2. El segundo parámetro representa el valor de confianza.
3. El tercer parámetro representa el valor de confianza de OCR.

Después de crear estos valores de campo, reemplazamos los valores de un campo llamado Total Amount por una matriz que incluye total1 y total2.

var total1 = ResultsValue.CreateWithNoReference("100", 1, 1);
    var total2 = ResultsValue.CreateWithNoReference("200", 1, 1);
    documentData.Data.SetFieldValues("Total Amount", new []{total1, total2});