Destino SDK: API REST v2.1 (GA)

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

O Azure AI Document Intelligence é um serviço de nuvem que usa aprendizado de máquina para analisar texto e dados estruturados de documentos. O Document Intelligence software development kit (SDK) é um conjunto de bibliotecas e ferramentas que permitem integrar facilmente modelos e recursos de Document Intelligence em seus aplicativos. O Document Intelligence SDK está disponível em plataformas nas linguagens de programação C#/.NET, Java, JavaScript e Python.

Linguagens de programação suportadas

O SDK do Document Intelligence suporta os seguintes idiomas e plataformas:

Versão do SDK de Language → Document Intelligence	Pacote	Versão da API suportada	Suporte da plataforma
.NET/C# → 3.1.x (GA)	NuGet	v2,1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Repositório Maven	v2,1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	v2,1	Navegador, 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 (pré-visualização)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Clientes suportados

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

Use o SDK de inteligência de documentos em seus aplicativos

O SDK de Inteligência Documental permite o uso e o gerenciamento do serviço de Inteligência Documental em seu aplicativo. O SDK se baseia na API REST subjacente do Document Intelligence, permitindo que você use facilmente essas APIs dentro do seu paradigma de linguagem de programação. Veja como você usa o SDK de Inteligência Documental para seu idioma preferido:

1. Instale a biblioteca de cliente 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. Importe a biblioteca de cliente 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 suportados para autenticação.

• Use uma chave de API de Document Intelligence com AzureKeyCredential de azure.core.credentials.

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

Use sua chave de API

Veja onde encontrar sua chave de API de Inteligência Documental no portal do Azure:

Importante

Recomendamos a autenticação do Microsoft Entra ID com identidades gerenciadas para recursos do Azure para 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 Cofre de Chaves do Azure. Não inclua a chave da API diretamente no seu código e nunca a publique publicamente.

Para obter mais informações sobre segurança de serviços de IA, consulte 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

Nota

Os pontos de extremidade regionais não oferecem suporte à autenticação do Microsoft Entra. Crie um subdomínio personalizado para seu 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 Microsoft Entra e crie uma nova entidade de serviço.

3. Conceda acesso ao Document Intelligence atribuindo a Cognitive Services User função à sua entidade de serviço.

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

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

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

Para obter mais informações, consulte 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 Microsoft Entra e crie uma nova entidade de serviço.

3. Conceda acesso ao Document Intelligence atribuindo a Cognitive Services User função à sua 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_IDe AZURE_CLIENT_SECRET, respectivamente.

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

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

Para obter mais informações, consulte 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 Microsoft Entra e crie uma nova entidade de serviço.

3. Conceda acesso ao Document Intelligence atribuindo a Cognitive Services User função à sua 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_IDe AZURE_CLIENT_SECRET, respectivamente.

5. Crie sua FormRecognizerClient instância, incluindo o 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, consulte Criar e autenticar um cliente.

Python

Veja como adquirir e usar o DefaultAzureCredential para aplicativos Python.

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

   pip install azure-identity
   

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

3. Conceda acesso ao Document Intelligence atribuindo a Cognitive Services User função à sua 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_IDe AZURE_CLIENT_SECRET, respectivamente.

5. Crie sua FormRecognizerClient instância, incluindo o 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, consulte Autenticar o cliente.

4. Crie a sua aplicação

Crie um objeto de cliente para interagir com o SDK do Document Intelligence 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, experimente 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 o Azure AI Document Intelligence e outros serviços. A Microsoft monitoriza os fóruns e responde a perguntas que a comunidade ainda não respondeu. Para se certificar de que vemos a sua pergunta, marque-a com azure-form-recognizer.

Próximos passos

Explore a API REST do Document Intelligence v2.1

Experimente um guia de início rápido do Document Intelligence