Use a API de Compreensão de Conteúdo

A API de Compreensão de Conteúdo fornece uma interface programática que pode usar para criar, gerir e consumir analisadores.

Para usar a API, a sua aplicação cliente envia chamadas HTTP ao endpoint de Compreensão de Conteúdo para o seu recurso Microsoft Foundry, passando uma das chaves de autorização no cabeçalho. Pode obter o endpoint e as chaves no portal Azure ou no portal Microsoft Foundry. Também pode usar a API Microsoft Foundry para se ligar programaticamente ao projeto com o seu Entra ID.

Utilização da API para analisar conteúdos

Um dos usos mais comuns da API é submeter conteúdo a um analisador existente que já construiu e recuperar os resultados da análise. A solicitação de análise retorna um valor de ID de operação que representa uma tarefa assíncrona. O seu aplicativo cliente deve então usar outra solicitação para passar o ID da operação de volta ao ponto de extremidade e recuperar o status da operação, potencialmente verificando várias vezes, até que a operação seja concluída e os resultados sejam retornados em formato JSON.

Por exemplo, para analisar um documento, um aplicativo cliente pode enviar uma solicitação POST para a analyze função que contém o seguinte corpo JSON:

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

Supondo que a solicitação seja autenticada e iniciada com êxito, a resposta será semelhante a este exemplo:

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 sua aplicação cliente deve então usar o ID da operação devolvido para verificar o estado da operação até que tenha sucesso (ou falhado), submetendo um pedido GET ao analyzerResults endpoint.

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

Quando a operação for concluída com êxito, a resposta conterá uma carga JSON que representa os resultados da análise. Os resultados específicos dependem do conteúdo e do esquema.