Utiliser l’API Content Understanding

Effectué

Tip

Pour plus d’informations, consultez l’onglet Texte et images !

L’API Content Understanding fournit une interface programmatique que vous pouvez utiliser pour créer, gérer et consommer des analyseurs.

Pour utiliser l’API, votre application cliente envoie des appels HTTP au point de terminaison Content Understanding pour votre ressource Microsoft Foundry, en passant l’une des clés d’autorisation dans l’en-tête. Vous pouvez obtenir le point de terminaison et les clés dans le portail Azure ou dans le portail Microsoft Foundry. Vous pouvez également utiliser l’API Microsoft Foundry pour vous connecter au projet par programmation avec l’ID Entra.

Utilisation de l’API pour analyser le contenu

L’une des utilisations les plus courantes de l’API consiste à envoyer du contenu à un analyseur existant que vous avez créé précédemment et à récupérer les résultats de l’analyse. La requête d’analyse retourne une valeur d’ID d’opération qui représente une tâche asynchrone. Votre application cliente doit ensuite utiliser une autre requête pour renvoyer l’ID d’opération au point de terminaison et récupérer l’état de l’opération - éventuellement interroger plusieurs fois jusqu’à ce que l’opération soit terminée et que les résultats soient retournés au format JSON.

Par exemple, pour analyser un document, une application cliente peut envoyer une requête POST à la analyze fonction contenant le corps JSON suivant :

POST {endpoint}/contentunderstanding/analyzers/{analyzer}:analyze?api-version=2025-11-01
{
  "inputs": [
    {
      "url": "https://host.com/doc.pdf"
    }
  ]
}

Remarque

Vous pouvez spécifier une URL pour l’emplacement du fichier de contenu, comme indiqué ici. Pour envoyer directement des données de fichier binaire, utilisez plutôt l’opération analyzeBinary .

Si l’authentification et le lancement de la requête réussissent, la réponse est similaire à celle présentée dans l’exemple suivant :

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

Votre application cliente doit ensuite utiliser l’ID d’opération retourné pour vérifier l’état de l’opération jusqu’à ce qu’elle ait réussi (ou échoué) en envoyant une demande GET au analyzerResults point de terminaison.

GET {endpoint}/contentunderstanding/analyzerResults/1234abcd-1234-abcd-1234-abcd1234abcd?api-version=2025-11-01

Une fois l’opération terminée, la réponse contient une charge utile JSON représentant les résultats de l’analyse. Les résultats spécifiques dépendent du contenu et du schéma.

Remarque

Pour plus d’informations sur l’API Content Understanding, consultez la documentation de référence.