SDK target: REST API v2.1 (GA)

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

Install-Package Azure.AI.FormRecognizer -Version 3.1.0

<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")

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

pip install azure-ai-formrecognizer==3.1.0

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

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

import com.azure.core.credential.AzureKeyCredential;

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

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

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

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

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

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

Here's how to acquire and use the DefaultAzureCredential for .NET applications:

1. Install the Azure Identity library for .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Register a Microsoft Entra application and create a new service principal.

3. Grant access to Document Intelligence by assigning the Cognitive Services User role to your service principal.

4. Set the values of the client ID, tenant ID, and client secret in the Microsoft Entra application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET, respectively.

5. Create your FormRecognizerClient instance including the DefaultAzureCredential:

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

For more information, see Authenticate the client.

Here's how to acquire and use the DefaultAzureCredential for Java applications:

1. Install the Azure Identity library for Java:

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

2. Register a Microsoft Entra application and create a new service principal.

3. Grant access to Document Intelligence by assigning the Cognitive Services User role to your service principal.

4. Set the values of the client ID, tenant ID, and client secret of the Microsoft Entra application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET, respectively.

5. Create your FormRecognizerClient instance and TokenCredential variable:

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

For more information, see Authenticate the client.

Here's how to acquire and use the DefaultAzureCredential for JavaScript applications:

1. Install the Azure Identity library for JavaScript:

   npm install @azure/identity
   

2. Register a Microsoft Entra application and create a new service principal.

3. Grant access to Document Intelligence by assigning the Cognitive Services User role to your service principal.

4. Set the values of the client ID, tenant ID, and client secret of the Microsoft Entra application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET, respectively.

5. Create your FormRecognizerClient instance including the DefaultAzureCredential:

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

For more information, see Create and authenticate a client.

Here's how to acquire and use the DefaultAzureCredential for Python applications.

1. Install the Azure Identity library for Python:

   pip install azure-identity
   

2. Register a Microsoft Entra application and create a new service principal.

3. Grant access to Document Intelligence by assigning the Cognitive Services User role to your service principal.

4. Set the values of the client ID, tenant ID, and client secret of the Microsoft Entra application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET, respectively.

5. Create your FormRecognizerClient instance including the 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.cn/",
       credential=credential
   )
   

For more information, see Authenticate the client.