Usar modelos de Document Intelligence

Este conteúdo aplica-se a:v4.0 (pré-visualização) | Versões anteriores:v3.1 (GA)v3.0 (GA)v2.1 (GA)

Neste guia, saiba como adicionar modelos de Document Intelligence aos seus aplicativos e fluxos de trabalho. Use um SDK de linguagem de programação de sua escolha ou a API REST.

O Azure AI Document Intelligence é um serviço de IA do Azure baseado na nuvem que utiliza aprendizagem automática para extrair texto-chave e elementos de estrutura de documentos. Recomendamos que você use o serviço gratuito enquanto aprende a tecnologia. Lembre-se que o número de páginas gratuitas é limitado a 500 por mês.

Escolha entre os seguintes modelos de Document Intelligence e analise e extraia dados e valores de formulários e documentos:

• O modelo de leitura pré-construído está no centro de todos os modelos de Document Intelligence e pode detetar linhas, palavras, locais e idiomas. Layout, documento geral, modelos pré-construídos e personalizados usam o read modelo como base para extrair textos de documentos.

• O modelo de layout pré-construído extrai texto e locais de texto, tabelas, marcas de seleção e informações de estrutura de documentos e imagens. Você pode extrair pares chave/valor usando o modelo de layout com o parâmetro features=keyValuePairs opcional de cadeia de caracteres de consulta habilitado.

• O modelo de contrato pré-construído extrai informações importantes de acordos contratuais.

• O modelo prebuilt-healthInsuranceCard.us extrai informações importantes dos cartões de seguro de saúde dos EUA.

• O modelo de modelos de documentos fiscais pré-construídos extrai informações relatadas em formulários de impostos dos EUA.

• O modelo de fatura pré-construída extrai campos-chave e itens de linha de faturas de vendas em vários formatos e qualidade. Os campos incluem imagens capturadas por telefone, documentos digitalizados e PDFs digitais.

• O modelo de recibo pré-construído extrai informações importantes de recibos de venda impressos e manuscritos.

• O modelo prebuilt-idDocument extrai informações importantes de carteiras de motorista dos EUA, páginas biográficas de passaportes internacionais, IDs estaduais dos EUA, cartões de segurança social e cartões de residente permanente.

Pré-requisitos

• Uma assinatura do Azure - Crie uma gratuitamente.

• O IDE do Visual Studio.

• Um recurso de serviços de IA do Azure ou Document Intelligence. Crie um serviço único ou multisserviço. Você pode usar o nível de preço gratuito (F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

• A chave e o ponto de extremidade do recurso que você cria para conectar seu aplicativo ao serviço de Inteligência de Documentos do Azure.

  1. Depois que o recurso for implantado, selecione Ir para o recurso.
  2. No menu de navegação esquerdo, selecione Teclas e Ponto de extremidade.
  3. Copie uma das chaves e o Endpoint para uso mais adiante neste artigo.

  

• Um arquivo de documento em um local de URL. Para este projeto, você pode usar os formulários de exemplo fornecidos na tabela a seguir para cada recurso:

  Caraterística	ID do modelo	documento-url
  Ler modelo	leitura pré-embutida	Exemplo de brochura
  Modelo de layout	layout pré-construído	Confirmação da reserva da amostra
  Modelo de formulário W-2	pré-construído-tax.us.w2	Exemplo de formulário W-2
  Modelo de fatura	fatura pré-embutida	Fatura de exemplo
  Modelo de recibo	recibo pré-embutido	Recibo de amostra
  Modelo de documento de identificação	prebuilt-idDocument	Exemplo de documento de identificação
  Modelo de cartão de visita	cartão de visita pré-construído	Exemplo de cartão de visita

Definir as variáveis de ambiente

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentAnalysisClient classe. Para fazer isso, instancie o cliente com o seu key e endpoint do portal do Azure. Para este projeto, use variáveis de ambiente para armazenar e acessar credenciais.

Importante

Não inclua a sua chave diretamente no código e nunca a publique publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações, consulte Segurança dos serviços de IA do Azure.

Para definir a variável de ambiente para a chave de recurso do Document Intelligence, abra uma janela do console e siga as instruções para o sistema operacional e o ambiente de desenvolvimento. Substitua <yourKey> e <yourEndpoint> pelos valores do seu recurso no portal do Azure.

Windows

As variáveis de ambiente no Windows não diferenciam maiúsculas de minúsculas. Eles são normalmente declarados em maiúsculas, com palavras unidas por um sublinhado. Em um prompt de comando, execute os seguintes comandos:

1. Defina a sua variável chave:

   setx DI_KEY <yourKey>
   

2. Definir sua variável de ponto de extremidade

   setx DI_ENDPOINT <yourEndpoint>
   

3. Feche a janela do prompt de comando depois de definir as variáveis de ambiente. Os valores permanecem até que você os altere novamente.

4. Reinicie todos os programas em execução que lerem a variável de ambiente. Por exemplo, se você estiver usando o Visual Studio ou Visual Studio Code como seu editor, reinicie antes de executar o código de exemplo.

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
setx VARIABLE_NAME=	Exclua a variável de ambiente definindo o valor como uma cadeia de caracteres vazia.	setx DI_KEY=
setx VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica.	set DI_KEY
set	Exiba todas as variáveis de ambiente.	set

macOS

As variáveis de ambiente no macOS diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal. Abra o terminal e digite os seguintes comandos:

1. Defina a sua variável chave:

   export key=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export endpoint=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bash_profile :

1. Use um editor de texto para abrir o arquivo ~/.bash_profile e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemplo: export DI_KEY="<yourKey>"

2. Salve as alterações no arquivo bash_profile .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bash-profile
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Linux

As variáveis de ambiente no Linux diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal:

1. Defina a sua variável chave:

   export DI_KEY=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export DI_ENDPOINT=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bashrc :

1. Use um editor de texto para abrir o arquivo ~/.bashrc e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export <VARIABLE>=<value>
   

   Exemplo: export DI_KEY=<yourKey>

2. Salve suas alterações no arquivo .bashrc .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bashrc
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY=
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Configurar o seu ambiente de programação

1. Inicie o Visual Studio.

2. Na página inicial, escolha Criar um novo projeto.

   

3. Na página Criar um novo projeto, insira console na caixa de pesquisa. Selecione o modelo Aplicativo de Console e escolha Avançar.

   

4. Na página Configurar seu novo projeto, em Nome do projeto, digite docIntelligence_app. Em seguida, selecione Seguinte.

   

5. Na página Informações adicionais, selecione .NET 8.0 (Suporte de longo prazo) e, em seguida, selecione Criar.

   

Instalar a biblioteca de cliente com o NuGet

1. Clique com o botão direito do mouse em seu projeto docIntelligence_app e selecione Gerenciar pacotes NuGet... .

   

2. Selecione a guia Procurar e digite Azure.AI.FormRecognizer.

   

3. Selecione uma versão no menu suspenso e instale o pacote em seu projeto.

Compilar a aplicação

Nota

A partir do .NET 6, novos projetos usando o console modelo geram um novo estilo de programa que difere das versões anteriores. A nova saída usa recursos recentes do C# que simplificam o código que você precisa escrever.

Quando você usa a versão mais recente, você só precisa escrever o Main corpo do método. Não é necessário incluir instruções de nível superior, diretivas de uso global ou diretivas de uso implícito. Para obter mais informações, consulte O modelo de aplicativo de console C# gera instruções de nível superior.

1. Abra o arquivo Program.cs .

2. Exclua o código pré-existente, incluindo a linha Console.Writeline("Hello World!").

3. Selecione um dos seguintes exemplos de código e copie/cole no arquivo Program.cs do seu aplicativo:

   • leitura pré-embutida
   • layout pré-construído
   • pré-construído-tax.us.w2
   • fatura pré-embutida
   • recibo pré-embutido
   • prebuilt-idDocument

4. Depois de adicionar um exemplo de código ao seu aplicativo, escolha o botão verde Iniciar ao lado do nome do projeto para criar e executar o programa ou pressione F5.

   

Usar o modelo de leitura

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

//sample document
Uri fileUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-read", fileUri);
AnalyzeResult result = operation.Value;

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("Detected languages:");

foreach (DocumentLanguage language in result.Languages)
{
    Console.WriteLine($"  Found language with locale'{language.Locale}' with confidence {language.Confidence}.");
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do read modelo.

Usar o modelo de layout

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri fileUri = new Uri ("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-layout", fileUri);

AnalyzeResult result = operation.Value;

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }

    for (int i = 0; i < page.SelectionMarks.Count; i++)
    {
        DocumentSelectionMark selectionMark = page.SelectionMarks[i];

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < selectionMark.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {selectionMark.BoundingPolygon[j].X}, Y: {selectionMark.BoundingPolygon[j].Y}");
        }
    }
}

Console.WriteLine("Paragraphs:");

