De Content Understanding-API gebruiken

De Content Understanding-API biedt een programmatische interface die u kunt gebruiken om analyses te maken, te beheren en te gebruiken.

Als u de API wilt gebruiken, verzendt uw clienttoepassing HTTP-aanroepen naar het eindpunt Content Understanding voor uw Microsoft Foundry-resource, waarbij een van de autorisatiesleutels in de header wordt doorgegeven. U kunt het eindpunt en de sleutels verkrijgen in Azure Portal of in de Microsoft Foundry-portal. U kunt ook de Microsoft Foundry-API gebruiken om programmatisch verbinding te maken met het project met uw Entra-id.

De API gebruiken om inhoud te analyseren

Een van de meest voorkomende toepassingen van de API is het verzenden van inhoud naar een bestaande analyse die u eerder hebt gemaakt en de resultaten van de analyse op te halen. De analyseaanvraag retourneert een waarde voor de bewerkings-id die een asynchrone taak vertegenwoordigt. Uw clienttoepassing moet vervolgens een andere aanvraag gebruiken om de bewerkings-id weer door te geven aan het eindpunt en de bewerkingsstatus op te halen, mogelijk meerdere keren polling totdat de bewerking is voltooid en de resultaten worden geretourneerd in JSON-indeling.

Als u bijvoorbeeld een document wilt analyseren, kan een clienttoepassing een POST-aanvraag indienen bij de analyze functie met de volgende JSON-hoofdtekst:

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

Ervan uitgaande dat de aanvraag is geverifieerd en gestart, is het antwoord vergelijkbaar met dit voorbeeld:

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

Uw clienttoepassing moet vervolgens de bewerkings-id gebruiken die is geretourneerd om de status van de bewerking te controleren totdat deze is geslaagd (of mislukt) door een GET-aanvraag in te dienen bij het analyzerResults eindpunt.

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

Wanneer de bewerking is voltooid, bevat het antwoord een JSON-nettolading die de resultaten van de analyse vertegenwoordigt. De specifieke resultaten zijn afhankelijk van de inhoud en het schema.