Destinazione SDK: API REST 2022-08-31 v3.0

Document Intelligence checkmark REST API version 2022–08-31 v3.0

Importante

  • Document Intelligence REST API 2022-08-31 v3.0 raggiunge la fine del supporto il 30 marzo 2029.
  • Per evitare interruzioni di produzione, eseguire la migrazione a Azure Document Intelligence 2024-11-30 v4.0. Per altre informazioni, vedere Guida alla migrazione di Document Intelligence.

Azure Document Intelligence in Foundry Tools è un servizio cloud che usa l'apprendimento automatico per analizzare il testo e i dati strutturati dai documenti. Document Intelligence Software Development Kit (SDK) è un set di librerie e strumenti che consentono di integrare facilmente modelli e funzionalità di Document Intelligence nelle applicazioni. Document Intelligence SDK è disponibile su più piattaforme in C#/.NET, Java, JavaScript e linguaggi di programmazione Python.

Linguaggi di programmazione supportati

Document Intelligence SDK supporta i linguaggi e le piattaforme seguenti:

Lingua → Versione dell'SDK Document Intelligence Pacchetto Versione dell'API supportata Supporto della piattaforma
.NET/C# → 4.0.0 (GA) NuGet v3.0 Windows, macOS, Linux, Docker
Java → 4.0.6 (GA) Repository di Maven v3.0 Windows, macOS, Linux
JavaScript → 4.0.0 (GA) Npm v3.0 Browser, Windows, macOS, Linux
Python → 3.2.0 (GA) PyPI v3.0 Windows, macOS, Linux

Per altre informazioni su altre versioni dell'SDK, vedere:

Clienti supportati

Lingua Versione dell'SDK Versione dell'API Clienti supportati
.NET/C#
Java
JavaScript
4.0.0 (GA) v3.0:2022-08-31 (impostazione predefinita) DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C#
Java
JavaScript
3.1.x v2.1 (impostazione predefinita)
v2.0
FormRecognizerClient
FormTrainingClient
.NET/C#
Java
JavaScript
3.0.x v2.0 FormRecognizerClient
FormTrainingClient
Python 3.2.x (GA) v3.0:2022-08-31 (impostazione predefinita) DocumentAnalysisClient
DocumentModelAdministrationClient
Python 3.1.x v2.1 (impostazione predefinita)
v2.0
FormRecognizerClient
FormTrainingClient
Python 3.0.0 v2.0 FormRecognizerClient
FormTrainingClient

Usare Document Intelligence SDK nelle applicazioni

Document Intelligence SDK consente l'uso e la gestione del servizio Document Intelligence nell'applicazione. L'SDK si basa sull'API REST di Document Intelligence sottostante che consente di usare facilmente tali API all'interno del paradigma del linguaggio di programmazione. Ecco come usare Document Intelligence SDK per il linguaggio preferito:

1. Installare la libreria client SDK

dotnet add package Azure.AI.FormRecognizer --version 4.0.0
Install-Package Azure.AI.FormRecognizer -Version 4.0.0

2. Importare la libreria client SDK nell'applicazione

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

3. Configurare l'autenticazione

Esistono due metodi supportati per l'autenticazione:

Usare la chiave API

Ecco dove trovare la chiave API di Intelligence per documenti nel portale di Azure:

Screenshot della posizione di chiavi ed endpoint nel portale di Azure.

Importante

Si consiglia di utilizzare Microsoft Entra ID di autenticazione con identità gestite per le risorse di Azure per evitare di archiviare le credenziali con le applicazioni che girano nel cloud.

Se si usa una chiave API, archiviarla in modo sicuro in un'altra posizione, ad esempio in Azure Key Vault. Non includere la chiave API direttamente nel codice e non pubblicarla mai pubblicamente.

Per altre informazioni sulla sicurezza dei servizi di intelligenza artificiale, vedere Autorizzazione delle richieste a Servizi di Azure AI.


//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);

Utilizzare una credenziale del token Microsoft Entra

Nota

Gli endpoint a livello di area non supportano l'autenticazione Microsoft Entra. Creare un sottodominio personalizzato per la risorsa per usare questo tipo di autenticazione.

L'autorizzazione è più semplice usando .DefaultAzureCredential Fornisce una credenziale del token predefinita, basata sull'ambiente in esecuzione, in grado di gestire la maggior parte degli scenari di autenticazione Azure.

Ecco come acquisire e usare il DefaultAzureCredential per le applicazioni .NET:

  1. Installare la libreria Azure Identity per .NET:

        dotnet add package Azure.Identity
    
        Install-Package Azure.Identity
    
  2. Registrare un'applicazione di Microsoft Entra e creare una nuova entità servizio.

  3. Concedere l'accesso a Document Intelligence assegnando il ruolo Cognitive Services User all'entità servizio.

  4. Impostare i valori dell'ID client, dell'ID tenant e del segreto client nell'applicazione Microsoft Entra come variabili di ambiente: rispettivamente AZURE_CLIENT_ID, AZURE_TENANT_ID e AZURE_CLIENT_SECRET.

  5. Crea l'istanza DocumentAnalysisClient includendo il DefaultAzureCredential.

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

Per altre informazioni, seeAuthenticate the client.

4. Compilare l'applicazione

Creare un oggetto client per interagire con Document Intelligence SDK e quindi chiamare i metodi su tale oggetto client per interagire con il servizio. Gli SDK forniscono metodi sincroni e asincroni. Per altre informazioni dettagliate, provare una guida introduttiva in una lingua di propria scelta.

Opzioni di Supporto

Il forum Microsoft Q & A e Stack Overflow sono disponibili per la comunità degli sviluppatori per fare e rispondere a domande su Azure Document Intelligence e altri servizi. Microsoft monitora i forum e risponde alle domande che la community non ha ancora risposto. Per assicurarsi che venga visualizzata la domanda, contrassegnarla con azure-form-recognizer.

Passaggi successivi