Uso de Content Understanding API
Content Understanding API proporciona una interfaz de programación que puede usar para crear, administrar y consumir analizadores.
Para usar la API, la aplicación cliente envía llamadas HTTP al punto de conexión de Content Understanding para el recurso de Microsoft Foundry, pasando una de las claves de autorización en el encabezado. Puede obtener el punto de conexión y las claves en Azure Portal o en el portal de Microsoft Foundry. También puede usar la API de Microsoft Foundry para conectarse al proyecto programáticamente con su ID de Entra.
Uso de la API para analizar contenido
Uno de los usos más comunes de la API es enviar contenido a un analizador existente que ha creado previamente y recuperar los resultados del análisis. La solicitud de análisis devuelve un valor de identificador de operación que representa una tarea asincrónica. Después, la aplicación cliente debe usar otra solicitud para volver a pasar el identificador de operación al punto de conexión y recuperar el estado de la operación, posiblemente sondeando varias veces hasta que se complete la operación y los resultados se devuelvan en formato JSON.
Por ejemplo, para analizar un documento, una aplicación cliente podría enviar una solicitud POST a la analyze función que contiene el siguiente cuerpo JSON:
POST {endpoint}/contentunderstanding/analyzers/{analyzer}:analyze?api-version=2025-11-01
{
"inputs": [
{
"url": "https://host.com/doc.pdf"
}
]
}
Nota:
Puede especificar una dirección URL para la ubicación del archivo de contenido como se muestra aquí. Para enviar datos de archivos binarios directamente, use la analyzeBinary operación en su lugar.
Suponiendo que la solicitud se autentique e inicie correctamente, la respuesta será similar a este ejemplo:
Operation-Id: 1234abcd-1234-abcd-1234-abcd1234abcd
Operation-Location: {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01
{
"id": "1234abcd-1234-abcd-1234-abcd1234abcd",
"status": "NotStarted"
}
A continuación, la aplicación cliente debe usar el identificador de operación que se ha devuelto para comprobar el estado de la operación hasta que se haya realizado correctamente (o no) enviando una solicitud GET al analyzerResults punto de conexión.
GET {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01
Cuando la operación se haya completado correctamente, la respuesta contiene una carga JSON que representa los resultados del análisis. Los resultados específicos dependen del contenido y el esquema.
Nota:
Para obtener más información sobre Content Understanding API, consulte la documentación de referencia.