Destino do SDK: API REST v2.1 (GA)

REST API versão v2.1 (GA) 21-06-08

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# → 3.1.x (GA)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Repositório da Maven	v2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	v2.1	Browser, Windows, macOS, Linux
Python → 3.1.0 (GA)	PyPI	v2.1
Windows, macOS, Linux

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

• 2024-02-29 (versão prévia)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Clientes com suporte

Idioma	Versão do SDK	Versão da API	Clientes com suporte
.NET/C# Java JavaScript	3.1.x	v2.1 (padrão) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# Java JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (padrão) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.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

C# / .NET

dotnet add package Azure.AI.FormRecognizer --version 3.1.0

Install-Package Azure.AI.FormRecognizer -Version 3.1.0

Java

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>3.1.0</version>
</dependency>

implementation("com.azure:azure-ai-formrecognizer:3.1.0")

JavaScript

npm i @azure/ai-form-recognizer@3.1.0

Python

pip install azure-ai-formrecognizer==3.1.0

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

C# / .NET

using Azure;
using Azure.AI.FormRecognizer.Models;

Java

import com.azure.ai.formrecognizer.*;
import com.azure.ai.formrecognizer.models.*;

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { FormRecognizerClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");

Python

    from azure.ai.formrecognizer import FormRecognizerClient
    from azure.core.credentials import AzureKeyCredential

3. Configurar a autenticação

Há dois métodos com suporte para autenticação.

• Use uma chave de API da Informação de Documentos com a AzureKeyCredential do azure.core.credentials.

• Use uma credencial de token de azure-identity para autenticar com o Microsoft Entra ID.

Usar sua chave de API

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

Importante

Recomendamos a autenticação do Microsoft Entra ID com identidades gerenciadas para recursos do Azure a fim de evitar o armazenamento de credenciais com seus aplicativos executados na nuvem.

Se você usar uma chave de API, armazene-a com segurança em outro lugar, como no Azure Key Vault. Não inclua a chave da API diretamente no seu código e nunca a publique publicamente.

Para obter mais informações sobre a segurança dos serviços de IA, veja Autenticar solicitações para serviços de IA do Azure.

C# / .NET

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

Java

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("<your-key>"))
     .endpoint("<your-endpoint>")
     .buildClient();

JavaScript

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = new FormRecognizerClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));

Python

# create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
    form_recognizer_client = FormRecognizerClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-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.

C# / .NET

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 FormRecognizerClient, incluindo DefaultAzureCredential:

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

Para obter mais informações, veja Autenticar o cliente.

Java

Veja como adquirir e usar o DefaultAzureCredential para aplicativos Java:

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

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.5.3</version>
   </dependency>
   

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 do aplicativo Microsoft Entra como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_CLIENT_SECRET, respectivamente.

5. Crie sua instância FormRecognizerClient e TokenCredential variável:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

Para obter mais informações, veja Autenticar o cliente.

JavaScript

Veja como adquirir e usar o DefaultAzureCredential para aplicativos JavaScript:

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

   npm install @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 do aplicativo Microsoft Entra como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_CLIENT_SECRET, respectivamente.

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

   const { FormRecognizerClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new FormRecognizerClient("<your-endpoint>", new DefaultAzureCredential());
   

Para obter mais informações, veja Criar e autenticar um cliente.

Python

Veja como adquirir e usar o DefaultAzureCredential para aplicativos Python.

1. Instale a biblioteca de identidades do Azure para Python:

   pip install 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 do aplicativo Microsoft Entra como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_CLIENT_SECRET, respectivamente.

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

   from azure.identity import DefaultAzureCredential
   from azure.ai.formrecognizer import FormRecognizerClient
   
   credential = DefaultAzureCredential()
   form_recognizer_client = FormRecognizerClient(
       endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
       credential=credential
   )
   

Para obter mais informações, veja Autenticar 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 de que veremos a sua pergunta, marque-a com azure-form-recognizer.

Próximas etapas

Explorar a API REST da Informação de Documentos v2.1

Experimentar o Início rápido da Informação de Documentos