foreach (DocumentParagraph paragraph in result.Paragraphs)
{
    Console.WriteLine($"  Paragraph content: {paragraph.Content}");

    if (paragraph.Role != null)
    {
        Console.WriteLine($"    Role: {paragraph.Role}");
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("The following tables were extracted:");

for (int i = 0; i < result.Tables.Count; i++)
{
    DocumentTable table = result.Tables[i];
    Console.WriteLine($"  Table {i} has {table.RowCount} rows and {table.ColumnCount} columns.");

    foreach (DocumentTableCell cell in table.Cells)
    {
        Console.WriteLine($"    Cell ({cell.RowIndex}, {cell.ColumnIndex}) has kind '{cell.Kind}' and content: '{cell.Content}'.");
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de layout.

Utilizar o modelo de documento Geral

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri fileUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-document", fileUri);

AnalyzeResult result = operation.Value;

Console.WriteLine("Detected key-value pairs:");

foreach (DocumentKeyValuePair kvp in result.KeyValuePairs)
{
    if (kvp.Value == null)
    {
        Console.WriteLine($"  Found key with no value: '{kvp.Key.Content}'");
    }
    else
    {
        Console.WriteLine($"  Found key-value pair: '{kvp.Key.Content}' and '{kvp.Value.Content}'");
    }
}

foreach (DocumentPage page in result.Pages)
{
    Console.WriteLine($"Document Page {page.PageNumber} has {page.Lines.Count} line(s), {page.Words.Count} word(s),");
    Console.WriteLine($"and {page.SelectionMarks.Count} selection mark(s).");

    for (int i = 0; i < page.Lines.Count; i++)
    {
        DocumentLine line = page.Lines[i];
        Console.WriteLine($"  Line {i} has content: '{line.Content}'.");

        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < line.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {line.BoundingPolygon[j].X}, Y: {line.BoundingPolygon[j].Y}");
        }
    }

    for (int i = 0; i < page.SelectionMarks.Count; i++)
    {
        DocumentSelectionMark selectionMark = page.SelectionMarks[i];

        Console.WriteLine($"  Selection Mark {i} is {selectionMark.State}.");
        Console.WriteLine($"    Its bounding polygon (points ordered clockwise):");

        for (int j = 0; j < selectionMark.BoundingPolygon.Count; j++)
        {
            Console.WriteLine($"      Point {j} => X: {selectionMark.BoundingPolygon[j].X}, Y: {selectionMark.BoundingPolygon[j].Y}");
        }
    }
}

foreach (DocumentStyle style in result.Styles)
{
    // Check the style and style confidence to see if text is handwritten.
    // Note that value '0.8' is used as an example.

    bool isHandwritten = style.IsHandwritten.HasValue && style.IsHandwritten == true;

    if (isHandwritten && style.Confidence > 0.8)
    {
        Console.WriteLine($"Handwritten content found:");

        foreach (DocumentSpan span in style.Spans)
        {
            Console.WriteLine($"  Content: {result.Content.Substring(span.Index, span.Length)}");
        }
    }
}

Console.WriteLine("The following tables were extracted:");

for (int i = 0; i < result.Tables.Count; i++)
{
    DocumentTable table = result.Tables[i];
    Console.WriteLine($"  Table {i} has {table.RowCount} rows and {table.ColumnCount} columns.");

    foreach (DocumentTableCell cell in table.Cells)
    {
        Console.WriteLine($"    Cell ({cell.RowIndex}, {cell.ColumnIndex}) has kind '{cell.Kind}' and content: '{cell.Content}'.");
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída geral do modelo de documento.

Usar o modelo de imposto W-2

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri w2Uri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-tax.us.w2", w2Uri);

AnalyzeResult result = operation.Value;

for (int i = 0; i < result.Documents.Count; i++)
{
    Console.WriteLine($"Document {i}:");

    AnalyzedDocument document = result.Documents[i];

    if (document.Fields.TryGetValue("AdditionalInfo", out DocumentField? additionalInfoField))
    {
        if (additionalInfoField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField infoField in additionalInfoField.Value.AsList())
            {
                Console.WriteLine("AdditionalInfo:");

                if (infoField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> infoFields = infoField.Value.AsDictionary();

                    if (infoFields.TryGetValue("Amount", out DocumentField? amountField))
                    {
                        if (amountField.FieldType == DocumentFieldType.Double)
                        {
                            double amount = amountField.Value.AsDouble();

                            Console.WriteLine($"  Amount: '{amount}', with confidence {amountField.Confidence}");
                        }
                    }

                    if (infoFields.TryGetValue("LetterCode", out DocumentField? letterCodeField))
                    {
                        if (letterCodeField.FieldType == DocumentFieldType.String)
                        {
                            string letterCode = letterCodeField.Value.AsString();

                            Console.WriteLine($"  LetterCode: '{letterCode}', with confidence {letterCodeField.Confidence}");
                        }
                    }
                }
            }
        }
    }


    if (document.Fields.TryGetValue("AllocatedTips", out DocumentField? allocatedTipsField))
    {
        if (allocatedTipsField.FieldType == DocumentFieldType.Double)
        {
            double allocatedTips = allocatedTipsField.Value.AsDouble();
            Console.WriteLine($"Allocated Tips: '{allocatedTips}', with confidence {allocatedTipsField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("Employer", out DocumentField? employerField))
    {
        if (employerField.FieldType == DocumentFieldType.Dictionary)
        {
            IReadOnlyDictionary<string, DocumentField> employerFields = employerField.Value.AsDictionary();

            if (employerFields.TryGetValue("Name", out DocumentField? employerNameField))
            {
                if (employerNameField.FieldType == DocumentFieldType.String)
                {
                    string name = employerNameField.Value.AsString();

                    Console.WriteLine($"Employer Name: '{name}', with confidence {employerNameField.Confidence}");
                }
            }

            if (employerFields.TryGetValue("IdNumber", out DocumentField? idNumberField))
            {
                if (idNumberField.FieldType == DocumentFieldType.String)
                {
                    string id = idNumberField.Value.AsString();

                    Console.WriteLine($"Employer ID Number: '{id}', with confidence {idNumberField.Confidence}");
                }
            }

            if (employerFields.TryGetValue("Address", out DocumentField? addressField))
            {
                if (addressField.FieldType == DocumentFieldType.Address)
                {
                    Console.WriteLine($"Employer Address: '{addressField.Content}', with confidence {addressField.Confidence}");
                }
            }
        }
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de imposto W-2.

Usar o modelo de fatura

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri invoiceUri = new Uri("https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-invoice", invoiceUri);

AnalyzeResult result = operation.Value;

for (int i = 0; i < result.Documents.Count; i++)
{
    Console.WriteLine($"Document {i}:");

    AnalyzedDocument document = result.Documents[i];

    if (document.Fields.TryGetValue("VendorName", out DocumentField vendorNameField))
    {
        if (vendorNameField.FieldType == DocumentFieldType.String)
        {
            string vendorName = vendorNameField.Value.AsString();
            Console.WriteLine($"Vendor Name: '{vendorName}', with confidence {vendorNameField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("CustomerName", out DocumentField customerNameField))
    {
        if (customerNameField.FieldType == DocumentFieldType.String)
        {
            string customerName = customerNameField.Value.AsString();
            Console.WriteLine($"Customer Name: '{customerName}', with confidence {customerNameField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("Items", out DocumentField itemsField))
    {
        if (itemsField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField itemField in itemsField.Value.AsList())
            {
                Console.WriteLine("Item:");

                if (itemField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> itemFields = itemField.Value.AsDictionary();

                    if (itemFields.TryGetValue("Description", out DocumentField itemDescriptionField))
                    {
                        if (itemDescriptionField.FieldType == DocumentFieldType.String)
                        {
                            string itemDescription = itemDescriptionField.Value.AsString();

                            Console.WriteLine($"  Description: '{itemDescription}', with confidence {itemDescriptionField.Confidence}");
                        }
                    }

                    if (itemFields.TryGetValue("Amount", out DocumentField itemAmountField))
                    {
                        if (itemAmountField.FieldType == DocumentFieldType.Currency)
                        {
                            CurrencyValue itemAmount = itemAmountField.Value.AsCurrency();

                            Console.WriteLine($"  Amount: '{itemAmount.Symbol}{itemAmount.Amount}', with confidence {itemAmountField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (document.Fields.TryGetValue("SubTotal", out DocumentField subTotalField))
    {
        if (subTotalField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue subTotal = subTotalField.Value.AsCurrency();
            Console.WriteLine($"Sub Total: '{subTotal.Symbol}{subTotal.Amount}', with confidence {subTotalField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("TotalTax", out DocumentField totalTaxField))
    {
        if (totalTaxField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue totalTax = totalTaxField.Value.AsCurrency();
            Console.WriteLine($"Total Tax: '{totalTax.Symbol}{totalTax.Amount}', with confidence {totalTaxField.Confidence}");
        }
    }

    if (document.Fields.TryGetValue("InvoiceTotal", out DocumentField invoiceTotalField))
    {
        if (invoiceTotalField.FieldType == DocumentFieldType.Currency)
        {
            CurrencyValue invoiceTotal = invoiceTotalField.Value.AsCurrency();
            Console.WriteLine($"Invoice Total: '{invoiceTotal.Symbol}{invoiceTotal.Amount}', with confidence {invoiceTotalField.Confidence}");
        }
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de fatura.

Usar o modelo de recibo

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri receiptUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-receipt", receiptUri);

AnalyzeResult receipts = operation.Value;

foreach (AnalyzedDocument receipt in receipts.Documents)
{
    if (receipt.Fields.TryGetValue("MerchantName", out DocumentField merchantNameField))
    {
        if (merchantNameField.FieldType == DocumentFieldType.String)
        {
            string merchantName = merchantNameField.Value.AsString();

            Console.WriteLine($"Merchant Name: '{merchantName}', with confidence {merchantNameField.Confidence}");
        }
    }

    if (receipt.Fields.TryGetValue("TransactionDate", out DocumentField transactionDateField))
    {
        if (transactionDateField.FieldType == DocumentFieldType.Date)
        {
            DateTimeOffset transactionDate = transactionDateField.Value.AsDate();

            Console.WriteLine($"Transaction Date: '{transactionDate}', with confidence {transactionDateField.Confidence}");
        }
    }

    if (receipt.Fields.TryGetValue("Items", out DocumentField itemsField))
    {
        if (itemsField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField itemField in itemsField.Value.AsList())
            {
                Console.WriteLine("Item:");

                if (itemField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> itemFields = itemField.Value.AsDictionary();

                    if (itemFields.TryGetValue("Description", out DocumentField itemDescriptionField))
                    {
                        if (itemDescriptionField.FieldType == DocumentFieldType.String)
                        {
                            string itemDescription = itemDescriptionField.Value.AsString();

                            Console.WriteLine($"  Description: '{itemDescription}', with confidence {itemDescriptionField.Confidence}");
                        }
                    }

                    if (itemFields.TryGetValue("TotalPrice", out DocumentField itemTotalPriceField))
                    {
                        if (itemTotalPriceField.FieldType == DocumentFieldType.Double)
                        {
                            double itemTotalPrice = itemTotalPriceField.Value.AsDouble();

                            Console.WriteLine($"  Total Price: '{itemTotalPrice}', with confidence {itemTotalPriceField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (receipt.Fields.TryGetValue("Total", out DocumentField totalField))
    {
        if (totalField.FieldType == DocumentFieldType.Double)
        {
            double total = totalField.Value.AsDouble();

            Console.WriteLine($"Total: '{total}', with confidence '{totalField.Confidence}'");
        }
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de recibo.

Modelo de documento de identificação

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document

Uri idDocumentUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-idDocument", idDocumentUri);

AnalyzeResult identityDocuments = operation.Value;

AnalyzedDocument identityDocument = identityDocuments.Documents.Single();

if (identityDocument.Fields.TryGetValue("Address", out DocumentField addressField))
{
    if (addressField.FieldType == DocumentFieldType.String)
    {
        string address = addressField.Value. AsString();
        Console.WriteLine($"Address: '{address}', with confidence {addressField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("CountryRegion", out DocumentField countryRegionField))
{
    if (countryRegionField.FieldType == DocumentFieldType.CountryRegion)
    {
        string countryRegion = countryRegionField.Value.AsCountryRegion();
        Console.WriteLine($"CountryRegion: '{countryRegion}', with confidence {countryRegionField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DateOfBirth", out DocumentField dateOfBirthField))
{
    if (dateOfBirthField.FieldType == DocumentFieldType.Date)
    {
        DateTimeOffset dateOfBirth = dateOfBirthField.Value.AsDate();
        Console.WriteLine($"Date Of Birth: '{dateOfBirth}', with confidence {dateOfBirthField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DateOfExpiration", out DocumentField dateOfExpirationField))
{
    if (dateOfExpirationField.FieldType == DocumentFieldType.Date)
    {
        DateTimeOffset dateOfExpiration = dateOfExpirationField.Value.AsDate();
        Console.WriteLine($"Date Of Expiration: '{dateOfExpiration}', with confidence {dateOfExpirationField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("DocumentNumber", out DocumentField documentNumberField))
{
    if (documentNumberField.FieldType == DocumentFieldType.String)
    {
        string documentNumber = documentNumberField.Value.AsString();
        Console.WriteLine($"Document Number: '{documentNumber}', with confidence {documentNumberField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("FirstName", out DocumentField firstNameField))
{
    if (firstNameField.FieldType == DocumentFieldType.String)
    {
        string firstName = firstNameField.Value.AsString();
        Console.WriteLine($"First Name: '{firstName}', with confidence {firstNameField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("LastName", out DocumentField lastNameField))
{
    if (lastNameField.FieldType == DocumentFieldType.String)
    {
        string lastName = lastNameField.Value.AsString();
        Console.WriteLine($"Last Name: '{lastName}', with confidence {lastNameField.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("Region", out DocumentField regionfield))
{
    if (regionfield.FieldType == DocumentFieldType.String)
    {
        string region = regionfield.Value.AsString();
        Console.WriteLine($"Region: '{region}', with confidence {regionfield.Confidence}");
    }
}

if (identityDocument.Fields.TryGetValue("Sex", out DocumentField sexfield))
{
    if (sexfield.FieldType == DocumentFieldType.String)
    {
        string sex = sexfield.Value.AsString();
        Console.WriteLine($"Sex: '{sex}', with confidence {sexfield.Confidence}");
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de documento id.

Use o modelo de cartão de visita

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

//use your `key` and `endpoint` environment variables to create your `AzureKeyCredential` and `DocumentAnalysisClient` instances
string key = Environment.GetEnvironmentVariable("DI_KEY");
string endpoint = Environment.GetEnvironmentVariable("DI_ENDPOINT");
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);

// sample document document
Uri businessCardUri = new Uri("https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/business-card-english.jpg");

AnalyzeDocumentOperation operation = await client.AnalyzeDocumentFromUriAsync(WaitUntil.Completed, "prebuilt-businessCard", businessCardUri);

AnalyzeResult businessCards = operation.Value;

foreach (AnalyzedDocument businessCard in businessCards.Documents)
{
    if (businessCard.Fields.TryGetValue("ContactNames", out DocumentField ContactNamesField))
    {
        if (ContactNamesField.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField contactNameField in ContactNamesField.Value.AsList())
            {
                Console.WriteLine("Contact Name: ");

                if (contactNameField.FieldType == DocumentFieldType.Dictionary)
                {
                    IReadOnlyDictionary<string, DocumentField> contactNameFields = contactNameField.Value.AsDictionary();

                    if (contactNameFields.TryGetValue("FirstName", out DocumentField firstNameField))
                    {
                        if (firstNameField.FieldType == DocumentFieldType.String)
                        {
                            string firstName = firstNameField.Value.AsString();

                            Console.WriteLine($"  First Name: '{firstName}', with confidence {firstNameField.Confidence}");
                        }
                    }

                    if (contactNameFields.TryGetValue("LastName", out DocumentField lastNameField))
                    {
                        if (lastNameField.FieldType == DocumentFieldType.String)
                        {
                            string lastName = lastNameField.Value.AsString();

                            Console.WriteLine($"  Last Name: '{lastName}', with confidence {lastNameField.Confidence}");
                        }
                    }
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("JobTitles", out DocumentField jobTitlesFields))
    {
        if (jobTitlesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField jobTitleField in jobTitlesFields.Value.AsList())
            {
                if (jobTitleField.FieldType == DocumentFieldType.String)
                {
                    string jobTitle = jobTitleField.Value.AsString();

                    Console.WriteLine($"Job Title: '{jobTitle}', with confidence {jobTitleField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Departments", out DocumentField departmentFields))
    {
        if (departmentFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField departmentField in departmentFields.Value.AsList())
            {
                if (departmentField.FieldType == DocumentFieldType.String)
                {
                    string department = departmentField.Value.AsString();

                    Console.WriteLine($"Department: '{department}', with confidence {departmentField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Emails", out DocumentField emailFields))
    {
        if (emailFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField emailField in emailFields.Value.AsList())
            {
                if (emailField.FieldType == DocumentFieldType.String)
                {
                    string email = emailField.Value.AsString();

                    Console.WriteLine($"Email: '{email}', with confidence {emailField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Websites", out DocumentField websiteFields))
    {
        if (websiteFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField websiteField in websiteFields.Value.AsList())
            {
                if (websiteField.FieldType == DocumentFieldType.String)
                {
                    string website = websiteField.Value.AsString();

                    Console.WriteLine($"Website: '{website}', with confidence {websiteField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("MobilePhones", out DocumentField mobilePhonesFields))
    {
        if (mobilePhonesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField mobilePhoneField in mobilePhonesFields.Value.AsList())
            {
                if (mobilePhoneField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string mobilePhone = mobilePhoneField.Value.AsPhoneNumber();

                    Console.WriteLine($"Mobile phone number: '{mobilePhone}', with confidence {mobilePhoneField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("WorkPhones", out DocumentField workPhonesFields))
    {
        if (workPhonesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField workPhoneField in workPhonesFields.Value.AsList())
            {
                if (workPhoneField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string workPhone = workPhoneField.Value.AsPhoneNumber();

                    Console.WriteLine($"Work phone number: '{workPhone}', with confidence {workPhoneField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Faxes", out DocumentField faxesFields))
    {
        if (faxesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField faxField in faxesFields.Value.AsList())
            {
                if (faxField.FieldType == DocumentFieldType.PhoneNumber)
                {
                    string fax = faxField.Value.AsPhoneNumber();

                    Console.WriteLine($"Fax phone number: '{fax}', with confidence {faxField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("Addresses", out DocumentField addressesFields))
    {
        if (addressesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField addressField in addressesFields.Value.AsList())
            {
                if (addressField.FieldType == DocumentFieldType.String)
                {
                    string address = addressField.Value.AsString();

                    Console.WriteLine($"Address: '{address}', with confidence {addressField.Confidence}");
                }
            }
        }
    }

    if (businessCard.Fields.TryGetValue("CompanyNames", out DocumentField companyNamesFields))
    {
        if (companyNamesFields.FieldType == DocumentFieldType.List)
        {
            foreach (DocumentField companyNameField in companyNamesFields.Value.AsList())
            {
                if (companyNameField.FieldType == DocumentFieldType.String)
                {
                    string companyName = companyNameField.Value.AsString();

                    Console.WriteLine($"Company name: '{companyName}', with confidence {companyNameField.Confidence}");
                }
            }
        }
    }
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de cartão de visita.

Referência | do SDK da biblioteca | cliente Pacote de referência | da API REST (Maven) | Exemplos |Versão suportada da API REST

Pré-requisitos

• Uma assinatura do Azure - Crie uma gratuitamente.

• A versão mais recente do Visual Studio Code ou seu IDE preferido. Consulte Java no Visual Studio Code.

  • O Visual Studio Code oferece um Pacote de Codificação para Java para Windows e macOS. O pacote de codificação é um pacote de VS código, o Java Development Kit (JDK) e uma coleção de extensões sugeridas pela Microsoft. O Coding Pack também pode ser usado para corrigir um ambiente de desenvolvimento existente.
  • Se você estiver usando VS Code e o Coding Pack For Java, instale a extensão Gradle for Java .

  Se você não estiver usando o Visual Studio Code, certifique-se de ter o seguinte instalado em seu ambiente de desenvolvimento:

  • Um Java Development Kit (JDK) versão 8 ou posterior. Para obter mais informações, consulte Microsoft Build of OpenJDK.
  • Gradle, versão 6.8 ou posterior.

• Um recurso de serviços de IA do Azure ou Document Intelligence. Crie um serviço único ou multisserviço. Você pode usar o nível de preço gratuito (F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

  Gorjeta

  Crie um recurso de serviços de IA do Azure se você planeja acessar vários serviços de IA do Azure usando um único ponto de extremidade e chave. Apenas para acesso ao Document Intelligence, crie um recurso Document Intelligence. Você precisa de um recurso de serviço único se pretende usar a autenticação do Microsoft Entra.

• A chave e o ponto de extremidade do recurso que você cria para conectar seu aplicativo ao serviço de Inteligência de Documentos do Azure.

  1. Depois que o recurso for implantado, selecione Ir para o recurso.
  2. No menu de navegação esquerdo, selecione Teclas e Ponto de extremidade.
  3. Copie uma das chaves e o Endpoint para uso mais adiante neste artigo.

  

• Um arquivo de documento em uma URL. Para este projeto, você pode usar os formulários de exemplo fornecidos na tabela a seguir para cada recurso:

  Caraterística	ID do modelo	documento-url
  Ler modelo	leitura pré-embutida	Exemplo de brochura
  Modelo de layout	layout pré-construído	Confirmação da reserva da amostra
  Modelo de formulário W-2	pré-construído-tax.us.w2	Exemplo de formulário W-2
  Modelo de fatura	fatura pré-embutida	Fatura de exemplo
  Modelo de recibo	recibo pré-embutido	Recibo de amostra
  Modelo de documento de identificação	prebuilt-idDocument	Exemplo de documento de identificação

Definir as variáveis de ambiente

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentAnalysisClient classe. Para fazer isso, instancie o cliente com o seu key e endpoint do portal do Azure. Para este projeto, use variáveis de ambiente para armazenar e acessar credenciais.

Importante

Não inclua a sua chave diretamente no código e nunca a publique publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações, consulte Segurança dos serviços de IA do Azure.

Para definir a variável de ambiente para a chave de recurso do Document Intelligence, abra uma janela do console e siga as instruções para o sistema operacional e o ambiente de desenvolvimento. Substitua <yourKey> e <yourEndpoint> pelos valores do seu recurso no portal do Azure.

Windows

As variáveis de ambiente no Windows não diferenciam maiúsculas de minúsculas. Eles são normalmente declarados em maiúsculas, com palavras unidas por um sublinhado. Em um prompt de comando, execute os seguintes comandos:

1. Defina a sua variável chave:

   setx DI_KEY <yourKey>
   

2. Definir sua variável de ponto de extremidade

   setx DI_ENDPOINT <yourEndpoint>
   

3. Feche a janela do prompt de comando depois de definir as variáveis de ambiente. Os valores permanecem até que você os altere novamente.

4. Reinicie todos os programas em execução que lerem a variável de ambiente. Por exemplo, se você estiver usando o Visual Studio ou Visual Studio Code como seu editor, reinicie antes de executar o código de exemplo.

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
setx VARIABLE_NAME=	Exclua a variável de ambiente definindo o valor como uma cadeia de caracteres vazia.	setx DI_KEY=
setx VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica.	set DI_KEY
set	Exiba todas as variáveis de ambiente.	set

macOS

As variáveis de ambiente no macOS diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal. Abra o terminal e digite os seguintes comandos:

1. Defina a sua variável chave:

   export key=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export endpoint=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bash_profile :

1. Use um editor de texto para abrir o arquivo ~/.bash_profile e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemplo: export DI_KEY="<yourKey>"

2. Salve as alterações no arquivo bash_profile .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bash-profile
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Linux

As variáveis de ambiente no Linux diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal:

1. Defina a sua variável chave:

   export DI_KEY=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export DI_ENDPOINT=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bashrc :

1. Use um editor de texto para abrir o arquivo ~/.bashrc e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export <VARIABLE>=<value>
   

   Exemplo: export DI_KEY=<yourKey>

2. Salve suas alterações no arquivo .bashrc .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bashrc
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY=
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Configurar o seu ambiente de programação

Para configurar seu ambiente de programação, crie um projeto Gradle e instale a biblioteca do cliente.

Criar um projeto Gradle

1. Em uma janela de console, crie um diretório para seu aplicativo chamado doc-intelligence-app e navegue até ele.

   mkdir doc-intelligence-app
   cd doc-intelligence-app
   

2. Execute o comando a gradle init partir do seu diretório de trabalho. Este comando cria arquivos de compilação essenciais para o Gradle, incluindo build.gradle.kts, que é usado em tempo de execução para criar e configurar seu aplicativo.

   gradle init --type basic
   

3. Quando solicitado a escolher uma DSL, selecione Kotlin.

4. Selecione Enter para aceitar o nome padrão do projeto, doc-intelligence-app.

Instalar a biblioteca de cliente

Este artigo usa o gerenciador de dependência Gradle. Você pode encontrar a biblioteca do cliente e informações para outros gerenciadores de dependência no Maven Central Repository.

1. Abra o arquivo build.gradle.kts do projeto no IDE. Copie e cole o código a seguir para incluir a biblioteca do cliente como uma implementation instrução, juntamente com os plug-ins e configurações necessários.

   plugins {
      java
      application
   }
   application {
      mainClass.set("DocIntelligence")
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      implementation group: 'com.azure', name: 'azure-ai-documentintelligence', version: '1.0.0-beta.2'
   
   }
   

Criar uma aplicação Java

Para interagir com o serviço de Inteligência de Documentos, crie uma instância da DocumentIntelligenceClient classe. Para fazer isso, crie um AzureKeyCredential com o seu key a partir do portal do Azure e uma DocumentIntelligenceClient instância com o AzureKeyCredential e seu Document Intelligence endpoint.

1. No diretório doc-intelligence-app , execute o seguinte comando:

   mkdir -p src/main/java
   

Esse comando cria a seguinte estrutura de diretórios:

1. Navegue até o java diretório e crie um arquivo chamado DocIntelligence.java.

   Gorjeta

   Você pode criar um novo arquivo usando o PowerShell. Abra uma janela do PowerShell no diretório do projeto mantendo pressionada a tecla Shift e clicando com o botão direito do mouse na pasta e, em seguida, digite o seguinte comando: New-Item DocIntelligence.java.

2. Abra o arquivo DocIntelligence.java e selecione um dos seguintes exemplos de código E copie/cole em seu aplicativo:

   • O modelo de leitura pré-construído está no centro de todos os modelos de Document Intelligence e pode detetar linhas, palavras, locais e idiomas. O layout, o documento geral, os modelos pré-construídos e personalizados usam o read modelo como base para extrair textos de documentos.
   • O modelo de layout pré-construído extrai texto e locais de texto, tabelas, marcas de seleção e informações de estrutura de documentos e imagens.
   • O modelo prebuilt-tax.us.w2 extrai informações relatadas nos formulários de impostos do Internal Revenue Service (IRS) dos EUA.
   • O modelo de fatura pré-incorporada extrai campos-chave e itens de linha de faturas de vendas em vários formatos.
   • O modelo de recibo pré-construído extrai informações importantes de recibos de venda impressos e manuscritos.
   • O modelo prebuilt-idDocument extrai informações importantes das Carteiras de Motorista dos EUA; páginas biográficas de passaportes internacionais; IDs estaduais dos EUA; cartões de segurança social; e cartões de residente permanente.

3. Digite os seguintes comandos:

   gradle build
   gradle run
   

Usar o modelo de leitura

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;


public class DocIntelligence {

  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String documentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png";

String modelId = "prebuilt-read";

SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
  client.beginAnalyzeDocument(modelId, invoiceUrl);;

AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult().getAnalyzeResult();

// pages
analyzeLayoutResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word '%s' has a confidence score of %.2f.%n",
      documentWord.getContent(),
      documentWord.getConfidence()));
});
}
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do read modelo.

Usar o modelo de layout

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String layoutDocumentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png";
String modelId = "prebuilt-layout";

SyncPoller < OperationResult, AnalyzeResult > analyzeLayoutResultPoller =
  client.beginAnalyzeDocument(modelId, layoutDocumentUrl);

AnalyzeResult analyzeLayoutResult = analyzeLayoutResultPoller.getFinalResult().getAnalyzeResult();

// pages
analyzeLayoutResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word '%s' has a confidence score of %.2f%n",
      documentWord.getContent(),
      documentWord.getConfidence()));

  // selection marks
  documentPage.getSelectionMarks().forEach(documentSelectionMark ->
    System.out.printf("Selection mark is '%s' and is within a bounding polygon %s with confidence %.2f.%n",
      documentSelectionMark.getSelectionMarkState().toString(),
      getBoundingCoordinates(documentSelectionMark.getBoundingPolygon()),
      documentSelectionMark.getConfidence()));
});

// tables
List < DocumentTable > tables = analyzeLayoutResult.getTables();
for (int i = 0; i < tables.size(); i++) {
  DocumentTable documentTables = tables.get(i);
  System.out.printf("Table %d has %d rows and %d columns.%n", i, documentTables.getRowCount(),
    documentTables.getColumnCount());
  documentTables.getCells().forEach(documentTableCell -> {
    System.out.printf("Cell '%s', has row index %d and column index %d.%n", documentTableCell.getContent(),
      documentTableCell.getRowIndex(), documentTableCell.getColumnIndex());
  });
  System.out.println();
}

}

// Utility function to get the bounding polygon coordinates.
private static String getBoundingCoordinates(List < Point > boundingPolygon) {
  return boundingPolygon.stream().map(point -> String.format("[%.2f, %.2f]", point.getX(),
    point.getY())).collect(Collectors.joining(", "));
}

}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de layout.

Utilizar o modelo de documento Geral

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String generalDocumentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf";
String modelId = "prebuilt-document";
SyncPoller < OperationResult, AnalyzeResult > analyzeDocumentPoller =
  client.beginAnalyzeDocument(modelId, generalDocumentUrl);

AnalyzeResult analyzeResult = analyzeDocumentPoller.getFinalResult().getAnalyzeResult();;

// pages
analyzeResult.getPages().forEach(documentPage -> {
  System.out.printf("Page has width: %.2f and height: %.2f, measured with unit: %s%n",
    documentPage.getWidth(),
    documentPage.getHeight(),
    documentPage.getUnit());

  // lines
  documentPage.getLines().forEach(documentLine ->
    System.out.printf("Line %s is within a bounding polygon %s.%n",
      documentLine.getContent(),
      documentLine.getBoundingPolygon().toString()));

  // words
  documentPage.getWords().forEach(documentWord ->
    System.out.printf("Word %s has a confidence score of %.2f%n.",
      documentWord.getContent(),
      documentWord.getConfidence()));
});

// tables
List < DocumentTable > tab_les = analyzeResult.getTables();
for (int i = 0; i < tab_les.size(); i++) {
  DocumentTable documentTable = tab_les.get(i);
  System.out.printf("Table %d has %d rows and %d columns.%n", i, documentTable.getRowCount(),
    documentTable.getColumnCount());
  documentTable.getCells().forEach(documentTableCell -> {
    System.out.printf("Cell '%s', has row index %d and column index %d.%n",
      documentTableCell.getContent(),
      documentTableCell.getRowIndex(), documentTableCell.getColumnIndex());
  });
  System.out.println();
}

// Key-value pairs
analyzeResult.getKeyValuePairs().forEach(documentKeyValuePair -> {
  System.out.printf("Key content: %s%n", documentKeyValuePair.getKey().getContent());
  System.out.printf("Key content bounding region: %s%n",
    documentKeyValuePair.getKey().getBoundingRegions().toString());

  if (documentKeyValuePair.getValue() != null) {
    System.out.printf("Value content: %s%n", documentKeyValuePair.getValue().getContent());
    System.out.printf("Value content bounding region: %s%n", documentKeyValuePair.getValue().getBoundingRegions().toString());
  }
});

}

}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída geral do modelo de documento.

Usar o modelo de imposto W-2

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

// sample document
String w2Url = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png";
String modelId = "prebuilt-tax.us.w2";

SyncPoller < OperationResult, AnalyzeResult > analyzeW2Poller =
  client.beginAnalyzeDocument(modelId, w2Url);

AnalyzeResult analyzeTaxResult = analyzeW2Poller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < analyzeTaxResult.getDocuments().size(); i++) {
  AnalyzedDocument analyzedTaxDocument = analyzeTaxResult.getDocuments().get(i);
  Map < String, DocumentField > taxFields = analyzedTaxDocument.getFields();
  System.out.printf("----------- Analyzing Document  %d -----------%n", i);
  DocumentField w2FormVariantField = taxFields.get("W2FormVariant");
  if (w2FormVariantField != null) {
    if (DocumentFieldType.STRING == w2FormVariantField.getType()) {
      String merchantName = w2FormVariantField.getValueAsString();
      System.out.printf("Form variant: %s, confidence: %.2f%n",
        merchantName, w2FormVariantField.getConfidence());
    }
  }

  DocumentField employeeField = taxFields.get("Employee");
  if (employeeField != null) {
    System.out.println("Employee Data: ");
    if (DocumentFieldType.MAP == employeeField.getType()) {
      Map < String, DocumentField > employeeDataFieldMap = employeeField.getValueAsMap();
      DocumentField employeeName = employeeDataFieldMap.get("Name");
      if (employeeName != null) {
        if (DocumentFieldType.STRING == employeeName.getType()) {
          String employeesName = employeeName.getValueAsString();
          System.out.printf("Employee Name: %s, confidence: %.2f%n",
            employeesName, employeeName.getConfidence());
        }
      }
      DocumentField employeeAddrField = employeeDataFieldMap.get("Address");
      if (employeeAddrField != null) {
        if (DocumentFieldType.STRING == employeeAddrField.getType()) {
          String employeeAddress = employeeAddrField.getValueAsString();
          System.out.printf("Employee Address: %s, confidence: %.2f%n",
            employeeAddress, employeeAddrField.getConfidence());
        }
      }
    }
  }

  DocumentField employerField = taxFields.get("Employer");
  if (employerField != null) {
    System.out.println("Employer Data: ");
    if (DocumentFieldType.MAP == employerField.getType()) {
      Map < String, DocumentField > employerDataFieldMap = employerField.getValueAsMap();
      DocumentField employerNameField = employerDataFieldMap.get("Name");
      if (employerNameField != null) {
        if (DocumentFieldType.STRING == employerNameField.getType()) {
          String employerName = employerNameField.getValueAsString();
          System.out.printf("Employer Name: %s, confidence: %.2f%n",
            employerName, employerNameField.getConfidence());
        }
      }

      DocumentField employerIDNumberField = employerDataFieldMap.get("IdNumber");
      if (employerIDNumberField != null) {
        if (DocumentFieldType.STRING == employerIDNumberField.getType()) {
          String employerIdNumber = employerIDNumberField.getValueAsString();
          System.out.printf("Employee ID Number: %s, confidence: %.2f%n",
            employerIdNumber, employerIDNumberField.getConfidence());
        }
      }
    }
  }

  DocumentField taxYearField = taxFields.get("TaxYear");
  if (taxYearField != null) {
    if (DocumentFieldType.STRING == taxYearField.getType()) {
      String taxYear = taxYearField.getValueAsString();
      System.out.printf("Tax year: %s, confidence: %.2f%n",
        taxYear, taxYearField.getConfidence());
    }
  }

  DocumentField taxDateField = taxFields.get("TaxDate");
  if (taxDateField != null) {
    if (DocumentFieldType.DATE == taxDateField.getType()) {
      LocalDate taxDate = taxDateField.getValueAsDate();
      System.out.printf("Tax Date: %s, confidence: %.2f%n",
        taxDate, taxDateField.getConfidence());
    }
  }

  DocumentField socialSecurityTaxField = taxFields.get("SocialSecurityTaxWithheld");
  if (socialSecurityTaxField != null) {
    if (DocumentFieldType.DOUBLE == socialSecurityTaxField.getType()) {
      Double socialSecurityTax = socialSecurityTaxField.getValueAsDouble();
      System.out.printf("Social Security Tax withheld: %.2f, confidence: %.2f%n",
        socialSecurityTax, socialSecurityTaxField.getConfidence());
    }
  }
}
}
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de imposto W-2.

Usar o modelo de fatura

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

// sample document
String invoiceUrl = "https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf";
String modelId = "prebuilt-invoice";

SyncPoller < OperationResult, AnalyzeResult > analyzeInvoicesPoller =
  client.beginAnalyzeDocument(modelId, invoiceUrl);

AnalyzeResult analyzeInvoiceResult = analyzeInvoicesPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < analyzeInvoiceResult.getDocuments().size(); i++) {
  AnalyzedDocument analyzedInvoice = analyzeInvoiceResult.getDocuments().get(i);
  Map < String, DocumentField > invoiceFields = analyzedInvoice.getFields();
  System.out.printf("----------- Analyzing invoice  %d -----------%n", i);
  DocumentField vendorNameField = invoiceFields.get("VendorName");
  if (vendorNameField != null) {
    if (DocumentFieldType.STRING == vendorNameField.getType()) {
      String merchantName = vendorNameField.getValueAsString();
      System.out.printf("Vendor Name: %s, confidence: %.2f%n",
        merchantName, vendorNameField.getConfidence());
    }
  }

  DocumentField vendorAddressField = invoiceFields.get("VendorAddress");
  if (vendorAddressField != null) {
    if (DocumentFieldType.STRING == vendorAddressField.getType()) {
      String merchantAddress = vendorAddressField.getValueAsString();
      System.out.printf("Vendor address: %s, confidence: %.2f%n",
        merchantAddress, vendorAddressField.getConfidence());
    }
  }

  DocumentField customerNameField = invoiceFields.get("CustomerName");
  if (customerNameField != null) {
    if (DocumentFieldType.STRING == customerNameField.getType()) {
      String merchantAddress = customerNameField.getValueAsString();
      System.out.printf("Customer Name: %s, confidence: %.2f%n",
        merchantAddress, customerNameField.getConfidence());
    }
  }

  DocumentField customerAddressRecipientField = invoiceFields.get("CustomerAddressRecipient");
  if (customerAddressRecipientField != null) {
    if (DocumentFieldType.STRING == customerAddressRecipientField.getType()) {
      String customerAddr = customerAddressRecipientField.getValueAsString();
      System.out.printf("Customer Address Recipient: %s, confidence: %.2f%n",
        customerAddr, customerAddressRecipientField.getConfidence());
    }
  }

  DocumentField invoiceIdField = invoiceFields.get("InvoiceId");
  if (invoiceIdField != null) {
    if (DocumentFieldType.STRING == invoiceIdField.getType()) {
      String invoiceId = invoiceIdField.getValueAsString();
      System.out.printf("Invoice ID: %s, confidence: %.2f%n",
        invoiceId, invoiceIdField.getConfidence());
    }
  }

  DocumentField invoiceDateField = invoiceFields.get("InvoiceDate");
  if (customerNameField != null) {
    if (DocumentFieldType.DATE == invoiceDateField.getType()) {
      LocalDate invoiceDate = invoiceDateField.getValueAsDate();
      System.out.printf("Invoice Date: %s, confidence: %.2f%n",
        invoiceDate, invoiceDateField.getConfidence());
    }
  }

  DocumentField invoiceTotalField = invoiceFields.get("InvoiceTotal");
  if (customerAddressRecipientField != null) {
    if (DocumentFieldType.DOUBLE == invoiceTotalField.getType()) {
      Double invoiceTotal = invoiceTotalField.getValueAsDouble();
      System.out.printf("Invoice Total: %.2f, confidence: %.2f%n",
        invoiceTotal, invoiceTotalField.getConfidence());
    }
  }

  DocumentField invoiceItemsField = invoiceFields.get("Items");
  if (invoiceItemsField != null) {
    System.out.printf("Invoice Items: %n");
    if (DocumentFieldType.LIST == invoiceItemsField.getType()) {
      List < DocumentField > invoiceItems = invoiceItemsField.getValueAsList();
      invoiceItems.stream()
        .filter(invoiceItem -> DocumentFieldType.MAP == invoiceItem.getType())
        .map(documentField -> documentField.getValueAsMap())
        .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
          if ("Description".equals(key)) {
            if (DocumentFieldType.STRING == documentField.getType()) {
              String name = documentField.getValueAsString();
              System.out.printf("Description: %s, confidence: %.2fs%n",
                name, documentField.getConfidence());
            }
          }
          if ("Quantity".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double quantity = documentField.getValueAsDouble();
              System.out.printf("Quantity: %f, confidence: %.2f%n",
                quantity, documentField.getConfidence());
            }
          }
          if ("UnitPrice".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double unitPrice = documentField.getValueAsDouble();
              System.out.printf("Unit Price: %f, confidence: %.2f%n",
                unitPrice, documentField.getConfidence());
            }
          }
          if ("ProductCode".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double productCode = documentField.getValueAsDouble();
              System.out.printf("Product Code: %f, confidence: %.2f%n",
                productCode, documentField.getConfidence());
            }
          }
        }));
    }
  }
}
}
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de fatura.

Usar o modelo de recibo

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

String receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png";
String modelId = "prebuilt-receipt";

SyncPoller < OperationResult, AnalyzeResult > analyzeReceiptPoller =
  client.beginAnalyzeDocument(modelId, receiptUrl);

AnalyzeResult receiptResults = analyzeReceiptPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < receiptResults.getDocuments().size(); i++) {
  AnalyzedDocument analyzedReceipt = receiptResults.getDocuments().get(i);
  Map < String, DocumentField > receiptFields = analyzedReceipt.getFields();
  System.out.printf("----------- Analyzing receipt info %d -----------%n", i);
  DocumentField merchantNameField = receiptFields.get("MerchantName");
  if (merchantNameField != null) {
    if (DocumentFieldType.STRING == merchantNameField.getType()) {
      String merchantName = merchantNameField.getValueAsString();
      System.out.printf("Merchant Name: %s, confidence: %.2f%n",
        merchantName, merchantNameField.getConfidence());
    }
  }

  DocumentField merchantPhoneNumberField = receiptFields.get("MerchantPhoneNumber");
  if (merchantPhoneNumberField != null) {
    if (DocumentFieldType.PHONE_NUMBER == merchantPhoneNumberField.getType()) {
      String merchantAddress = merchantPhoneNumberField.getValueAsPhoneNumber();
      System.out.printf("Merchant Phone number: %s, confidence: %.2f%n",
        merchantAddress, merchantPhoneNumberField.getConfidence());
    }
  }

  DocumentField merchantAddressField = receiptFields.get("MerchantAddress");
  if (merchantAddressField != null) {
    if (DocumentFieldType.STRING == merchantAddressField.getType()) {
      String merchantAddress = merchantAddressField.getValueAsString();
      System.out.printf("Merchant Address: %s, confidence: %.2f%n",
        merchantAddress, merchantAddressField.getConfidence());
    }
  }

  DocumentField transactionDateField = receiptFields.get("TransactionDate");
  if (transactionDateField != null) {
    if (DocumentFieldType.DATE == transactionDateField.getType()) {
      LocalDate transactionDate = transactionDateField.getValueAsDate();
      System.out.printf("Transaction Date: %s, confidence: %.2f%n",
        transactionDate, transactionDateField.getConfidence());
    }
  }

  DocumentField receiptItemsField = receiptFields.get("Items");
  if (receiptItemsField != null) {
    System.out.printf("Receipt Items: %n");
    if (DocumentFieldType.LIST == receiptItemsField.getType()) {
      List < DocumentField > receiptItems = receiptItemsField.getValueAsList();
      receiptItems.stream()
        .filter(receiptItem -> DocumentFieldType.MAP == receiptItem.getType())
        .map(documentField -> documentField.getValueAsMap())
        .forEach(documentFieldMap -> documentFieldMap.forEach((key, documentField) -> {
          if ("Name".equals(key)) {
            if (DocumentFieldType.STRING == documentField.getType()) {
              String name = documentField.getValueAsString();
              System.out.printf("Name: %s, confidence: %.2fs%n",
                name, documentField.getConfidence());
            }
          }
          if ("Quantity".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double quantity = documentField.getValueAsDouble();
              System.out.printf("Quantity: %f, confidence: %.2f%n",
                quantity, documentField.getConfidence());
            }
          }
          if ("Price".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double price = documentField.getValueAsDouble();
              System.out.printf("Price: %f, confidence: %.2f%n",
                price, documentField.getConfidence());
            }
          }
          if ("TotalPrice".equals(key)) {
            if (DocumentFieldType.DOUBLE == documentField.getType()) {
              Double totalPrice = documentField.getValueAsDouble();
              System.out.printf("Total Price: %f, confidence: %.2f%n",
                totalPrice, documentField.getConfidence());
            }
          }
        }));
    }
  }
}
}
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de recibo.

Usar o modelo de documento de identificação

import com.azure.ai.documentintelligence;

import com.azure.ai.documentintelligence.models.AnalyzeDocumentRequest;
import com.azure.ai.documentintelligence.models.AnalyzeResult;
import com.azure.ai.documentintelligence.models.AnalyzeResultOperation;
import com.azure.ai.documentintelligence.models.Document;
import com.azure.ai.documentintelligence.models.DocumentField;
import com.azure.ai.documentintelligence.models.DocumentFieldType;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.util.polling.SyncPoller;

import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Map;

public class DocIntelligence {
  //use your `key` and `endpoint` environment variables
  private static final String key = System.getenv("FR_KEY");
  private static final String endpoint = System.getenv("FR_ENDPOINT");

  public static void main(final String[] args) {

      // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
      DocumentIntelligenceClient client = new DocumentIntelligenceClientBuilder()
        .credential(new AzureKeyCredential(key))
        .endpoint(endpoint)
        .buildClient();

//sample document
String licenseUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png";
String modelId = "prebuilt-idDocument";

SyncPoller < OperationResult, AnalyzeResult > analyzeIdentityDocumentPoller = client.beginAnalyzeDocument(modelId, licenseUrl);

AnalyzeResult identityDocumentResults = analyzeIdentityDocumentPoller.getFinalResult().getAnalyzeResult();

for (int i = 0; i < identityDocumentResults.getDocuments().size(); i++) {
  AnalyzedDocument analyzedIDDocument = identityDocumentResults.getDocuments().get(i);
  Map < String, DocumentField > licenseFields = analyzedIDDocument.getFields();
  System.out.printf("----------- Analyzed license info for page %d -----------%n", i);
  DocumentField addressField = licenseFields.get("Address");
  if (addressField != null) {
    if (DocumentFieldType.STRING == addressField.getType()) {
      String address = addressField.getValueAsString();
      System.out.printf("Address: %s, confidence: %.2f%n",
        address, addressField.getConfidence());
    }
  }

  DocumentField countryRegionDocumentField = licenseFields.get("CountryRegion");
  if (countryRegionDocumentField != null) {
    if (DocumentFieldType.STRING == countryRegionDocumentField.getType()) {
      String countryRegion = countryRegionDocumentField.getValueAsCountry();
      System.out.printf("Country or region: %s, confidence: %.2f%n",
        countryRegion, countryRegionDocumentField.getConfidence());
    }
  }

  DocumentField dateOfBirthField = licenseFields.get("DateOfBirth");
  if (dateOfBirthField != null) {
    if (DocumentFieldType.DATE == dateOfBirthField.getType()) {
      LocalDate dateOfBirth = dateOfBirthField.getValueAsDate();
      System.out.printf("Date of Birth: %s, confidence: %.2f%n",
        dateOfBirth, dateOfBirthField.getConfidence());
    }
  }

  DocumentField dateOfExpirationField = licenseFields.get("DateOfExpiration");
  if (dateOfExpirationField != null) {
    if (DocumentFieldType.DATE == dateOfExpirationField.getType()) {
      LocalDate expirationDate = dateOfExpirationField.getValueAsDate();
      System.out.printf("Document date of expiration: %s, confidence: %.2f%n",
        expirationDate, dateOfExpirationField.getConfidence());
    }
  }

  DocumentField documentNumberField = licenseFields.get("DocumentNumber");
  if (documentNumberField != null) {
    if (DocumentFieldType.STRING == documentNumberField.getType()) {
      String documentNumber = documentNumberField.getValueAsString();
      System.out.printf("Document number: %s, confidence: %.2f%n",
        documentNumber, documentNumberField.getConfidence());
    }
  }

  DocumentField firstNameField = licenseFields.get("FirstName");
  if (firstNameField != null) {
    if (DocumentFieldType.STRING == firstNameField.getType()) {
      String firstName = firstNameField.getValueAsString();
      System.out.printf("First Name: %s, confidence: %.2f%n",
        firstName, documentNumberField.getConfidence());
    }
  }

  DocumentField lastNameField = licenseFields.get("LastName");
  if (lastNameField != null) {
    if (DocumentFieldType.STRING == lastNameField.getType()) {
      String lastName = lastNameField.getValueAsString();
      System.out.printf("Last name: %s, confidence: %.2f%n",
        lastName, lastNameField.getConfidence());
    }
  }

  DocumentField regionField = licenseFields.get("Region");
  if (regionField != null) {
    if (DocumentFieldType.STRING == regionField.getType()) {
      String region = regionField.getValueAsString();
      System.out.printf("Region: %s, confidence: %.2f%n",
        region, regionField.getConfidence());
    }
  }
}
}
}

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de documento de ID.

Pacote de referência | da API REST da biblioteca | do cliente (npm) | Exemplos |Versão suportada da API REST

Pré-requisitos

• Uma assinatura do Azure - Crie uma gratuitamente.

• A versão mais recente do Visual Studio Code ou seu IDE preferido. Para obter mais informações, consulte Node.js no Visual Studio Code.

• A última LTS versão do Node.js.

• Um recurso de serviços de IA do Azure ou Document Intelligence. Crie um serviço único ou multisserviço. Você pode usar o nível de preço gratuito (F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

  Gorjeta

  Crie um recurso de serviços de IA do Azure se você planeja acessar vários serviços de IA do Azure usando um único ponto de extremidade e chave. Apenas para acesso ao Document Intelligence, crie um recurso Document Intelligence. Você precisa de um recurso de serviço único se pretende usar a autenticação do Microsoft Entra.

• A chave e o ponto de extremidade do recurso que você cria para conectar seu aplicativo ao serviço de Inteligência de Documentos do Azure.

  1. Depois que o recurso for implantado, selecione Ir para o recurso.
  2. No menu de navegação esquerdo, selecione Teclas e Ponto de extremidade.
  3. Copie uma das chaves e o Endpoint para uso mais adiante neste artigo.

  

• Um arquivo de documento em uma URL. Para este projeto, você pode usar os formulários de exemplo fornecidos na tabela a seguir para cada recurso:

  Caraterística	ID do modelo	documento-url
  Ler modelo	leitura pré-embutida	Exemplo de brochura
  Modelo de layout	layout pré-construído	Confirmação da reserva da amostra
  Modelo de formulário W-2	pré-construído-tax.us.w2	Exemplo de formulário W-2
  Modelo de fatura	fatura pré-embutida	Fatura de exemplo
  Modelo de recibo	recibo pré-embutido	Recibo de amostra
  Modelo de documento de identificação	prebuilt-idDocument	Exemplo de documento de identificação

Definir as variáveis de ambiente

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentAnalysisClient classe. Para fazer isso, instancie o cliente com o seu key e endpoint do portal do Azure. Para este projeto, use variáveis de ambiente para armazenar e acessar credenciais.

Importante

Não inclua a sua chave diretamente no código e nunca a publique publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações, consulte Segurança dos serviços de IA do Azure.

Para definir a variável de ambiente para a chave de recurso do Document Intelligence, abra uma janela do console e siga as instruções para o sistema operacional e o ambiente de desenvolvimento. Substitua <yourKey> e <yourEndpoint> pelos valores do seu recurso no portal do Azure.

Windows

As variáveis de ambiente no Windows não diferenciam maiúsculas de minúsculas. Eles são normalmente declarados em maiúsculas, com palavras unidas por um sublinhado. Em um prompt de comando, execute os seguintes comandos:

1. Defina a sua variável chave:

   setx DI_KEY <yourKey>
   

2. Definir sua variável de ponto de extremidade

   setx DI_ENDPOINT <yourEndpoint>
   

3. Feche a janela do prompt de comando depois de definir as variáveis de ambiente. Os valores permanecem até que você os altere novamente.

4. Reinicie todos os programas em execução que lerem a variável de ambiente. Por exemplo, se você estiver usando o Visual Studio ou Visual Studio Code como seu editor, reinicie antes de executar o código de exemplo.

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
setx VARIABLE_NAME=	Exclua a variável de ambiente definindo o valor como uma cadeia de caracteres vazia.	setx DI_KEY=
setx VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica.	set DI_KEY
set	Exiba todas as variáveis de ambiente.	set

macOS

As variáveis de ambiente no macOS diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal. Abra o terminal e digite os seguintes comandos:

1. Defina a sua variável chave:

   export key=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export endpoint=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bash_profile :

1. Use um editor de texto para abrir o arquivo ~/.bash_profile e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemplo: export DI_KEY="<yourKey>"

2. Salve as alterações no arquivo bash_profile .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bash-profile
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Linux

As variáveis de ambiente no Linux diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal:

1. Defina a sua variável chave:

   export DI_KEY=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export DI_ENDPOINT=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bashrc :

1. Use um editor de texto para abrir o arquivo ~/.bashrc e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export <VARIABLE>=<value>
   

   Exemplo: export DI_KEY=<yourKey>

2. Salve suas alterações no arquivo .bashrc .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bashrc
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY=
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Configurar o seu ambiente de programação

Crie um aplicativo Node.js Express.

1. Em uma janela de console, crie e navegue até um novo diretório para seu aplicativo chamado doc-intel-app.

   mkdir doc-intel-app
   cd doc-intel-app
   

2. Execute o npm init comando para inicializar o aplicativo e organizar seu projeto.

   npm init
   

3. Especifique os atributos do seu projeto usando os prompts apresentados no terminal.

   • Os atributos mais importantes são nome, número da versão e ponto de entrada.
   • Recomendamos que você mantenha index.js o nome do ponto de entrada. A descrição, o comando de teste, o repositório GitHub, as palavras-chave, o autor e as informações de licença são atributos opcionais. Você pode ignorá-los para este projeto.
   • Selecione Enter para aceitar as sugestões entre parênteses.

   Depois de concluir os prompts, o comando cria um package.json arquivo no diretório doc-intel-app .

4. Instale a biblioteca do cliente e azure/identity os ai-document-intelligence pacotes npm:

   npm i @azure-rest/ai-document-intelligence@1.0.0-beta.2 @azure/identity
   

O arquivo de package.json do seu aplicativo é atualizado com as dependências.

1. Crie um arquivo chamado index.js no diretório do aplicativo.

   Gorjeta

   Você pode criar um novo arquivo usando o PowerShell. Abra uma janela do PowerShell no diretório do projeto mantendo pressionada a tecla Shift e clicando com o botão direito do mouse na pasta e, em seguida, digite o seguinte comando: New-Item index.js.

Compilar a aplicação

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentIntelligenceClient classe. Para fazer isso, crie um AzureKeyCredential com sua chave do portal do Azure e uma DocumentIntelligenceClient instância com o e seu ponto de extremidade do AzureKeyCredential Document Intelligence.

Abra o index.js arquivo no Visual Studio Code ou em seu IDE favorito e selecione um dos seguintes exemplos de código e copie/cole em seu aplicativo:

• O modelo de leitura pré-construído está no centro de todos os modelos de Document Intelligence e pode detetar linhas, palavras, locais e idiomas. O layout, o documento geral, os modelos pré-construídos e personalizados usam o read modelo como base para extrair textos de documentos.
• O modelo de layout pré-construído extrai texto e locais de texto, tabelas, marcas de seleção e informações de estrutura de documentos e imagens.
• O modelo prebuilt-tax.us.w2 extrai informações relatadas nos formulários de impostos do Internal Revenue Service (IRS) dos EUA.
• O modelo de fatura pré-construída extrai informações relatadas em formulários de impostos da Receita Federal dos EUA.
• O modelo de recibo pré-construído extrai informações importantes de recibos de venda impressos e manuscritos.
• O modelo prebuilt-idDocument extrai informações importantes das Carteiras de Motorista dos EUA; páginas biográficas de passaportes internacionais; IDs estaduais dos EUA; cartões de segurança social; e cartões de residente permanente.

Usar o modelo de leitura

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const documentUrlRead = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png"

// helper function
function* getTextOfSpans(content, spans) {
    for (const span of spans) {
        yield content.slice(span.offset, span.offset + span.length);
    }
}

async function main() {
    // create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));
    const poller = await client.beginAnalyzeDocument("prebuilt-read", documentUrlRead);

    const {
        content,
        pages,
        languages,
        styles
    } = await poller.pollUntilDone();

    if (pages.length <= 0) {
        console.log("No pages were extracted from the document.");
    } else {
        console.log("Pages:");
        for (const page of pages) {
            console.log("- Page", page.pageNumber, `(unit: ${page.unit})`);
            console.log(`  ${page.width}x${page.height}, angle: ${page.angle}`);
            console.log(`  ${page.lines.length} lines, ${page.words.length} words`);

            if (page.lines.length > 0) {
                console.log("  Lines:");

                for (const line of page.lines) {
                    console.log(`  - "${line.content}"`);

                    // The words of the line can also be iterated independently. The words are computed based on their
                    // corresponding spans.
                    for (const word of line.words()) {
                        console.log(`    - "${word.content}"`);
                    }
                }
            }
        }
    }

    if (languages.length <= 0) {
        console.log("No language spans were extracted from the document.");
    } else {
        console.log("Languages:");
        for (const languageEntry of languages) {
            console.log(
                `- Found language: ${languageEntry.languageCode} (confidence: ${languageEntry.confidence})`
            );
            for (const text of getTextOfSpans(content, languageEntry.spans)) {
                const escapedText = text.replace(/\r?\n/g, "\\n").replace(/"/g, '\\"');
                console.log(`  - "${escapedText}"`);
            }
        }
    }

    if (styles.length <= 0) {
        console.log("No text styles were extracted from the document.");
    } else {
        console.log("Styles:");
        for (const style of styles) {
            console.log(
                `- Handwritten: ${style.isHandwritten ? "yes" : "no"} (confidence=${style.confidence})`
            );

            for (const word of getTextOfSpans(content, style.spans)) {
                console.log(`  - "${word}"`);
            }
        }
    }
}

main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do read modelo.

Usar o modelo de layout

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const layoutUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png"

async function main() {
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument(
      "prebuilt-layout", layoutUrl);

    // Layout extraction produces basic elements such as pages, words, lines, etc. as well as information about the
    // appearance (styles) of textual elements.
    const { pages, tables } = await poller.pollUntilDone();

    if (!pages || pages.length <= 0) {
      console.log("No pages were extracted from the document.");
    } else {
      console.log("Pages:");
      for (const page of pages) {
        console.log("- Page", page.pageNumber, `(unit: ${page.unit})`);
        console.log(`  ${page.width}x${page.height}, angle: ${page.angle}`);
        console.log(
          `  ${page.lines && page.lines.length} lines, ${page.words && page.words.length} words`
        );

        if (page.lines && page.lines.length > 0) {
          console.log("  Lines:");

          for (const line of page.lines) {
            console.log(`  - "${line.content}"`);

            // The words of the line can also be iterated independently. The words are computed based on their
            // corresponding spans.
            for (const word of line.words()) {
              console.log(`    - "${word.content}"`);
            }
          }
        }
      }
    }

    if (!tables || tables.length <= 0) {
      console.log("No tables were extracted from the document.");
    } else {
      console.log("Tables:");
      for (const table of tables) {
        console.log(
          `- Extracted table: ${table.columnCount} columns, ${table.rowCount} rows (${table.cells.length} cells)`
        );
      }
    }
  }

  main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
  });

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de layout.

Utilizar o modelo de documento Geral

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const documentUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf"

async function main() {
    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("prebuilt-document", documentUrl);

    const {
        keyValuePairs
    } = await poller.pollUntilDone();

    if (!keyValuePairs || keyValuePairs.length <= 0) {
        console.log("No key-value pairs were extracted from the document.");
    } else {
        console.log("Key-Value Pairs:");
        for (const {
                key,
                value,
                confidence
            } of keyValuePairs) {
            console.log("- Key  :", `"${key.content}"`);
            console.log("  Value:", `"${(value && value.content) || "<undefined>"}" (${confidence})`);
        }
    }

}

main().catch((error) => {
    console.error("An error occurred:", error);
    process.exit(1);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída geral do modelo de documento.

Usar o modelo de imposto W-2

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

const w2DocumentURL = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png"

async function main() {
 const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

 const poller = await client.beginAnalyzeDocument("prebuilt-tax.us.w2", w2DocumentURL);

 const {
   documents: [result]
 } = await poller.pollUntilDone();

  if (result) {
    const { Employee, Employer, ControlNumber, TaxYear, AdditionalInfo } = result.fields;

    if (Employee) {
      const { Name, Address, SocialSecurityNumber } = Employee.properties;
      console.log("Employee:");
      console.log("  Name:", Name && Name.content);
      console.log("  SSN/TIN:", SocialSecurityNumber && SocialSecurityNumber.content);
      if (Address && Address.value) {
        const { streetAddress, postalCode } = Address.value;
        console.log("  Address:");
        console.log("    Street Address:", streetAddress);
        console.log("    Postal Code:", postalCode);
      }
    } else {
      console.log("No employee information extracted.");
    }

    if (Employer) {
      const { Name, Address, IdNumber } = Employer.properties;
      console.log("Employer:");
      console.log("  Name:", Name && Name.content);
      console.log("  ID (EIN):", IdNumber && IdNumber.content);

      if (Address && Address.value) {
        const { streetAddress, postalCode } = Address.value;
        console.log("  Address:");
        console.log("    Street Address:", streetAddress);
        console.log("    Postal Code:", postalCode);
      }
    } else {
      console.log("No employer information extracted.");
    }

    console.log("Control Number:", ControlNumber && ControlNumber.content);
    console.log("Tax Year:", TaxYear && TaxYear.content);

    if (AdditionalInfo) {
      console.log("Additional Info:");

      for (const info of AdditionalInfo.values) {
        const { LetterCode, Amount } = info.properties;
        console.log(`- ${LetterCode && LetterCode.content}: ${Amount && Amount.content}`);
      }
    }
  } else {
    throw new Error("Expected at least one document in the result.");
  }
}

main().catch((error) => {
  console.error(error);
  process.exit(1);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de imposto W-2.

Usar o modelo de fatura

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample url
const invoiceUrl = "https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf";

async function main() {

  const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

  const poller = await client.beginAnalyzeDocument("prebuilt-invoice", invoiceUrl);

  const {
      documents: [result]
  } = await poller.pollUntilDone();

  if (result) {
      const invoice = result.fields;

      console.log("Vendor Name:", invoice.VendorName?.content);
      console.log("Customer Name:", invoice.CustomerName?.content);
      console.log("Invoice Date:", invoice.InvoiceDate?.content);
      console.log("Due Date:", invoice.DueDate?.content);

      console.log("Items:");
      for (const {
              properties: item
          } of invoice.Items?.values ?? []) {
          console.log("-", item.ProductCode?.content ?? "<no product code>");
          console.log("  Description:", item.Description?.content);
          console.log("  Quantity:", item.Quantity?.content);
          console.log("  Date:", item.Date?.content);
          console.log("  Unit:", item.Unit?.content);
          console.log("  Unit Price:", item.UnitPrice?.content);
          console.log("  Tax:", item.Tax?.content);
          console.log("  Amount:", item.Amount?.content);
      }

      console.log("Subtotal:", invoice.SubTotal?.content);
      console.log("Previous Unpaid Balance:", invoice.PreviousUnpaidBalance?.content);
      console.log("Tax:", invoice.TotalTax?.content);
      console.log("Amount Due:", invoice.AmountDue?.content);
  } else {
      throw new Error("Expected at least one receipt in the result.");
  }
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de fatura.

Usar o modelo de recibo

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample url
const receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png";

async function main() {

    const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

    const poller = await client.beginAnalyzeDocument("prebuilt-receipt", receiptUrl);

    const {
        documents: [result]
    } = await poller.pollUntilDone();

    if (result) {
        const {
            MerchantName,
            Items,
            Total
        } = result.fields;

        console.log("=== Receipt Information ===");
        console.log("Type:", result.docType);
        console.log("Merchant:", MerchantName && MerchantName.content);

        console.log("Items:");
        for (const item of (Items && Items.values) || []) {
            const {
                Description,
                TotalPrice
            } = item.properties;

            console.log("- Description:", Description && Description.content);
            console.log("  Total Price:", TotalPrice && TotalPrice.content);
        }

        console.log("Total:", Total && Total.content);
    } else {
        throw new Error("Expected at least one receipt in the result.");
    }

}

main().catch((err) => {
    console.error("The sample encountered an error:", err);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de recibo.

Usar o modelo de documento de identificação

const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence");
const  { AzureKeyCredential } = require("@azure/core-auth");

//use your `key` and `endpoint` environment variables
const key = process.env['DI_KEY'];
const endpoint = process.env['DI_ENDPOINT'];

// sample document
const idDocumentURL = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png"

async function main() {
 const client = DocumentIntelligence(endpoint, new AzureKeyCredential(key));

 const poller = await client.beginAnalyzeDocument("prebuilt-idDocument", idDocumentURL);

 const {
   documents: [result]
 } = await poller.pollUntilDone();

  if (result) {
// The identity document model has multiple document types, so we need to know which document type was actually
    extracted.
    if (result.docType === "idDocument.driverLicense") {
      const { FirstName, LastName, DocumentNumber, DateOfBirth, DateOfExpiration, Height, Weight, EyeColor, Endorsements, Restrictions, VehicleClassifications} = result.fields;

// For the sake of the example, we'll only show a few of the fields that are produced.
      console.log("Extracted a Driver License:");
      console.log("  Name:", FirstName && FirstName.content, LastName && LastName.content);
      console.log("  License No.:", DocumentNumber && DocumentNumber.content);
      console.log("  Date of Birth:", DateOfBirth && DateOfBirth.content);
      console.log("  Expiration:", DateOfExpiration && DateOfExpiration.content);
      console.log("  Height:", Height && Height.content);
      console.log("  Weight:", Weight && Weight.content);
      console.log("  Eye color:", EyeColor && EyeColor.content);
      console.log("  Restrictions:", Restrictions && Restrictions.content);
      console.log("  Endorsements:", Endorsements && Endorsements.content);
      console.log("  Class:", VehicleClassifications && VehicleClassifications.content);
    } else if (result.docType === "idDocument.passport") {
// The passport document type extracts and parses the Passport's machine-readable zone
      if (!result.fields.machineReadableZone) {
        throw new Error("No Machine Readable Zone extracted from passport.");
      }

      const {
        FirstName,
        LastName,
        DateOfBirth,
        Nationality,
        DocumentNumber,
        CountryRegion,
        DateOfExpiration,
      } = result.fields.machineReadableZone.properties;

      console.log("Extracted a Passport:");
      console.log("  Name:", FirstName && FirstName.content, LastName && LastName.content);
      console.log("  Date of Birth:", DateOfBirth && DateOfBirth.content);
      console.log("  Nationality:", Nationality && Nationality.content);
      console.log("  Passport No.:", DocumentNumber && DocumentNumber.content);
      console.log("  Issuer:", CountryRegion && CountryRegion.content);
      console.log("  Expiration Date:", DateOfExpiration && DateOfExpiration.content);
    } else {
// The only reason this would happen is if the client library's schema for the prebuilt identity document model is
      out of date, and a new document type has been introduced.
      console.error("Unknown document type in result:", result);
    }
  } else {
    throw new Error("Expected at least one receipt in the result.");
  }
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de documento de ID.

Referência | do SDK da biblioteca |do cliente Pacote de referência | da API REST (PyPi) | Amostras | Versão da API REST suportada

Pré-requisitos

• Uma assinatura do Azure - Crie uma gratuitamente.

• Python 3.7 ou posterior. Sua instalação do Python deve incluir pip. Você pode verificar se você tem pip instalado executando pip --version na linha de comando. Obtenha pip instalando a versão mais recente do Python.

• A versão mais recente do Visual Studio Code ou seu IDE preferido. Consulte Introdução ao Python no Visual Studio Code.

• Um recurso de serviços de IA do Azure ou Document Intelligence. Crie um serviço único ou multisserviço. Você pode usar o nível de preço gratuito (F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

• A chave e o ponto de extremidade do recurso que você cria para conectar seu aplicativo ao serviço de Inteligência de Documentos do Azure.

  1. Depois que o recurso for implantado, selecione Ir para o recurso.
  2. No menu de navegação esquerdo, selecione Teclas e Ponto de extremidade.
  3. Copie uma das chaves e o Endpoint para uso mais adiante neste artigo.

  

• Um arquivo de documento em uma URL. Para este projeto, você pode usar os formulários de exemplo fornecidos na tabela a seguir para cada recurso:

  Caraterística	ID do modelo	documento-url
  Ler modelo	leitura pré-embutida	Exemplo de brochura
  Modelo de layout	layout pré-construído	Confirmação da reserva da amostra
  Modelo de formulário W-2	pré-construído-tax.us.w2	Exemplo de formulário W-2
  Modelo de fatura	fatura pré-embutida	Fatura de exemplo
  Modelo de recibo	recibo pré-embutido	Recibo de amostra
  Modelo de documento de identificação	prebuilt-idDocument	Exemplo de documento de identificação

Definir as variáveis de ambiente

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentAnalysisClient classe. Para fazer isso, instancie o cliente com o seu key e endpoint do portal do Azure. Para este projeto, use variáveis de ambiente para armazenar e acessar credenciais.

Importante

Não inclua a sua chave diretamente no código e nunca a publique publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações, consulte Segurança dos serviços de IA do Azure.

Para definir a variável de ambiente para a chave de recurso do Document Intelligence, abra uma janela do console e siga as instruções para o sistema operacional e o ambiente de desenvolvimento. Substitua <yourKey> e <yourEndpoint> pelos valores do seu recurso no portal do Azure.

Windows

As variáveis de ambiente no Windows não diferenciam maiúsculas de minúsculas. Eles são normalmente declarados em maiúsculas, com palavras unidas por um sublinhado. Em um prompt de comando, execute os seguintes comandos:

1. Defina a sua variável chave:

   setx DI_KEY <yourKey>
   

2. Definir sua variável de ponto de extremidade

   setx DI_ENDPOINT <yourEndpoint>
   

3. Feche a janela do prompt de comando depois de definir as variáveis de ambiente. Os valores permanecem até que você os altere novamente.

4. Reinicie todos os programas em execução que lerem a variável de ambiente. Por exemplo, se você estiver usando o Visual Studio ou Visual Studio Code como seu editor, reinicie antes de executar o código de exemplo.

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
setx VARIABLE_NAME=	Exclua a variável de ambiente definindo o valor como uma cadeia de caracteres vazia.	setx DI_KEY=
setx VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica.	set DI_KEY
set	Exiba todas as variáveis de ambiente.	set

macOS

As variáveis de ambiente no macOS diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal. Abra o terminal e digite os seguintes comandos:

1. Defina a sua variável chave:

   export key=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export endpoint=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bash_profile :

1. Use um editor de texto para abrir o arquivo ~/.bash_profile e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemplo: export DI_KEY="<yourKey>"

2. Salve as alterações no arquivo bash_profile .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bash-profile
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Linux

As variáveis de ambiente no Linux diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal:

1. Defina a sua variável chave:

   export DI_KEY=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export DI_ENDPOINT=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bashrc :

1. Use um editor de texto para abrir o arquivo ~/.bashrc e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export <VARIABLE>=<value>
   

   Exemplo: export DI_KEY=<yourKey>

2. Salve suas alterações no arquivo .bashrc .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bashrc
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY=
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Configurar o seu ambiente de programação

Abra uma janela de console em seu ambiente local e instale a biblioteca de cliente do Azure AI Document Intelligence para Python com pip:

pip install azure-ai-documentintelligence==1.0.0b2

Crie seu aplicativo Python

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentIntelligenceClient classe. Para fazer isso, crie um AzureKeyCredential com sua chave do portal do Azure e uma DocumentIntelligenceClient instância com o e seu ponto de extremidade do AzureKeyCredential Document Intelligence.

1. Crie um novo arquivo Python chamado form_recognizer_quickstart.py em um editor ou IDE.

2. Abra o arquivo form_recognizer_quickstart.py e selecione um dos seguintes exemplos de código e copie/cole em seu aplicativo:

   • O modelo de leitura pré-construído está no centro de todos os modelos de Document Intelligence e pode detetar linhas, palavras, locais e idiomas. O layout, o documento geral, os modelos pré-construídos e personalizados usam o read modelo como base para extrair textos de documentos.
   • O modelo de layout pré-construído extrai texto e locais de texto, tabelas, marcas de seleção e informações de estrutura de documentos e imagens.
   • O modelo prebuilt-tax.us.w2 extrai informações relatadas nos formulários de impostos do Internal Revenue Service (IRS) dos EUA.
   • O modelo de fatura pré-incorporada extrai campos-chave e itens de linha de faturas de vendas em vários formatos.
   • O modelo de recibo pré-construído extrai informações importantes de recibos de venda impressos e manuscritos.
   • O modelo prebuilt-idDocument extrai informações importantes das Carteiras de Motorista dos EUA; páginas biográficas de passaportes internacionais; IDs estaduais dos EUA; cartões de segurança social; e cartões de residente permanente.

3. Execute o código Python a partir do prompt de comando.

   python form_recognizer_quickstart.py
   

Usar o modelo de leitura

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_read():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-read", formUrl
    )
    result = poller.result()

    print("Document contains content: ", result.content)

    for idx, style in enumerate(result.styles):
        print(
            "Document contains {} content".format(
                "handwritten" if style.is_handwritten else "no handwritten"
            )
        )

    for page in result.pages:
        print("----Analyzing Read from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            print(
                "...Line # {} has text content '{}' within bounding box '{}'".format(
                    line_idx,
                    line.content,
                    format_polygon(line.polygon),
                )
            )

        for word in page.words:
            print(
                "...Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

    print("----------------------------------------")


if __name__ == "__main__":
    analyze_read()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do read modelo.

Usar o modelo de layout

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult


# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_layout():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-layout", formUrl
    )
    result = poller.result()

    for idx, style in enumerate(result.styles):
        print(
            "Document contains {} content".format(
                "handwritten" if style.is_handwritten else "no handwritten"
            )
        )

    for page in result.pages:
        print("----Analyzing layout from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            words = line.get_words()
            print(
                "...Line # {} has word count {} and text '{}' within bounding box '{}'".format(
                    line_idx,
                    len(words),
                    line.content,
                    format_polygon(line.polygon),
                )
            )

            for word in words:
                print(
                    "......Word '{}' has a confidence of {}".format(
                        word.content, word.confidence
                    )
                )

        for selection_mark in page.selection_marks:
            print(
                "...Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
                    selection_mark.state,
                    format_polygon(selection_mark.polygon),
                    selection_mark.confidence,
                )
            )

    for table_idx, table in enumerate(result.tables):
        print(
            "Table # {} has {} rows and {} columns".format(
                table_idx, table.row_count, table.column_count
            )
        )
        for region in table.bounding_regions:
            print(
                "Table # {} location on page: {} is {}".format(
                    table_idx,
                    region.page_number,
                    format_polygon(region.polygon),
                )
            )
        for cell in table.cells:
            print(
                "...Cell[{}][{}] has content '{}'".format(
                    cell.row_index,
                    cell.column_index,
                    cell.content,
                )
            )
            for region in cell.bounding_regions:
                print(
                    "...content on page {} is within bounding box '{}'".format(
                        region.page_number,
                        format_polygon(region.polygon),
                    )
                )

    print("----------------------------------------")


if __name__ == "__main__":
    analyze_layout()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de layout.

Utilizar o modelo de documento Geral

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_bounding_region(bounding_regions):
    if not bounding_regions:
        return "N/A"
    return ", ".join("Page #{}: {}".format(region.page_number, format_polygon(region.polygon)) for region in bounding_regions)

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_general_documents():
    # sample document
    docUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-layout.pdf"

    # create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
   client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))

    poller = client.begin_analyze_document(
            "prebuilt-document", docUrl)
    result = poller.result()

    for style in result.styles:
        if style.is_handwritten:
            print("Document contains handwritten content: ")
            print(",".join([result.content[span.offset:span.offset + span.length] for span in style.spans]))

    print("----Key-value pairs found in document----")
    for kv_pair in result.key_value_pairs:
        if kv_pair.key:
            print(
                    "Key '{}' found within '{}' bounding regions".format(
                        kv_pair.key.content,
                        format_bounding_region(kv_pair.key.bounding_regions),
                    )
                )
        if kv_pair.value:
            print(
                    "Value '{}' found within '{}' bounding regions\n".format(
                        kv_pair.value.content,
                        format_bounding_region(kv_pair.value.bounding_regions),
                    )
                )

    for page in result.pages:
        print("----Analyzing document from page #{}----".format(page.page_number))
        print(
            "Page has width: {} and height: {}, measured with unit: {}".format(
                page.width, page.height, page.unit
            )
        )

        for line_idx, line in enumerate(page.lines):
            print(
                "...Line # {} has text content '{}' within bounding box '{}'".format(
                    line_idx,
                    line.content,
                    format_polygon(line.polygon),
                )
            )

        for word in page.words:
            print(
                "...Word '{}' has a confidence of {}".format(
                    word.content, word.confidence
                )
            )

        for selection_mark in page.selection_marks:
            print(
                "...Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
                    selection_mark.state,
                    format_polygon(selection_mark.polygon),
                    selection_mark.confidence,
                )
            )

    for table_idx, table in enumerate(result.tables):
        print(
            "Table # {} has {} rows and {} columns".format(
                table_idx, table.row_count, table.column_count
            )
        )
        for region in table.bounding_regions:
            print(
                "Table # {} location on page: {} is {}".format(
                    table_idx,
                    region.page_number,
                    format_polygon(region.polygon),
                )
            )
        for cell in table.cells:
            print(
                "...Cell[{}][{}] has content '{}'".format(
                    cell.row_index,
                    cell.column_index,
                    cell.content,
                )
            )
            for region in cell.bounding_regions:
                print(
                    "...content on page {} is within bounding box '{}'\n".format(
                        region.page_number,
                        format_polygon(region.polygon),
                    )
                )
    print("----------------------------------------")


if __name__ == "__main__":
    analyze_general_documents()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída geral do modelo de documento.

Usar o modelo de imposto W-2

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_address_value(address_value):
    return f"\n......House/building number: {address_value.house_number}\n......Road: {address_value.road}\n......City: {address_value.city}\n......State: {address_value.state}\n......Postal code: {address_value.postal_code}"


def analyze_tax_us_w2():
    # sample document
    formUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
        "prebuilt-tax.us.w2", formUrl
    )
    w2s = poller.result()

    for idx, w2 in enumerate(w2s.documents):
         print("--------Analyzing US Tax W-2 Form #{}--------".format(idx   1))
        form_variant = w2.fields.get("W2FormVariant")
        if form_variant:
            print(
                "Form variant: {} has confidence: {}".format(
                    form_variant.value, form_variant.confidence
                )
            )
        tax_year = w2.fields.get("TaxYear")
        if tax_year:
            print(
                "Tax year: {} has confidence: {}".format(
                    tax_year.value, tax_year.confidence
                )
            )
        w2_copy = w2.fields.get("W2Copy")
        if w2_copy:
            print(
                "W-2 Copy: {} has confidence: {}".format(
                    w2_copy.value,
                    w2_copy.confidence,
                )
            )
        employee = w2.fields.get("Employee")
        if employee:
            print("Employee data:")
            employee_name = employee.value.get("Name")
            if employee_name:
                print(
                    "...Name: {} has confidence: {}".format(
                        employee_name.value, employee_name.confidence
                    )
                )
            employee_ssn = employee.value.get("SocialSecurityNumber")
            if employee_ssn:
                print(
                    "...SSN: {} has confidence: {}".format(
                        employee_ssn.value, employee_ssn.confidence
                    )
                )
            employee_address = employee.value.get("Address")
            if employee_address:
                print(
                    "...Address: {}\n......has confidence: {}".format(
                        format_address_value(employee_address.value),
                        employee_address.confidence,
                    )
                )
            employee_zipcode = employee.value.get("ZipCode")
            if employee_zipcode:
                print(
                    "...Zipcode: {} has confidence: {}".format(
                        employee_zipcode.value, employee_zipcode.confidence
                    )
                )
        control_number = w2.fields.get("ControlNumber")
        if control_number:
            print(
                "Control Number: {} has confidence: {}".format(
                    control_number.value, control_number.confidence
                )
            )
        employer = w2.fields.get("Employer")
        if employer:
            print("Employer data:")
            employer_name = employer.value.get("Name")
            if employer_name:
                print(
                    "...Name: {} has confidence: {}".format(
                        employer_name.value, employer_name.confidence
                    )
                )
            employer_id = employer.value.get("IdNumber")
            if employer_id:
                print(
                    "...ID Number: {} has confidence: {}".format(
                        employer_id.value, employer_id.confidence
                    )
                )
            employer_address = employer.value.get("Address")
            if employer_address:
                print(
                    "...Address: {}\n......has confidence: {}".format(
                        format_address_value(employer_address.value),
                        employer_address.confidence,
                    )
                )
            employer_zipcode = employer.value.get("ZipCode")
            if employer_zipcode:
                print(
                    "...Zipcode: {} has confidence: {}".format(
                        employer_zipcode.value, employer_zipcode.confidence
                    )
                )
        wages_tips = w2.fields.get("WagesTipsAndOtherCompensation")
        if wages_tips:
            print(
                "Wages, tips, and other compensation: {} has confidence: {}".format(
                    wages_tips.value,
                    wages_tips.confidence,
                )
            )
        fed_income_tax_withheld = w2.fields.get("FederalIncomeTaxWithheld")
        if fed_income_tax_withheld:
            print(
                "Federal income tax withheld: {} has confidence: {}".format(
                    fed_income_tax_withheld.value, fed_income_tax_withheld.confidence
                )
            )
        social_security_wages = w2.fields.get("SocialSecurityWages")
        if social_security_wages:
            print(
                "Social Security wages: {} has confidence: {}".format(
                    social_security_wages.value, social_security_wages.confidence
                )
            )
        social_security_tax_withheld = w2.fields.get("SocialSecurityTaxWithheld")
        if social_security_tax_withheld:
            print(
                "Social Security tax withheld: {} has confidence: {}".format(
                    social_security_tax_withheld.value,
                    social_security_tax_withheld.confidence,
                )
            )
        medicare_wages_tips = w2.fields.get("MedicareWagesAndTips")
        if medicare_wages_tips:
            print(
                "Medicare wages and tips: {} has confidence: {}".format(
                    medicare_wages_tips.value, medicare_wages_tips.confidence
                )
            )
        medicare_tax_withheld = w2.fields.get("MedicareTaxWithheld")
        if medicare_tax_withheld:
            print(
                "Medicare tax withheld: {} has confidence: {}".format(
                    medicare_tax_withheld.value, medicare_tax_withheld.confidence
                )
            )
        social_security_tips = w2.fields.get("SocialSecurityTips")
        if social_security_tips:
            print(
                "Social Security tips: {} has confidence: {}".format(
                    social_security_tips.value, social_security_tips.confidence
                )
            )
        allocated_tips = w2.fields.get("AllocatedTips")
        if allocated_tips:
            print(
                "Allocated tips: {} has confidence: {}".format(
                    allocated_tips.value,
                    allocated_tips.confidence,
                )
            )
        verification_code = w2.fields.get("VerificationCode")
        if verification_code:
            print(
                "Verification code: {} has confidence: {}".format(
                    verification_code.value, verification_code.confidence
                )
            )
        dependent_care_benefits = w2.fields.get("DependentCareBenefits")
        if dependent_care_benefits:
            print(
                "Dependent care benefits: {} has confidence: {}".format(
                    dependent_care_benefits.value,
                    dependent_care_benefits.confidence,
                )
            )
        non_qualified_plans = w2.fields.get("NonQualifiedPlans")
        if non_qualified_plans:
            print(
                "Non-qualified plans: {} has confidence: {}".format(
                    non_qualified_plans.value,
                    non_qualified_plans.confidence,
                )
            )
        additional_info = w2.fields.get("AdditionalInfo")
        if additional_info:
            print("Additional information:")
            for item in additional_info.value:
                letter_code = item.value.get("LetterCode")
                if letter_code:
                    print(
                        "...Letter code: {} has confidence: {}".format(
                            letter_code.value, letter_code.confidence
                        )
                    )
                amount = item.value.get("Amount")
                if amount:
                    print(
                        "...Amount: {} has confidence: {}".format(
                            amount.value, amount.confidence
                        )
                    )
        is_statutory_employee = w2.fields.get("IsStatutoryEmployee")
        if is_statutory_employee:
            print(
                "Is statutory employee: {} has confidence: {}".format(
                    is_statutory_employee.value, is_statutory_employee.confidence
                )
            )
        is_retirement_plan = w2.fields.get("IsRetirementPlan")
        if is_retirement_plan:
            print(
                "Is retirement plan: {} has confidence: {}".format(
                    is_retirement_plan.value, is_retirement_plan.confidence
                )
            )
        third_party_sick_pay = w2.fields.get("IsThirdPartySickPay")
        if third_party_sick_pay:
            print(
                "Is third party sick pay: {} has confidence: {}".format(
                    third_party_sick_pay.value, third_party_sick_pay.confidence
                )
            )
        other_info = w2.fields.get("Other")
        if other_info:
            print(
                "Other information: {} has confidence: {}".format(
                    other_info.value,
                    other_info.confidence,
                )
            )
        state_tax_info = w2.fields.get("StateTaxInfos")
        if state_tax_info:
            print("State Tax info:")
            for tax in state_tax_info.value:
                state = tax.value.get("State")
                if state:
                    print(
                        "...State: {} has confidence: {}".format(
                            state.value, state.confidence
                        )
                    )
                employer_state_id_number = tax.value.get("EmployerStateIdNumber")
                if employer_state_id_number:
                    print(
                        "...Employer state ID number: {} has confidence: {}".format(
                            employer_state_id_number.value,
                            employer_state_id_number.confidence,
                        )
                    )
                state_wages_tips = tax.value.get("StateWagesTipsEtc")
                if state_wages_tips:
                    print(
                        "...State wages, tips, etc: {} has confidence: {}".format(
                            state_wages_tips.value, state_wages_tips.confidence
                        )
                    )
                state_income_tax = tax.value.get("StateIncomeTax")
                if state_income_tax:
                    print(
                        "...State income tax: {} has confidence: {}".format(
                            state_income_tax.value, state_income_tax.confidence
                        )
                    )
        local_tax_info = w2.fields.get("LocalTaxInfos")
        if local_tax_info:
            print("Local Tax info:")
            for tax in local_tax_info.value:
                local_wages_tips = tax.value.get("LocalWagesTipsEtc")
                if local_wages_tips:
                    print(
                        "...Local wages, tips, etc: {} has confidence: {}".format(
                            local_wages_tips.value, local_wages_tips.confidence
                        )
                    )
                local_income_tax = tax.value.get("LocalIncomeTax")
                if local_income_tax:
                    print(
                        "...Local income tax: {} has confidence: {}".format(
                            local_income_tax.value, local_income_tax.confidence
                        )
                    )
                locality_name = tax.value.get("LocalityName")
                if locality_name:
                    print(
                        "...Locality name: {} has confidence: {}".format(
                            locality_name.value, locality_name.confidence
                        )
                    )

                print("----------------------------------------")


if __name__ == "__main__":
    analyze_tax_us_w2()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de imposto W-2.

Usar o modelo de fatura

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

# formatting function
def format_bounding_region(bounding_regions):
    if not bounding_regions:
        return "N/A"
    return ", ".join("Page #{}: {}".format(region.page_number, format_polygon(region.polygon)) for region in bounding_regions)

# formatting function
def format_polygon(polygon):
    if not polygon:
        return "N/A"
    return ", ".join(["[{}, {}]".format(p.x, p.y) for p in polygon])


def analyze_invoice():

    invoiceUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/sample-invoice.pdf"

    client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller = client.begin_analyze_document(
            "prebuilt-invoice", invoiceUrl)
    invoices = poller.result()

    for idx, invoice in enumerate(invoices.documents):
        print("--------Recognizing invoice #{}--------".format(idx + 1))
        vendor_name = invoice.fields.get("VendorName")
        if vendor_name:
            print(
                "Vendor Name: {} has confidence: {}".format(
                    vendor_name.value, vendor_name.confidence
                )
            )
        vendor_address = invoice.fields.get("VendorAddress")
        if vendor_address:
            print(
                "Vendor Address: {} has confidence: {}".format(
                    vendor_address.value, vendor_address.confidence
                )
            )
        vendor_address_recipient = invoice.fields.get("VendorAddressRecipient")
        if vendor_address_recipient:
            print(
                "Vendor Address Recipient: {} has confidence: {}".format(
                    vendor_address_recipient.value, vendor_address_recipient.confidence
                )
            )
        customer_name = invoice.fields.get("CustomerName")
        if customer_name:
            print(
                "Customer Name: {} has confidence: {}".format(
                    customer_name.value, customer_name.confidence
                )
            )
        customer_id = invoice.fields.get("CustomerId")
        if customer_id:
            print(
                "Customer Id: {} has confidence: {}".format(
                    customer_id.value, customer_id.confidence
                )
            )
        customer_address = invoice.fields.get("CustomerAddress")
        if customer_address:
            print(
                "Customer Address: {} has confidence: {}".format(
                    customer_address.value, customer_address.confidence
                )
            )
        customer_address_recipient = invoice.fields.get("CustomerAddressRecipient")
        if customer_address_recipient:
            print(
                "Customer Address Recipient: {} has confidence: {}".format(
                    customer_address_recipient.value,
                    customer_address_recipient.confidence,
                )
            )
        invoice_id = invoice.fields.get("InvoiceId")
        if invoice_id:
            print(
                "Invoice Id: {} has confidence: {}".format(
                    invoice_id.value, invoice_id.confidence
                )
            )
        invoice_date = invoice.fields.get("InvoiceDate")
        if invoice_date:
            print(
                "Invoice Date: {} has confidence: {}".format(
                    invoice_date.value, invoice_date.confidence
                )
            )
        invoice_total = invoice.fields.get("InvoiceTotal")
        if invoice_total:
            print(
                "Invoice Total: {} has confidence: {}".format(
                    invoice_total.value, invoice_total.confidence
                )
            )
        due_date = invoice.fields.get("DueDate")
        if due_date:
            print(
                "Due Date: {} has confidence: {}".format(
                    due_date.value, due_date.confidence
                )
            )
        purchase_order = invoice.fields.get("PurchaseOrder")
        if purchase_order:
            print(
                "Purchase Order: {} has confidence: {}".format(
                    purchase_order.value, purchase_order.confidence
                )
            )
        billing_address = invoice.fields.get("BillingAddress")
        if billing_address:
            print(
                "Billing Address: {} has confidence: {}".format(
                    billing_address.value, billing_address.confidence
                )
            )
        billing_address_recipient = invoice.fields.get("BillingAddressRecipient")
        if billing_address_recipient:
            print(
                "Billing Address Recipient: {} has confidence: {}".format(
                    billing_address_recipient.value,
                    billing_address_recipient.confidence,
                )
            )
        shipping_address = invoice.fields.get("ShippingAddress")
        if shipping_address:
            print(
                "Shipping Address: {} has confidence: {}".format(
                    shipping_address.value, shipping_address.confidence
                )
            )
        shipping_address_recipient = invoice.fields.get("ShippingAddressRecipient")
        if shipping_address_recipient:
            print(
                "Shipping Address Recipient: {} has confidence: {}".format(
                    shipping_address_recipient.value,
                    shipping_address_recipient.confidence,
                )
            )
        print("Invoice items:")
        for idx, item in enumerate(invoice.fields.get("Items").value):
            print("...Item #{}".format(idx + 1))
            item_description = item.value.get("Description")
            if item_description:
                print(
                    "......Description: {} has confidence: {}".format(
                        item_description.value, item_description.confidence
                    )
                )
            item_quantity = item.value.get("Quantity")
            if item_quantity:
                print(
                    "......Quantity: {} has confidence: {}".format(
                        item_quantity.value, item_quantity.confidence
                    )
                )
            unit = item.value.get("Unit")
            if unit:
                print(
                    "......Unit: {} has confidence: {}".format(
                        unit.value, unit.confidence
                    )
                )
            unit_price = item.value.get("UnitPrice")
            if unit_price:
                print(
                    "......Unit Price: {} has confidence: {}".format(
                        unit_price.value, unit_price.confidence
                    )
                )
            product_code = item.value.get("ProductCode")
            if product_code:
                print(
                    "......Product Code: {} has confidence: {}".format(
                        product_code.value, product_code.confidence
                    )
                )
            item_date = item.value.get("Date")
            if item_date:
                print(
                    "......Date: {} has confidence: {}".format(
                        item_date.value, item_date.confidence
                    )
                )
            tax = item.value.get("Tax")
            if tax:
                print(
                    "......Tax: {} has confidence: {}".format(tax.value, tax.confidence)
                )
            amount = item.value.get("Amount")
            if amount:
                print(
                    "......Amount: {} has confidence: {}".format(
                        amount.value, amount.confidence
                    )
                )
        subtotal = invoice.fields.get("SubTotal")
        if subtotal:
            print(
                "Subtotal: {} has confidence: {}".format(
                    subtotal.value, subtotal.confidence
                )
            )
        total_tax = invoice.fields.get("TotalTax")
        if total_tax:
            print(
                "Total Tax: {} has confidence: {}".format(
                    total_tax.value, total_tax.confidence
                )
            )
        previous_unpaid_balance = invoice.fields.get("PreviousUnpaidBalance")
        if previous_unpaid_balance:
            print(
                "Previous Unpaid Balance: {} has confidence: {}".format(
                    previous_unpaid_balance.value, previous_unpaid_balance.confidence
                )
            )
        amount_due = invoice.fields.get("AmountDue")
        if amount_due:
            print(
                "Amount Due: {} has confidence: {}".format(
                    amount_due.value, amount_due.confidence
                )
            )
        service_start_date = invoice.fields.get("ServiceStartDate")
        if service_start_date:
            print(
                "Service Start Date: {} has confidence: {}".format(
                    service_start_date.value, service_start_date.confidence
                )
            )
        service_end_date = invoice.fields.get("ServiceEndDate")
        if service_end_date:
            print(
                "Service End Date: {} has confidence: {}".format(
                    service_end_date.value, service_end_date.confidence
                )
            )
        service_address = invoice.fields.get("ServiceAddress")
        if service_address:
            print(
                "Service Address: {} has confidence: {}".format(
                    service_address.value, service_address.confidence
                )
            )
        service_address_recipient = invoice.fields.get("ServiceAddressRecipient")
        if service_address_recipient:
            print(
                "Service Address Recipient: {} has confidence: {}".format(
                    service_address_recipient.value,
                    service_address_recipient.confidence,
                )
            )
        remittance_address = invoice.fields.get("RemittanceAddress")
        if remittance_address:
            print(
                "Remittance Address: {} has confidence: {}".format(
                    remittance_address.value, remittance_address.confidence
                )
            )
        remittance_address_recipient = invoice.fields.get("RemittanceAddressRecipient")
        if remittance_address_recipient:
            print(
                "Remittance Address Recipient: {} has confidence: {}".format(
                    remittance_address_recipient.value,
                    remittance_address_recipient.confidence,
                )
            )

        print("----------------------------------------")

if __name__ == "__main__":
    analyze_invoice()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de fatura.

Usar o modelo de recibo

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

def analyze_receipts():
    # sample document
    receiptUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png"

   client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )
    poller = client.begin_analyze_document(
        "prebuilt-receipt", receiptUrl, locale="en-US"
    )
    receipts = poller.result()
    for idx, receipt in enumerate(receipts.documents):
         print("--------Analysis of receipt #{}--------".format(idx   1))
        print("Receipt type: {}".format(receipt.doc_type or "N/A"))
        merchant_name = receipt.fields.get("MerchantName")
        if merchant_name:
            print(
                "Merchant Name: {} has confidence: {}".format(
                    merchant_name.value, merchant_name.confidence
                )
            )
        transaction_date = receipt.fields.get("TransactionDate")
        if transaction_date:
            print(
                "Transaction Date: {} has confidence: {}".format(
                    transaction_date.value, transaction_date.confidence
                )
            )
        if receipt.fields.get("Items"):
            print("Receipt items:")
            for idx, item in enumerate(receipt.fields.get("Items").value):
                 print("...Item #{}".format(idx   1))
                item_description = item.value.get("Description")
                if item_description:
                    print(
                        "......Item Description: {} has confidence: {}".format(
                            item_description.value, item_description.confidence
                        )
                    )
                item_quantity = item.value.get("Quantity")
                if item_quantity:
                    print(
                        "......Item Quantity: {} has confidence: {}".format(
                            item_quantity.value, item_quantity.confidence
                        )
                    )
                item_price = item.value.get("Price")
                if item_price:
                    print(
                        "......Individual Item Price: {} has confidence: {}".format(
                            item_price.value, item_price.confidence
                        )
                    )
                item_total_price = item.value.get("TotalPrice")
                if item_total_price:
                    print(
                        "......Total Item Price: {} has confidence: {}".format(
                            item_total_price.value, item_total_price.confidence
                        )
                    )
        subtotal = receipt.fields.get("Subtotal")
        if subtotal:
            print(
                "Subtotal: {} has confidence: {}".format(
                    subtotal.value, subtotal.confidence
                )
            )
        tax = receipt.fields.get("TotalTax")
        if tax:
            print("Total tax: {} has confidence: {}".format(tax.value, tax.confidence))
        tip = receipt.fields.get("Tip")
        if tip:
            print("Tip: {} has confidence: {}".format(tip.value, tip.confidence))
        total = receipt.fields.get("Total")
        if total:
            print("Total: {} has confidence: {}".format(total.value, total.confidence))
        print("--------------------------------------")


if __name__ == "__main__":
    analyze_receipts()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de recibo.

Usar o modelo de documento de identificação

import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.ai.documentintelligence.models import AnalyzeResult

# use your `key` and `endpoint` environment variables
key = os.environ.get('DI_KEY')
endpoint = os.environ.get('DI_ENDPOINT')

def analyze_identity_documents():
# sample document
    identityUrl = "https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png"

   client = DocumentIntelligenceClient(
        endpoint=endpoint, credential=AzureKeyCredential(key)
    )

    poller =client.begin_analyze_document(
            "prebuilt-idDocument", identityUrl
        )
    id_documents = poller.result()

    for idx, id_document in enumerate(id_documents.documents):
        print("--------Analyzing ID document #{}--------".format(idx + 1))
        first_name = id_document.fields.get("FirstName")
        if first_name:
            print(
                "First Name: {} has confidence: {}".format(
                    first_name.value, first_name.confidence
                )
            )
        last_name = id_document.fields.get("LastName")
        if last_name:
            print(
                "Last Name: {} has confidence: {}".format(
                    last_name.value, last_name.confidence
                )
            )
        document_number = id_document.fields.get("DocumentNumber")
        if document_number:
            print(
                "Document Number: {} has confidence: {}".format(
                    document_number.value, document_number.confidence
                )
            )
        dob = id_document.fields.get("DateOfBirth")
        if dob:
            print(
                "Date of Birth: {} has confidence: {}".format(dob.value, dob.confidence)
            )
        doe = id_document.fields.get("DateOfExpiration")
        if doe:
            print(
                "Date of Expiration: {} has confidence: {}".format(
                    doe.value, doe.confidence
                )
            )
        sex = id_document.fields.get("Sex")
        if sex:
            print("Sex: {} has confidence: {}".format(sex.value, sex.confidence))
        address = id_document.fields.get("Address")
        if address:
            print(
                "Address: {} has confidence: {}".format(
                    address.value, address.confidence
                )
            )
        country_region = id_document.fields.get("CountryRegion")
        if country_region:
            print(
                "Country/Region: {} has confidence: {}".format(
                    country_region.value, country_region.confidence
                )
            )
        region = id_document.fields.get("Region")
        if region:
            print(
                "Region: {} has confidence: {}".format(region.value, region.confidence)
            )

        print("--------------------------------------")

if __name__ == "__main__":
    analyze_identity_documents()

Visite o repositório de exemplos do Azure no GitHub e exiba a saída do modelo de documento de ID.

Nota

Este projeto usa a ferramenta de linha de comando cURL para executar chamadas de API REST.

| SDKs do Azure suportados pela API | REST do Document Intelligence

Pré-requisitos

• Uma assinatura do Azure - Crie uma gratuitamente.

• A ferramenta de linha de comando cURL instalada. O Windows 10 e o Windows 11 são fornecidos com uma cópia do cURL. Em um prompt de comando, digite o seguinte comando cURL. Se as opções de ajuda forem exibidas, o cURL será instalado em seu ambiente Windows.

  curl -help
  

  Se o cURL não estiver instalado, você pode obtê-lo aqui:

  • Windows
  • Mac ou Linux

• Um recurso de serviços de IA do Azure ou Document Intelligence. Crie um serviço único ou multisserviço. Você pode usar o nível de preço gratuito (F0) para experimentar o serviço e atualizar posteriormente para um nível pago para produção.

• A chave e o ponto de extremidade do recurso que você cria para conectar seu aplicativo ao serviço de Inteligência de Documentos do Azure.

  1. Depois que o recurso for implantado, selecione Ir para o recurso.
  2. No menu de navegação esquerdo, selecione Teclas e Ponto de extremidade.
  3. Copie uma das chaves e o Endpoint para uso mais adiante neste artigo.

  

Definir as variáveis de ambiente

Para interagir com o serviço de Inteligência de Documentos, você precisa criar uma instância da DocumentAnalysisClient classe. Para fazer isso, instancie o cliente com o seu key e endpoint do portal do Azure. Para este projeto, use variáveis de ambiente para armazenar e acessar credenciais.

Importante

Não inclua a sua chave diretamente no código e nunca a publique publicamente. Para produção, use uma maneira segura de armazenar e acessar suas credenciais, como o Azure Key Vault. Para obter mais informações, consulte Segurança dos serviços de IA do Azure.

Para definir a variável de ambiente para a chave de recurso do Document Intelligence, abra uma janela do console e siga as instruções para o sistema operacional e o ambiente de desenvolvimento. Substitua <yourKey> e <yourEndpoint> pelos valores do seu recurso no portal do Azure.

Windows

As variáveis de ambiente no Windows não diferenciam maiúsculas de minúsculas. Eles são normalmente declarados em maiúsculas, com palavras unidas por um sublinhado. Em um prompt de comando, execute os seguintes comandos:

1. Defina a sua variável chave:

   setx DI_KEY <yourKey>
   

2. Definir sua variável de ponto de extremidade

   setx DI_ENDPOINT <yourEndpoint>
   

3. Feche a janela do prompt de comando depois de definir as variáveis de ambiente. Os valores permanecem até que você os altere novamente.

4. Reinicie todos os programas em execução que lerem a variável de ambiente. Por exemplo, se você estiver usando o Visual Studio ou Visual Studio Code como seu editor, reinicie antes de executar o código de exemplo.

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
setx VARIABLE_NAME=	Exclua a variável de ambiente definindo o valor como uma cadeia de caracteres vazia.	setx DI_KEY=
setx VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente.	setx DI_KEY=<yourKey>
set VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica.	set DI_KEY
set	Exiba todas as variáveis de ambiente.	set

macOS

As variáveis de ambiente no macOS diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal. Abra o terminal e digite os seguintes comandos:

1. Defina a sua variável chave:

   export key=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export endpoint=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bash_profile :

1. Use um editor de texto para abrir o arquivo ~/.bash_profile e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export DI_KEY=<yourKey> DI_ENDPOINT=<yourEndpoint>
   

   Exemplo: export DI_KEY="<yourKey>"

2. Salve as alterações no arquivo bash_profile .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bash-profile
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY=<yourKey>
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente específica. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Linux

As variáveis de ambiente no Linux diferenciam maiúsculas de minúsculas. Convencionalmente, o nome da variável é declarado em letras maiúsculas.

O export comando define a variável e a exporta para o ambiente global, que está disponível para outros processos. No entanto, o valor é temporário e dura apenas até fechar a sessão do terminal:

1. Defina a sua variável chave:

   export DI_KEY=<yourKey>
   

2. Defina sua variável de ponto de extremidade:

   export DI_ENDPOINT=<yourEndpoint>
   

Para definir uma variável de ambiente permanentemente, coloque um comando export no script de inicialização do Bash ~/.bashrc :

1. Use um editor de texto para abrir o arquivo ~/.bashrc e adicione o seguinte comando para criar uma variável de ambiente permanente:

   export <VARIABLE>=<value>
   

   Exemplo: export DI_KEY=<yourKey>

2. Salve suas alterações no arquivo .bashrc .

3. Para tornar as alterações efetivas, execute o seguinte comando na janela do terminal:

   source ~/.bashrc
   

Aqui estão alguns comandos mais úteis para usar com variáveis de ambiente:

Comando	Ação	Exemplo
unset VARIABLE_NAME	Exclua uma variável de ambiente.	unset DI_KEY=
export VARIABLE_NAME=value	Defina ou altere o valor de uma variável de ambiente temporário.	export DI_KEY={yourKey}
printenv VARIABLE_NAME echo $VARIABLE_NAME	Exiba o valor de uma variável de ambiente. Com o echo comando, preceda a variável com $.	printenv DI_KEY echo $DI_KEY
printenv	Exiba todas as variáveis de ambiente.	printenv

Analise documentos e obtenha resultados

Uma solicitação POST é usada para analisar documentos com um modelo pré-construído ou personalizado. Uma solicitação GET é usada para recuperar o resultado de uma chamada de análise de documentos. O modelId é usado com operações POST e resultId GET.

Use a tabela a seguir como referência. Substitua <modelId> e <document-url> pelos valores desejados:

Modelo	modelId	descrição	documento-url
Ler modelo	leitura pré-embutida	Exemplo de brochura	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/read.png
Modelo de layout	layout pré-construído	Confirmação da reserva da amostra	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/layout.png
Modelo de formulário W-2	pré-construído-tax.us.w2	Exemplo de formulário W-2	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/w2.png
Modelo de fatura	fatura pré-embutida	Fatura de exemplo	https://github.com/Azure-Samples/cognitive-services-REST-api-samples/raw/master/curl/form-recognizer/rest-api/invoice.pdf
Modelo de recibo	recibo pré-embutido	Recibo de amostra	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/receipt.png
Modelo de documento de identificação	prebuilt-idDocument	Exemplo de documento de identificação	https://raw.githubusercontent.com/Azure-Samples/cognitive-services-REST-api-samples/master/curl/form-recognizer/rest-api/identity_documents.png

Pedido POST

Abra uma janela do console e execute o seguinte comando cURL. Os comandos incluem o ponto de extremidade e as principais variáveis de ambiente criadas anteriormente na seção definir variáveis de ambiente. Substitua essas variáveis se os nomes das variáveis forem diferentes. Lembre-se de substituir os parâmetros modelId> e <document-url>.<

curl -i -X POST "%DI_ENDPOINT%/documentintelligence/documentModels/{modelId}:analyze?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"

Para habilitar recursos de complemento, use o features parâmetro query na solicitação POST. Há quatro recursos adicionais disponíveis com o 2023-07-31 (GA) e versões posteriores: ocr.highResolution, ocr.formula, ocr.font e queryFields.premium. Para saber mais sobre cada um dos recursos, consulte Modelos personalizados.

Você só pode chamar os recursos highResolution, formula e font para o modelo Read and Layout e o recurso queryFields para o modelo General Documents. O exemplo a seguir mostra como chamar os recursos highResolution, fórmula e fonte para o modelo Layout.

curl -i -X POST "%DI_ENDPOINT%documentintelligence/documentModels/prebuilt-layout:analyze?features=ocr.highResolution,ocr.formula,ocr.font?api-version=2024-02-29-preview" -H "Content-Type: application/json" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" --data-ascii "{'urlSource': '<document-url>'}"

Resposta POST

Você recebe uma 202 (Success) resposta que inclui um Operation-location cabeçalho. Use o valor desse cabeçalho para recuperar os resultados da resposta.

Obter resultado da análise (Solicitação GET)

Depois de chamar a Analyze document API, chame a API [Get analyze result}(/rest/api/aiservices/document-models/get-analyze-result?view=rest-aiservices-2024-02-29-preview&preserve-view=true&tabs=HTTP) para obter o status da operação e os dados extraídos.

A ferramenta de linha de comando cURL não formata respostas de API que contenham conteúdo JSON, o que pode dificultar a leitura do conteúdo. Para formatar a resposta JSON, inclua o caractere de pipe seguido por uma ferramenta de formatação JSON com sua solicitação GET.

Windows

Use a ferramenta json NodeJS como um formatador JSON para cURL. Se não tiver Node.js instalado, transfira e instale a versão mais recente.

1. Abra uma janela do console e instale a ferramenta json usando o seguinte comando:

   npm install -g jsontool
   

2. Imprima a saída JSON incluindo o caractere | json pipe com suas solicitações GET.

   curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json
   

macOS

A ferramenta de comando json_pp vem com o macOS e pode ser usada como um formatador JSON para cURL.

• Imprima bastante a saída JSON incluindo | json_pp com suas solicitações GET.

  curl -i -X GET "{endpoint}documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
  

Linux

A ferramenta de linha de comando json_pp é pré-instalada na maioria das distribuições Linux. Se ele não estiver incluído, você pode usar o gerenciador de pacotes da sua distribuição para instalá-lo.

• Imprima bem a saída JSON inclusive | json_pp com suas GET solicitações.

  curl -i -X GET "<endpoint>documentintelligence/documentModels/prebuilt-read/analyzeResults/0e49604a-2d8e-4b15-b6b8-bb456e5d3e0a?api-version=2024-02-29-preview"-H "Ocp-Apim-Subscription-Key: <subscription key>" | json_pp
  

Pedido GET

Antes de executar o seguinte comando, faça estas alterações:

• Substitua <a Operation-location resposta> POST pelo cabeçalho da resposta POST.
• Substitua <DI_KEY pela variável para sua variável de ambiente se ela for diferente do nome no código.
• Substitua *<json-tool> pela sua ferramenta de formatação JSON.

curl -i -X GET "<POST response>" -H "Ocp-Apim-Subscription-Key: %DI_KEY%" | `<json-tool>`

Examinar a resposta

Você recebe uma 200 (Success) resposta com saída JSON. O primeiro campo, status, indica o status da operação. Se a operação não estiver concluída, o valor de status é running ou notStarted. Chame a API novamente, manualmente ou por meio de um script. Recomendamos um intervalo de um segundo ou mais entre as chamadas.

Visite o repositório de exemplos do Azure no GitHub para ver a GET resposta para cada um dos modelos de Document Intelligence:

Modelo	URL de saída
Ler modelo	Ler saída do modelo
Modelo de layout	Saída do modelo de layout
Modelo fiscal W-2	Saída do modelo fiscal W-2
Modelo de fatura	Saída do modelo de fatura
Modelo de recibo	Saída do modelo de recibo
Modelo de documento de identificação	Saída do modelo do documento de identificação

Próximos passos

Parabéns! Você aprendeu a usar modelos de Inteligência Documental para analisar vários documentos de maneiras diferentes. Em seguida, explore o Document Intelligence Studio e a documentação de referência.

Experimente o Document Intelligence StudioExplore a API REST do Document Intelligence