Share via

Destino do SDK: REST API 2024-02-29-preview

  • Artigo

Importante

  • As versões de visualização pública do Document Intelligence fornecem acesso antecipado a recursos que estão em desenvolvimento ativo.
  • Recursos, abordagens e processos podem mudar, antes da Disponibilidade Geral (GA), com base nos comentários dos usuários.
  • A versão de visualização pública das bibliotecas de cliente do Document Intelligence usa como padrão a versão 2024-02-29-preview.
  • A versão de pré-visualização pública 2024-02-29-preview está atualmente disponível apenas nas seguintes regiões do Azure:
  • E.U.A. Leste
  • Oeste dos EUA2
  • Europa Ocidental

Marca de verificação do Document IntelligenceAPI REST versão 2024-02-29-preview

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# → 1.0.0-beta.2 (visualização) NuGet 2024-02-29 (pré-visualização) Windows, macOS, Linux, Docker
Java → 1.0.0-beta.2 (visualização) Repositório Maven 2024-02-29 (pré-visualização) Windows, macOS, Linux
JavaScript → 1.0.0-beta.2 (visualização) npm 2024-02-29 (pré-visualização) Navegador, Windows, macOS, Linux
Python → 1.0.0b2 (visualização) PyPI 2024-02-29 (pré-visualização) Windows, macOS, Linux

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

Clientes suportados

As tabelas a seguir apresentam a correlação entre cada versão do SDK e as versões de API suportadas do serviço Document Intelligence.

Idioma Alias do SDK Versão da API (padrão) Clientes suportados
.NET/C# 1.0.0-beta.2 (visualização) v4.0 (pré-visualização) 2024-02-29-pré-visualização 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

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

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

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

2. Importe a biblioteca de cliente SDK para seu aplicativo

using Azure;
using Azure.AI.DocumentIntelligence;

3. Configurar a autenticação

Há dois métodos suportados para autenticação:

Use sua chave de API

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

Captura de ecrã das chaves e da localização 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

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.

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 DocumentIntelligenceClient instância, incluindo o DefaultAzureCredential:

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

Para obter mais informações, consulteAutenticar 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 Microsoft Q&A fóruns 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 ter certeza, use as seguintes tags para que possamos ver sua pergunta.

  • Microsoft Q&A: Azure AI Document Intelligence.

  • Estouro de pilha: azure-ai-document-intelligence.

Próximos passos

Explore as operações REST API 2023-10-31-rest do Document Intelligence.