Använd Content Understanding API

Api:et content understanding tillhandahåller ett programmatiskt gränssnitt som du kan använda för att skapa, hantera och använda analysverktyg.

Om du vill använda API:et skickar din klientapplikation HTTP-anrop till slutpunkten för Content Understanding i din Microsoft Foundry-resurs och inkluderar en av auktoriseringsnycklarna i headern. Du kan hämta slutpunkten och nycklarna i Azure-portalen eller i Microsoft Foundry-portalen. Du kan också använda Microsoft Foundry API för att ansluta till projektet programmatiskt med ditt Entra-ID.

Använda API:et för att analysera innehåll

En av de vanligaste användningsområdena för API:et är att skicka innehåll till en befintlig analysator som du har skapat tidigare och hämta analysresultatet. Analysbegäran returnerar ett åtgärds-ID-värde som representerar en asynkron uppgift. Klientprogrammet måste sedan använda en annan begäran för att skicka tillbaka åtgärds-ID:t till slutpunkten och hämta åtgärdsstatusen – eventuellt avsökning flera gånger tills åtgärden har slutförts och resultatet returneras i JSON-format.

Om du till exempel vill analysera ett dokument kan ett klientprogram skicka en POST-begäran till analyze funktionen som innehåller följande JSON-brödtext:

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

Förutsatt att begäran autentiseras och initieras korrekt liknar svaret det här exemplet:

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

Klientprogrammet måste sedan använda åtgärds-ID:t som har returnerats för att kontrollera statusen för åtgärden tills den har lyckats (eller misslyckats) genom att skicka en GET-begäran till analyzerResults slutpunkten.

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

När åtgärden har slutförts innehåller svaret en JSON-nyttolast som representerar resultatet av analysen. De specifika resultaten beror på innehållet och schemat.