SDK-mål: REST API v2.1 (GA)

REST API version v2.1 (GA) 21-06-08

Azure AI Document Intelligence är en molntjänst som använder maskininlärning för att analysera text och strukturerade data från dokument. SDK (Document Intelligence Software Development Kit) är en uppsättning bibliotek och verktyg som gör att du enkelt kan integrera modeller och funktioner för dokumentinformation i dina program. Document Intelligence SDK är tillgängligt på olika plattformar i programmeringsspråken C#/.NET, Java, JavaScript och Python.

Programmeringsspråk som stöds

Document Intelligence SDK stöder följande språk och plattformar:

Language → Document Intelligence SDK-version	Paket	API-version som stöds	Plattformssupport
.NET/C# → 3.1.x (GA)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Maven-lagringsplats	v2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	v2.1	Webbläsare, Windows, macOS, Linux
Python → 3.1.0 (GA)	PyPI	v2.1
Windows, macOS, Linux

Mer information om andra SDK-versioner finns i:

• 2024-02-29 (förhandsversion)
• 2023-07-31 v3.1 (GA)
• 2022-08-31 v3.0 (GA)

Klienter som stöds

Språk	SDK-version	API-version	Klienter som stöds
.NET/C# Java JavaScript	3.1.x	v2.1 (standard) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# Java JavaScript	3.0.x	V2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (standard) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	V2.0	FormRecognizerClient FormTrainingClient

Använda Document Intelligence SDK i dina program

Med Document Intelligence SDK kan du använda och hantera dokumentinformationstjänsten i ditt program. SDK bygger på det underliggande REST API:et för dokumentinformation så att du enkelt kan använda dessa API:er i ditt programmeringsspråkparadigm. Så här använder du Document Intelligence SDK för önskat språk:

1. Installera SDK-klientbiblioteket

C#/.NET

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

Install-Package Azure.AI.FormRecognizer -Version 3.1.0

Java

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>3.1.0</version>
</dependency>

implementation("com.azure:azure-ai-formrecognizer:3.1.0")

JavaScript

npm i @azure/ai-form-recognizer@3.1.0

Python

pip install azure-ai-formrecognizer==3.1.0

2. Importera SDK-klientbiblioteket till ditt program

C#/.NET

using Azure;
using Azure.AI.FormRecognizer.Models;

Java

import com.azure.ai.formrecognizer.*;
import com.azure.ai.formrecognizer.models.*;

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { FormRecognizerClient, AzureKeyCredential } = require("@azure/ai-form-recognizer");

Python

    from azure.ai.formrecognizer import FormRecognizerClient
    from azure.core.credentials import AzureKeyCredential

3. Konfigurera autentisering

Det finns två metoder som stöds för autentisering.

• Använd en API-nyckel för dokumentinformation med AzureKeyCredential från azure.core.credentials.

• Använd en tokenautentiseringsuppgift från azure-identity för att autentisera med Microsoft Entra-ID.

Använda din API-nyckel

Här hittar du din API-nyckel för dokumentinformation i Azure Portal:

Viktigt!

Vi rekommenderar Microsoft Entra-ID-autentisering med hanterade identiteter för Azure-resurser för att undvika att lagra autentiseringsuppgifter med dina program som körs i molnet.

Om du använder en API-nyckel lagrar du den på ett säkert sätt någon annanstans, till exempel i Azure Key Vault. Inkludera inte API-nyckeln direkt i koden och publicera den aldrig offentligt.

Mer information om säkerhet för AI-tjänster finns i Autentisera begäranden till Azure AI-tjänster.

C#/.NET

//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `FormRecognizerClient` instance
  string key = "<your-key>";
  string endpoint = "<your-endpoint>";
  FormRecognizerClient client = new FormRecognizerClient(new Uri(endpoint), new AzureKeyCredential(key));

Java

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
     .credential(new AzureKeyCredential("<your-key>"))
     .endpoint("<your-endpoint>")
     .buildClient();

JavaScript

// create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = new FormRecognizerClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));

Python

# create your `FormRecognizerClient` instance and `AzureKeyCredential` variable
    form_recognizer_client = FormRecognizerClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-key>"))

Använda en autentiseringsuppgift för Microsoft Entra-token

Kommentar

