Condividi tramite

Destinazione SDK: API REST 31-07-2023 (disponibilità generale)

  • Articolo

Segno di spunta di Informazioni sui documenti Versione API REST 31-07-2023 (disponibilità generale)

Informazioni sui documenti di Azure AI è un servizio cloud che usa l'apprendimento automatico per analizzare testo e 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. L'SDK di Informazioni sui documenti è disponibile in diverse piattaforme nei linguaggi di programmazione C#/.NET, Java, JavaScript, e Python.

Linguaggi di programmazione supportati

L'SDK di Informazioni sui documenti supporta i linguaggi e le piattaforme seguenti:

Linguaggio → Versione SDK Informazioni sui documenti Pacchetto Versione API supportata Piattaforme supportate
.NET/C# → più recente (disponibilità generale) NuGet 31-07-2023 (disponibilità generale)
Java → più recente (disponibilità generale) Repository Maveny 31-07-2023 (disponibilità generale) Windows, macOS, Linux
JavaScript → più recente (disponibilità generale) npm 31-07-2023 (disponibilità generale) Browser, Windows, macOS, Linux
Python → più recente (disponibilità generale) PyPI 31-07-2023 (disponibilità generale) Windows, macOS, Linux

Per altre informazioni sulle altre versioni SDK, vedere:

Client supportati

Le tabelle seguenti presentano la correlazione tra ogni versione SDK e le versioni API supportate del servizio Informazioni sui documenti.

Lingua Versione dell'SDK Versione API (predefinita) Client supportati
.NET/C# 4.1.0 v3.1 più recente (disponibilità generale) 31-07-2023 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 v3.0 (disponibilità generale) 31-08-2022 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient
FormTrainingClient
.NET/C# 3.0.x v2.0 v2.0 FormRecognizerClient
FormTrainingClient

Usare l'SDK di Informazioni sui documenti nelle proprie applicazioni

L'SDK di Informazioni sui documento consente l'uso e la gestione del servizio di Informazioni sui documenti nella propria applicazione. L'SDK si basa sull'API REST di Informazioni sui documenti sottostante, che consente di usare facilmente tali API all'interno del paradigma del linguaggio di programmazione. Ecco come usare l'SDK di Informazioni sui documenti per il linguaggio preferito:

1. Installare la libreria client SDK

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

Install-Package Azure.AI.FormRecognizer -Version 4.1.0

2. Importare la libreria client SDK nell'applicazione

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

3. Configurare l'autenticazione

Per l'autenticazione sono supportati due metodi:

Usare la chiave API

Ecco dove trovare la chiave API di Informazioni sui documenti nel portale di Azure:

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

Importante

Si consiglia l'autenticazione di Microsoft Entra ID insieme alle identità gestite per le risorse di Azure al fine di evitare di archiviare le credenziali con le applicazioni eseguite 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 esporla mai pubblicamente.

Per altre informazioni sulla sicurezza dei servizi di intelligenza artificiale, vedere Autenticare le richieste in 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);

Usare credenziali token di Microsoft Entra

Nota

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

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

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

  1. Installare la libreria di identità di Azure per .NET:

        dotnet add package Azure.Identity

        Install-Package Azure.Identity

  2. Registrare un'applicazione Microsoft Entra e creare una nuova entità servizio.

  3. Concedere l'accesso a Informazioni sui documenti 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. Creare l'istanza di DocumentAnalysisClient includendo DefaultAzureCredential:

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

Per altre informazioni, vedere Autenticare il client.

4. Compilare l'applicazione

Creare un oggetto client per interagire con l'SDK di Informazioni sui documenti e quindi chiamare i metodi su tale oggetto client per interagire con il servizio. Gli SDK forniscono metodi sincroni e asincroni. Per altre informazioni, provare a eseguire una guida di avvio rapido relativa al linguaggio preferito.

Opzioni di assistenza

I forum Domande e risposte Microsoft e Stack Overflow sono a disposizione della community di sviluppatori per porre domande e rispondere a domande su Informazioni sui documenti di Azure AI e altri servizi. Microsoft monitora i forum e risponde alle domande a cui la community deve ancora rispondere. Per assicurarsi che venga visualizzata la domanda, contrassegnarla con azure-form-recognizer.

Passaggi successivi

Esplorare le operazioni API REST di Informazioni sui documenti 31-07-2023.