Destino del SDK: API REST v2.1 (GA)

versión 2.1 de la API de REST 21-06-08

Documento de inteligencia de Azure AI es un servicio en la nube que usa el aprendizaje automático para analizar texto y datos estructurados de los documentos. El kit de desarrollo de software (SDK) de Documento de inteligencia es un conjunto de bibliotecas y herramientas que le permiten integrar fácilmente en sus aplicaciones los modelos y las funcionalidades de Documento de inteligencia en sus aplicaciones. La SDK de Documento de inteligencia está disponible en plataformas con los lenguajes de programación C#/.NET, Java, JavaScript y Python.

Lenguajes de programación admitidos

El SDK de Documento de inteligencia admite los siguientes lenguajes y plataformas:

Lenguaje → Versión del SDK de Documento de inteligencia	Paquete	Versión de API compatible	Compatibilidad con plataformas
.NET/C# → 3.1.x (GA)	NuGet	v2.1	Windows, macOS, Linux, Docker
Java → 3.1.x (GA)	Repositorio de Maven	v2.1	Windows, macOS, Linux
JavaScript → 3.1.0 (GA)	npm	v2.1	Explorador web, Windows, macOS, Linux
Python → 3.1.0 (GA)	PyPI	v2.1
Windows, macOS, Linux

Para obtener más información sobre otras versiones del SDK, consulte:

• 2024-02-29(versión preliminar)
• 2023-07-31v3.1 (GA)
• 2022-08-31v3.0 (GA)

Clientes compatibles

Lenguaje	Versión del SDK	Versión de API	Clientes compatibles
.NET/C# Java JavaScript	3.1.x	v2.1 (predeterminado) v2.0	FormRecognizerClient FormTrainingClient
.NET/C# Java JavaScript	3.0.x	v2.0	FormRecognizerClient FormTrainingClient
Python	3.1.x	v2.1 (predeterminado) v2.0	FormRecognizerClient FormTrainingClient
Python	3.0.0	v2.0	FormRecognizerClient FormTrainingClient

Use el SDK de Documento de inteligencia en sus aplicaciones

El SDK de Documento de inteligencia permite el uso y la administración del servicio Documento de inteligencia en su aplicación. El SDK se basa en la API de REST subyacente de Documento de inteligencia, lo que le permite usar fácilmente esas API dentro del paradigma de su lenguaje de programación. A continuación le explicamos cómo usar el SDK de Documento de inteligencia para su idioma preferido:

1. Instale la biblioteca cliente de SDK

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. Importe la biblioteca cliente del SDK en la aplicación

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. Configure la autenticación

Hay dos métodos admitidos para la autenticación.

• Use una Clave de API de Documento de inteligencia con AzureKeyCredential de azure.core.credentials.

• Use una credencial de token de azure-identity para autenticarse con Microsoft Entra ID.

Usar la clave de API

Aquí puede encontrar su clave API de Documento de inteligencia en Azure Portal:

Importante

Se recomienda la autenticación de Microsoft Entra ID con identidades administradas para los recursos de Azure para evitar almacenar credenciales con sus aplicaciones que se ejecutan en la nube.

Si usa una clave de API, almacénela de forma segura en otro lugar, como en Azure Key Vault. No incluya la clave de API directamente en el código ni la exponga nunca públicamente.

Para más información acerca de la seguridad de los servicios de AI, consulte Autenticación de solicitudes a los servicios de Azure AI.

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

Uso de una credencial de token de Microsoft Entra

Nota:

Los puntos de conexión regionales no admiten la autenticación con Microsoft Entra. Cree un subdominio personalizado para el recurso con el fin de usar este tipo de autenticación.

La autorización es más fácil mediante DefaultAzureCredential. Proporciona una credencial de token predeterminada, basada en el entorno en ejecución, capaz de controlar la mayoría de los escenarios de autenticación de Azure.

C#/.NET

A continuación se muestra cómo adquirir y usar DefaultAzureCredential para aplicaciones .NET:

1. Instale la biblioteca de identidades de Azure para .NET:

       dotnet add package Azure.Identity
   

       Install-Package Azure.Identity
   

2. Registre una aplicación con Microsoft Entra y cree una nueva entidad de servicio.

3. Conceda acceso a Documento de inteligencia mediante la asignación del rol Cognitive Services User a su servicio principal.

4. Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente en la aplicación de Microsoft Entra como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_IDy AZURE_CLIENT_SECRET, respectivamente.

5. Cree la FormRecognizerClient instancia, incluido DefaultAzureCredential:

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

Para obtener más información, consulte Autenticar el cliente.

Java

A continuación se muestra cómo adquirir y usar DefaultAzureCredential para aplicaciones de Java:

1. Instale la biblioteca de identidades de Azure para Java:

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

2. Registre una aplicación con Microsoft Entra y cree una nueva entidad de servicio.

3. Conceda acceso a Documento de inteligencia mediante la asignación del rol Cognitive Services User a su servicio principal.

4. Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de Microsoft Entra como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_IDy AZURE_CLIENT_SECRET, respectivamente.

5. Cree la instancia FormRecognizerClient y la variable TokenCredential:

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

Para obtener más información, consulte Autenticar el cliente.

JavaScript

A continuación se muestra cómo adquirir y usar DefaultAzureCredential para aplicaciones de JavaScript:

1. Instale la biblioteca de identidades de Azure para JavaScript:

   npm install @azure/identity
   

2. Registre una aplicación con Microsoft Entra y cree una nueva entidad de servicio.

3. Conceda acceso a Documento de inteligencia mediante la asignación del rol Cognitive Services User a su servicio principal.

4. Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de Microsoft Entra como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_IDy AZURE_CLIENT_SECRET, respectivamente.

5. Cree la FormRecognizerClient instancia, incluido DefaultAzureCredential:

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

Para obtener más información, consulte Creación y autenticación de un cliente.

Python

A continuación se muestra cómo adquirir y usar DefaultAzureCredential para aplicaciones de Python.

1. Instale la biblioteca azure-identity para Python:

   pip install azure-identity
   

2. Registre una aplicación con Microsoft Entra y cree una nueva entidad de servicio.

3. Conceda acceso a Documento de inteligencia mediante la asignación del rol Cognitive Services User a su servicio principal.

4. Establezca los valores del identificador de cliente, el identificador de inquilino y el secreto de cliente de la aplicación de Microsoft Entra como variables de entorno: AZURE_CLIENT_ID, AZURE_TENANT_IDy AZURE_CLIENT_SECRET, respectivamente.

5. Cree la FormRecognizerClient instancia, incluido 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
   )
   

Para obtener más información, consulte Autenticar el cliente.

4. Compilación de la aplicación

Cree un objeto cliente para interactuar con el SDK de Documento de inteligencia y luego llame a los métodos de ese objeto cliente para interactuar con el servicio. Los SDK proporcionan métodos sincrónicos y asincrónicos. Para obtener más información, pruebe un inicio rápido en un idioma de su elección.

Opciones de ayuda

Los foros de Microsoft Q&A y Stack Overflow están disponibles para que la comunidad de desarrolladores haga y responda preguntas sobre Inteligencia de documentos de Azure AI y otros servicios. Microsoft supervisa los foros y responde a preguntas que la comunidad aún no ha respondido. Para asegurarse de que veamos su pregunta, etiquétela con azure-form-recognizer.

Pasos siguientes

Explorar la API REST de Document Intelligence v2.1

Pruebe la guía de inicio rápido de Documento de inteligencia