Destino do SDK: API REST 2023-07-31 (GA)
API REST versão 2023-07-31 (GA)
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# → mais recente (GA) | NuGet | 31-07-2023 (GA) | |
| Java → mais recente (GA) | Repositório da Maven | 31-07-2023 (GA) | Windows, macOS, Linux |
| JavaScript → mais recente (GA) | npm | 31-07-2023 (GA) | Browser, Windows, macOS, Linux |
| Python → mais recente (GA) | PyPI | 31-07-2023 (GA) | 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 | Versão do SDK | Versão da API (padrão) | Clientes com suporte |
|---|---|---|---|
| .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.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0
2. Importar a biblioteca de clientes do SDK para seu aplicativo
using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;
3. Configurar a autenticação
Há dois métodos compatíveis 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.
//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentAnalysisClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentAnalysisClient client = new DocumentAnalysisClient(new Uri(endpoint), credential);
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:
Instale a Biblioteca de identidades do Azure para .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistre um aplicativo do Microsoft Entra e crie uma nova entidade de serviço.
Conceda acesso à Informação de Documentos atribuindo a função
Cognitive Services Userà entidade de serviço.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_IDeAZURE_CLIENT_SECRET, respectivamente.Crie sua instância
DocumentAnalysisClient, incluindoDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
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
Explore as operações da API REST da Informação de Documentos 2023-07-31.