Regionala slutpunkter stöder inte Microsoft Entra-autentisering. Skapa en anpassad underdomän för resursen för att använda den här typen av autentisering.

Auktorisering är enklast med hjälp av DefaultAzureCredential. Den tillhandahåller en standardautentiseringsuppgift för token, baserat på den miljö som körs, som kan hantera de flesta Azure-autentiseringsscenarier.

C#/.NET

Så här hämtar och använder du DefaultAzureCredential för .NET-program:

1. Installera Azure Identity-biblioteket för .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Registrera ett Microsoft Entra-program och skapa ett nytt huvudnamn för tjänsten.

3. Bevilja åtkomst till dokumentinformation genom att Cognitive Services User tilldela rollen till tjänstens huvudnamn.

4. Ange värdena för klient-ID, klient-ID och klienthemlighet i Microsoft Entra-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_IDrespektive AZURE_CLIENT_SECRET.

5. Skapa din FormRecognizerClient instans, inklusive DefaultAzureCredential:

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

Mer information finns i Autentisera klienten.

Java

Så här hämtar och använder du DefaultAzureCredential för Java-program:

1. Installera Azure Identity-biblioteket för Java:

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.5.3</version>
   </dependency>
   

2. Registrera ett Microsoft Entra-program och skapa ett nytt huvudnamn för tjänsten.

3. Bevilja åtkomst till dokumentinformation genom att Cognitive Services User tilldela rollen till tjänstens huvudnamn.

4. Ange värdena för klient-ID, klient-ID och klienthemlighet för Microsoft Entra-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_IDrespektive AZURE_CLIENT_SECRET.

5. Skapa din FormRecognizerClient instans och TokenCredential variabel:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

Mer information finns i Autentisera klienten.

JavaScript

Så här hämtar och använder du DefaultAzureCredential för JavaScript-program:

1. Installera Azure Identity-biblioteket för JavaScript:

   npm install @azure/identity
   

2. Registrera ett Microsoft Entra-program och skapa ett nytt huvudnamn för tjänsten.

3. Bevilja åtkomst till dokumentinformation genom att Cognitive Services User tilldela rollen till tjänstens huvudnamn.

4. Ange värdena för klient-ID, klient-ID och klienthemlighet för Microsoft Entra-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_IDrespektive AZURE_CLIENT_SECRET.

5. Skapa din FormRecognizerClient instans, inklusive DefaultAzureCredential:

   const { FormRecognizerClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new FormRecognizerClient("<your-endpoint>", new DefaultAzureCredential());
   

Mer information finns i Skapa och autentisera en klient.

Python

Så här hämtar och använder du DefaultAzureCredential för Python-program.

1. Installera Azure Identity-biblioteket för Python:

   pip install azure-identity
   

2. Registrera ett Microsoft Entra-program och skapa ett nytt huvudnamn för tjänsten.

3. Bevilja åtkomst till dokumentinformation genom att Cognitive Services User tilldela rollen till tjänstens huvudnamn.

4. Ange värdena för klient-ID, klient-ID och klienthemlighet för Microsoft Entra-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_IDrespektive AZURE_CLIENT_SECRET.

5. Skapa din FormRecognizerClient instans, inklusive DefaultAzureCredential:

   from azure.identity import DefaultAzureCredential
   from azure.ai.formrecognizer import FormRecognizerClient
   
   credential = DefaultAzureCredential()
   form_recognizer_client = FormRecognizerClient(
       endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
       credential=credential
   )
   

Mer information finns i Autentisera klienten.

4. Skapa ditt program

Skapa ett klientobjekt för att interagera med Document Intelligence SDK och anropa sedan metoder på klientobjektet för att interagera med tjänsten. SDK:erna innehåller både synkrona och asynkrona metoder. Om du vill ha mer information kan du prova en snabbstart på ett valfritt språk.

Hjälpalternativ

Microsoft Q &A- och Stack Overflow-forumen är tillgängliga för utvecklarcommunityn för att ställa och svara på frågor om Azure AI Document Intelligence och andra tjänster. Microsoft övervakar forumen och svarar på frågor som communityn ännu inte har besvarat. Se till att du ser din fråga genom att tagga den med azure-form-recognizer.

Nästa steg

Utforska REST API för dokumentinformation v2.1

Prova en snabbstart för dokumentinformation