Métodos

Use métodos de saída de Dados de Documento para acessar valores de campo extraídos dependendo da configuração Gerar Tipo de Dados da atividade Extract Document Data.

A configuração Gerar tipo de dados na atividade Extract Document Data determina os tipos de saída de Document Data:

1. Quando Gerar dados é True, produz dados de documentos como IDocumentData<ExtractorType>.
2. Quando Gerar dados é False, produz dados de documentos como IDocumentData<DictionaryData>.

O tipo IDocumentData<DictionaryData> permite que você recupere e modifique valores de campos usando certos métodos. Você também pode alterar o tipo de documento na Estação de Validação.

You can work with this output in two ways:

• The lower-level Get/Set methods documented on this page, which return raw extraction objects such as ResultsDataPoint and ResultsValue.
• The strongly-typed Handler property, which exposes an ExtractionResultHandler navigator for a fluent, typed way to read and edit fields, tables, and field groups.

The following sections show the available members for DocumentData.Data.

Observação:

O parâmetro fieldIdOrName é tratado como o identificador e o nome do campo.

Handler

Returns an ExtractionResultHandler — the strongly-typed V1 navigator over the extraction result. It provides a fluent, typed alternative to the Get/Set methods for reading and editing fields, tables, and field groups.

Sintaxe

Handler

RetornarValor

ExtractionResultHandler

The navigator over the document's extraction result.

Exemplo

The following example shows how to use the property:

var handler = DocumentData.Data.Handler;
// Read a basic field value through the navigator.
string invoiceDate = handler.GetSimpleField("InvoiceDate")?.Value?.Value;

GetFields()

Retorna todas as informações de campos dentro de um tipo de documento, exceto campos de tabelas.

Sintaxe

GetFields()

RetornarValor

ResultsDataPoint[]

Uma matriz de todos os campos e seus valores extraídos associados.

Exemplo

The following example shows how to use the method:

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

GetField(string)

Retorna todas as informações de campos, com base em um determinado ID ou nome de campo.

Sintaxe

GetField(string fieldIdOrName)

Parâmetros

• fieldIdOrName String: o ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

RetornarValor

ResultsDataPoint

O campo e seus valores extraídos associados.

Exemplo

The following example shows how to use the method, when the desired field ID or name is vendor:

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

GetFieldValue(string)

Retorna o primeiro valor de campo, com base em um determinado ID ou nome de campo.

Sintaxe

GetFieldValue(string fieldIdOrName)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

RetornarValor

ResultsValue

O valor relatado para um campo em um resultado de extração.

Exceções

Se o fieldIdOrName não for localizado, a seguinte exceção será gerada: Field {FieldIDOrName} não localizado.

Exemplo

The following example shows how to use the method, when the field ID or name is 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)

Retorna um valor de campo, com base em um determinado ID ou nome de campo, bem como o campo index, para retornar um valor específico da matriz de valores.

Esse método se aplica a campos simples.

Sintaxe

GetFieldValue(string fieldIdOrName, int index)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

• index Int : o índice de um valor específico.

RetornarValor

ResultsValue

O valor relatado para um campo em um resultado de extração.

Exceções

• Se o fieldIdOrName não for localizado, a seguinte exceção será gerada: Field {fieldIdOrName} não localizado.
• Se o index não for encontrado, a seguinte exceção será gerada: Index is out of range.

Exemplo

The following example shows how to use the method, where field ID is vendor, and the index for the desired value is 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)

Retorna todos os valores de um campo de um tipo de documento, com base em um determinado ID ou nome de campo.

Esse método se aplica não apenas aos campos de vários valores, mas também aos campos para os quais o modelo de extração fornece valores alternativos. Isso significa que um campo pode ter mais de um valor para alternativos, mesmo que não seja inerentemente um campo de vários valores.

Sintaxe

GetFieldValues(string fieldIdOrName)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

RetornarValor

ResultsValue[]

Uma matriz de valores relatados para um campo em um resultado de extração.

Exceções

Se o fieldIdOrName não for localizado, a seguinte exceção será gerada: Field {fieldIdOrName} não localizado.

Exemplo

The following example shows how to use the method, where field ID is vendor:

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

GetTables()

Retorna informações de todos os campos de todas as tabelas dentro de um tipo de documento.

Sintaxe

GetTables()

RetornarValor

ResultsTable[]

O campo de tabela extraído como uma matriz, contendo um ou vários ResultsTableValues (para ser compatível com tabelas de valores únicos e múltiplos, respectivamente). Cada valor tem uma matriz de ResultsTableCells. Cada célula tem uma matriz de ResultsValue, que é o objeto de valor padrão usado para campos simples.

Exemplo

