Destino do SDK: versão prévia 2024-02-29 da API REST

  • Artigo

Importante

  • As versões preliminares públicas da Informação de Documentos oferecem acesso antecipado a recursos que estão em desenvolvimento ativo.
  • Recursos, abordagens e processos podem ser alterados, antes da Disponibilidade Geral (GA), com base nos comentários do usuário.
  • A versão prévia pública das bibliotecas de clientes da Informação de Documentos usa como padrão a versão da API REST 2024-02-29-preview.
  • Atualmente, a versão prévia pública 2024-02-29-preview só está disponível nas seguintes regiões do Azure:
  • Leste dos EUA
  • Oeste dos EUA 2
  • Oeste da Europa

a marca de verificação da Informação de DocumentosAPI REST versão prévia 29-02-2024

A IA do Azure para Informação de Documentos é um serviço de nuvem que usa machine learning para extrair e analisar campos de formulário, texto e tabelas dos documentos. O SDK (kit de desenvolvimento de software) de Informação de Documentos é um conjunto de bibliotecas e ferramentas que permite integrar facilmente os recursos da Informação de Documentos em seus aplicativos. O SDK da Informação de Documentos está disponível em plataformas nas linguagens de programação C#/.NET, Java, JavaScript e Python.

Linguagens de programação compatíveis

O SDK da Informação de Documentos dá suporte aos seguintes idiomas e plataformas:

Linguagem → Versão do SDK da Informação de Documentos Pacote Versão da API compatível Suporte a plataforma
.NET/C# → 1.0.0-beta.2 (versão prévia) NuGet 2024-02-29 (preview) Windows, macOS, Linux, Docker
Java → 1.0.0-beta.2 (versão prévia) Repositório da Maven 2024-02-29 (preview) Windows, macOS, Linux
JavaScript → 1.0.0-beta.2 (versão prévia) npm 2024-02-29 (preview) Browser, Windows, macOS, Linux
Python → 1.0.0b2 (versão prévia) PyPI 2024-02-29 (preview) Windows, macOS, Linux

Para obter mais informações sobre outras versões do SDK, consulte:

Clientes com suporte

As tabelas a seguir apresentam a correlação entre cada versão do SDK as versões de API com suporte do serviço de Informação de Documentos.

Idioma Alias de SDK Versão da API (padrão) Clientes com suporte
.NET/C# 1.0.0-beta.2 (versão prévia) v4.0 (versão prévia) 2024-02-29-preview DocumentIntelligenceClient
DocumentIntelligenceAdministrationClient
.NET/C# 4.1.0 V3.1 mais recente (GA) 2023-07-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 v3.0 (GA) 2022-08-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient
FormTrainingClient
.NET/C# 3.0.x v2.0 v2.0 FormRecognizerClient
FormTrainingClient

Usar o SDK da Informação de Documentos em seus aplicativos

O SDK da Informação de Documentos permite o uso e o gerenciamento do serviço de Informação de Documentos em seu aplicativo. O SDK baseia-se na API REST da Informação de Documentos subjacente, permitindo que você use facilmente essas APIs dentro do paradigma da linguagem de programação. Veja como usar o SDK da Informação de Documentos para seu idioma preferido:

1. Instalar a biblioteca de clientes do SDK

dotnet add package Azure.AI.DocumentIntelligence --version 1.0.0-beta.2

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.2

2. Importar a biblioteca de clientes do SDK para seu aplicativo

using Azure;
using Azure.AI.DocumentIntelligence;

3. Configurar a autenticação

Há dois métodos compatíveis para autenticação:

Usar sua chave de API

Aqui está onde encontrar sua chave de API da Informação de Documentos no portal do Azure:

Captura de tela da localização das chaves e do ponto de extremidade no portal do Azure. 


//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentIntelligenceClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentIntelligenceClient client = new DocumentIntelligenceClient(new Uri(endpoint), new AzureKeyCredential(key));

Usar uma credencial de token do Microsoft Entra

Observação

Os pontos de extremidade regionais não dão suporte à autenticação do Microsoft Entra. Crie um subdomínio personalizado para o recurso para usar esse tipo de autenticação.

A autorização é mais fácil usando o DefaultAzureCredential. Ele fornece uma credencial de token padrão, com base no ambiente em execução, capaz de lidar com a maioria dos cenários de autenticação do Azure.

Veja como adquirir e usar o DefaultAzureCredential para aplicativos .NET:

  1. Instale a Biblioteca de identidades do Azure para .NET:

        dotnet add package Azure.Identity

        Install-Package Azure.Identity

  2. Registre um aplicativo do Microsoft Entra e crie uma nova entidade de serviço.

  3. Conceda acesso à Informação de Documentos atribuindo a função Cognitive Services User à entidade de serviço.

  4. Defina os valores de ID do cliente, ID do locatário e segredo do cliente no aplicativo do Microsoft Entra como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_CLIENT_SECRET, respectivamente.

  5. Crie sua instância DocumentIntelligenceClient, incluindo DefaultAzureCredential:

    string endpoint = "<your-endpoint>";
var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());

Para obter mais informações, consulteAutenticar o cliente.

4. Crie seu aplicativo

Criar um objeto de cliente para interagir com o SDK da Informação de Documentos e, em seguida, chame métodos nesse objeto de cliente para interagir com o serviço. Os SDKs fornecem métodos síncronos e assíncronos. Para obter mais informações, tente um início rápido em um idioma de sua escolha.

Opções de ajuda

Os fóruns Microsoft Q&A e Stack Overflow estão disponíveis para a comunidade de desenvolvedores fazer e responder perguntas sobre a IA do Azure para Informação de Documentos e outros serviços. A Microsoft monitora os fóruns e responde a perguntas que a comunidade ainda não respondeu. Para ter certeza, use as marcas a seguir para que vejamos sua pergunta.

  • Microsoft Q&A: Azure AI Document Intelligence.

  • Stack Overflow: azure-ai-document-intelligence.

Próximas etapas

Explore as operações da API REST da Informação de Documentos 2023-10-31-rest.