Destino del SDK: API de REST v3.1 (GA)

🟩 API REST versión 2023-07-31 (GA)

Azure Document Intelligence in Foundry Tools es un servicio en la nube que usa el aprendizaje automático para analizar texto y datos estructurados de documentos. El kit de desarrollo de software (SDK) de Document Intelligence es un conjunto de bibliotecas y herramientas que te permiten integrar fácilmente en tus aplicaciones los modelos y capacidades de Document Intelligence. El SDK de Document Intelligence está disponible para varias plataformas en los lenguajes de programación C#/.NET, Java, JavaScript y Python.

Lenguajes de programación admitidos

El SDK de Document Intelligence es compatible con los siguientes idiomas y plataformas:

Idioma → Versión del SDK de Document Intelligence Paquete Versión de API compatible Compatibilidad con plataformas
.NET/C# → latest (GA) NuGet 2023-07-31 (GA)
Java → latest (GA) Repositorio de Maven 2023-07-31 (GA) Windows, macOS, Linux
JavaScript → latest (GA) npm 2023-07-31 (GA) Explorador web, Windows, macOS, Linux
Python → latest (GA) PyPI 2023-07-31 (GA) Windows, macOS, Linux

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

Clientes compatibles

En las tablas siguientes se presenta la correlación entre cada versión del SDK, las versiones de API admitidas del servicio Document Intelligence.

Idioma Versión del SDK Versión de API (predeterminada) Clientes compatibles
.NET/C# 4.1.0 v3.1 última versión (GA) 2023-07-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 4.0.0 v3.0 (GA) 2022-08-31 DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient
FormTrainingClient
.NET/C# 3.0.x v2.0 v2.0 FormRecognizerClient
FormTrainingClient

Use el SDK de Document Intelligence en las aplicaciones

El SDK de Document Intelligence permite usar y administrar el servicio Document Intelligence en su aplicación. El SDK se basa en la API REST subyacente de Document Intelligence, lo que te permite usar fácilmente estas API en el paradigma de tu lenguaje de programación. A continuación se explica cómo usar el SDK de Document Intelligence en su idioma preferido:

1. Instale la biblioteca cliente de SDK

dotnet add package Azure.AI.FormRecognizer --version 4.1.0
Install-Package Azure.AI.FormRecognizer -Version 4.1.0

2. Importe la biblioteca cliente del SDK en la aplicación

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

3. Configure la autenticación

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

Usa tu clave de API

Aquí se indica dónde encontrar la clave de API de Document Intelligence en el portal de Azure:

Captura de pantalla de ubicación de las claves y el punto de conexión 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.


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

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.

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. Registrar una aplicación de Microsoft Entra y crear 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. Crea tu instancia de DocumentAnalysisClient, incluida DefaultAzureCredential:

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

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

4. Compilación de la aplicación

Cree un objeto de cliente para interactuar con el SDK de Document Intelligence y, a continuación, llame a los métodos de ese 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 preguntas y responda a preguntas sobre Azure Document Intelligence en Foundry Tools 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