Destino del SDK: API de REST 31-07-2023 (GA)
API de REST versión 2023-07-31 (GA)
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# → más reciente (GA) | NuGet | 2023-07-31 (GA) | |
| Java → más reciente (GA) | Repositorio de Maven | 2023-07-31 (GA) | Windows, macOS, Linux |
| JavaScript → más reciente (GA) | npm | 2023-07-31 (GA) | Explorador web, Windows, macOS, Linux |
| Python → más reciente (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 más reciente (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 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
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:
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.
//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:
Instale la biblioteca de identidades de Azure para .NET:
dotnet add package Azure.IdentityInstall-Package Azure.IdentityRegistre una aplicación con Microsoft Entra y cree una nueva entidad de servicio.
Conceda acceso a Documento de inteligencia mediante la asignación del rol
Cognitive Services Usera su servicio principal.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_IDyAZURE_CLIENT_SECRET, respectivamente.Cree la
DocumentAnalysisClientinstancia, incluidoDefaultAzureCredential:string endpoint = "<your-endpoint>"; var client = new DocumentAnalysisClient(new Uri(endpoint), new DefaultAzureCredential());
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
Explore las operaciones API de REST de Documentos Inteligentes 2023-07-31.