The following example shows how to use the method:

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

GetTable(string)

Retorna informações de todos os campos de uma tabela dentro de um tipo de documento, com base em um determinado ID.

Sintaxe

GetTable(string tableID)

Parâmetros

• tableID String : o ID da tabela que você deseja recuperar. Você pode encontrar o ID da tabela navegando até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo de tabela relevante.

RetornarValor

ResultsTable

O campo de tabela extraído, contendo um ou vários ResultsTableValues (para ser compatível com tabelas de valores únicos e múltiplos, respectivamente). Cada valor tem uma matriz de ResultsTableCells. Cada célula tem uma matriz de ResultsValue, que é o objeto de valor padrão usado para campos simples.

Exemplo

The following example shows how to use the method, where table ID is prices:

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

SetFieldValue(string, ResultsValue)

Substitui uma matriz inteira de valores identificados pelo ID do campo, com o valor especificado.

Sintaxe

SetFieldValue(string fieldID, ResultsValue value)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

• value ResultsValue : o valor que você deseja definir para um campo.

Exceções

Se o fieldID não for localizado, a seguinte exceção será gerada: Field {FieldIDOrName} não localizado.

Exemplo

The following example shows how to use the method, where we first create the field value using the ResultsValue.CreateWithNoReference helper method. The helper method takes the following parameters:

• O primeiro parâmetro representa o valor.
• O segundo parâmetro representa a confiança.
• O terceiro parâmetro representa a confiança do OCR.

Depois de criar o objeto de valor do campo taxValue, substituímos os possíveis valores pré-existentes do campo tax (se houver) por uma nova matriz que contém apenas o objeto taxValue. Nessa instância, o campo tax atribuirá o novo valor 10 à medida que usamos SetFieldValue.

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

SetFieldValue(string, ResultsValue, int)

Define um valor de campo, com base em um determinado ID ou nome de campo e com base em um índice de campo.

Esse método se aplica a campos simples.

Sintaxe

SetFieldValue(string fieldID, ResultsValue value, int index)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

• value ResultsValue : o valor que você deseja definir para um campo.

• index Int : o índice de um valor específico.

Exceções

• Se o fieldID não for localizado, a seguinte exceção será gerada: Field {FieldIDOrName} não localizado.
• Se o index não for encontrado, a seguinte exceção será gerada: Index is out of range.

Exemplo

The following example shows how to use the method, where we first create the field value using the ResultsValue.CreateWithNoReference helper method. The helper method takes the following parameters:

• O primeiro parâmetro representa a matriz de valores.
• O segundo parâmetro representa a confiança.
• O terceiro parâmetro representa a confiança do OCR.

Depois de criar o objeto de valor do campo taxValue, prosseguimos para substituir o valor no índice 1 da matriz de campos tax por esse novo objeto taxValue. Aqui, o método SetFieldValue é usado para substituir o valor no índice 1.

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

SetFieldValues(string, ResultsValue[])

Substitui toda a matriz de valores por outra matriz de valores especificada, para um determinado ID ou nome de campo.

Sintaxe

SetFieldValues(string fieldID, ResultsValue[] values)

Parâmetros

• fieldIdOrName String O ID ou nome do campo que você deseja recuperar ou definir. O método primeiro pesquisa uma correspondência usando o ID. Se não for encontrada correspondência, ele pesquisa usando o mesmo valor que o nome do campo.

  Você pode descobrir o ID e o nome do campo das seguintes maneiras:

  • Navegue até a seção Criar do seu projeto. Selecione Gerenciador de tipo de documento para um documento de amostra. Prossiga para Campos e, em seguida, selecione Configurações avançadas para o campo relevante.

  

  • Abra a Estação de Validação e, em Tipo de documento, pesquise nomes de campos existentes.
  • Se você estiver usando APIs do Document Understanding, você pode usar as APIs dentro do serviço Discovery para recuperar os nomes e IDs de campos. Acesse Usar as APIs de descoberta para verificar as chamadas de APIs disponíveis.

• values ResultsValue[]: a matriz de valores que você deseja definir para um campo.

Exceções

Se o fieldID não for localizado, a seguinte exceção será gerada: Field {FieldIDOrName} não localizado.

Exemplo

The following example shows how to use this method, where we first create two field value objects using the ResultsValue.CreateWithNoReference helper method : total1 and total2. The helper method accepts three parameters:

1. O primeiro parâmetro representa o valor real.
2. O segundo parâmetro representa o valor de confiança.
3. O terceiro parâmetro representa o valor de confiança do OCR.

Depois de criar esses valores de campos, substituímos os valores de um campo nomeado Total Amount por uma matriz que inclui total1 e total2.

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