Bruk Content Understanding API-et

Fullført

Content Understanding API tilbyr et programmatisk grensesnitt som du kan bruke for å lage, administrere og konsumere analysatorer.

For å bruke API-et sender klientapplikasjonen HTTP-kall til Content Understanding-endepunktet for Microsoft Foundry-ressursen din, og sender en av autorisasjonsnøklene i headeren. Du kan hente endepunktet og nøklene i Azure-portalen eller i Microsoft Foundry-portalen. Du kan også bruke Microsoft Foundry API for å koble til prosjektet programmessig med din Entra-ID.

Bruk av API-et for å analysere innhold

En av de vanligste bruksområdene for API-et er å sende innhold til en eksisterende analysator du tidligere har bygget, og hente resultatene av analysen. Analyseforespørselen returnerer en operasjons-ID-verdi som representerer en asynkron oppgave. Klientprogrammet må deretter bruke en annen forespørsel til å sende operasjons-ID-en tilbake til endepunktet og hente operasjonsstatusen – potensielt avspørring flere ganger til operasjonen er fullført, og resultatene returneres i JSON-format.

Hvis du for eksempel vil analysere et dokument, kan et klientprogram sende en POST-forespørsel til analyze funksjonen som inneholder følgende JSON-brødtekst:

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

Notat

Du kan angi en URL for innholdsfilens plassering som vist her. For å sende inn binærfildata direkte, bruk operasjonen analyzeBinary i stedet.

Forutsatt at forespørselen er godkjent og startet, vil svaret være likt dette eksemplet:

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

Klientapplikasjonen din må deretter bruke operasjons-ID-en som er returnert for å sjekke statusen på operasjonen til den har lykkes (eller feilet) ved å sende en GET-forespørsel til analyzerResults endepunktet.

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

Når operasjonen er fullført, inneholder svaret en JSON-nyttelast som representerer resultatene av analysen. De spesifikke resultatene avhenger av innholdet og skjemaet.

Notat

For mer informasjon om Content Understanding API, se referansedokumentasjonen.