SDK target: REST API 2024-07-31-preview

dotnet add package Azure.AI.DocumentIntelligence --prerelease

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.3

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-ai-documentintelligence</artifactId>
    <version>1.0.0-beta.2</version>
  </dependency>

implementation("com.azure:azure-ai-documentintelligence:1.0.0-beta.4")

npm i @azure-rest/ai-document-intelligence version 1.0.0-beta.3

pip install azure-ai-documentintelligence==1.0.0b4

using Azure;
using Azure.AI.DocumentIntelligence;

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

import com.azure.core.credential.AzureKeyCredential;

const { AzureKeyCredential, DocumentIntelligence } = require("@azure-rest/[email protected]");

from azure.ai.documentintelligence import DocumentIntelligenceClient
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 `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));

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
    .credential(new AzureKeyCredential("<your-key>"))
    .endpoint("<your-endpoint>")
    .buildClient();

// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = DocumentIntelligence(process.env["your-endpoint>"], {
  key: process.env["<your-key>"],
});

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

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 DocumentIntelligenceClient instance including the DefaultAzureCredential:

   string endpoint = "<your-endpoint>";
   var client = new DocumentIntelligenceClient(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 DocumentIntelligenceClient instance and TokenCredential variable:

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

For more information, see Authentication.

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 DocumentIntelligenceClient instance including the DefaultAzureCredential:

   const { DocumentIntelligenceClient } = require("@azure-rest/[email protected]");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentIntelligenceClient("<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 DocumentIntelligenceClient instance including the DefaultAzureCredential:

   from azure.identity import DefaultAzureCredential
   from azure.ai.documentintelligence import DocumentIntelligenceClient
   
   credential = DefaultAzureCredential()
   client = DocumentIntelligenceClient(
       endpoint="<your-endpoint>",
       credential=credential
   )
   

For more information, see Authenticate the client.