Destinazione SDK: API REST 2024-07-31-preview
Importante
- Le versioni di anteprima pubblica di Informazioni sui documenti consentono l'accesso anticipato alle funzionalità in fase di sviluppo attivo. Le funzionalità, gli approcci e i processi possono cambiare prima della disponibilità generale, a seconda del feedback degli utenti.
- Per impostazione predefinita, la versione di anteprima pubblica delle librerie client di Intelligence dei documenti è la versione dell'API REST 2024-07-31-preview.
- La versione di anteprima pubblica 2024-07-31-preview è al momento disponibile solo nelle aree di Azure seguenti. Si noti che il modello di generazione personalizzata (estrazione di campi di documento) in Studio AI è disponibile solo nell'area Stati Uniti centro-settentrionali:
- Stati Uniti orientali
- Stati Uniti occidentali 2
- Europa occidentale
- Stati Uniti centro-settentrionali
Versione API REST 2024-07-31-preview
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# → 1.0.0-beta.3 (anteprima) | NuGet | 2024-07-31 (anteprima) | Windows, macOS, Linux, Docker |
| Java → 1.0.0-beta.4 (anteprima) | Repository Maveny | 2024-07-31 (anteprima) | Windows, macOS, Linux |
| JavaScript → 1.0.0-beta.3 (anteprima) | npm | 2024-07-31 (anteprima) | Browser, Windows, macOS, Linux |
| Python → 1.0.0b4 (anteprima) | PyPI | 2024-07-31 (anteprima) | Windows, macOS, Linux |
Per altre informazioni sulle altre versioni SDK, vedere:
2023-07-31v3.1 (disponibilità generale)2022-08-31v3.0 (disponibilità generale)v2.1(disponibilità generale)
Client supportati
Le tabelle seguenti presentano la correlazione tra ogni versione SDK e le versioni API supportate del servizio Informazioni sui documenti.
| Lingua | Alias SDK | Versione API (predefinita) | Client supportati |
|---|---|---|---|
| .NET/C# 1.0.0-beta.2 (anteprima) | v4.0 (anteprima) | 2024-07-31-preview | DocumentIntelligenceClient DocumentIntelligenceAdministrationClient |
| .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.DocumentIntelligence --prerelease
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3
2. Importare la libreria client SDK nell'applicazione
using Azure;
using Azure.AI.DocumentIntelligence;
3. Configurare l'autenticazione
Per l'autenticazione sono supportati due metodi:
Usare una chiave API di Informazioni sui documenti con AzureKeyCredential da azure.core.credentials.
Usare una credenziale del token da azure-identity per eseguire l'autenticazione con Microsoft Entra ID.
Usare la chiave API
Ecco dove trovare la chiave API di Informazioni sui documenti 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 `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));
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:
Installare la libreria di identità di Azure per .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistrare un'applicazione Microsoft Entra e creare una nuova entità servizio.
Concedere l'accesso a Informazioni sui documenti assegnando il ruolo
Cognitive Services Userall'entità servizio.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_IDeAZURE_CLIENT_SECRET.Creare l'istanza di
DocumentIntelligenceClientincludendoDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentIntelligenceClient(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 Microsoft Q&A 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 avere la certezza che la domanda posta verrà visualizzata, usare i tag seguenti.
Microsoft Q&A:Azure AI Document Intelligence.Stack Overflow:
azure-ai-document-intelligence.
Passaggi successivi
Esplorare le operazioni API REST Informazioni sui documenti 2023-10-31-rest.