Usar a API de Compreensão de Conteúdo

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

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

Usando a API para analisar o conteúdo

Um dos usos mais comuns da API é enviar conteúdo para um analisador existente criado anteriormente e recuperar os resultados da análise. A solicitação de análise retorna um valor de ID da operação que representa uma tarefa assíncrona. Em seguida, o aplicativo cliente deve usar outra solicitação para passar a ID da operação de volta para o ponto de extremidade e recuperar o status da operação - potencialmente sondando várias vezes até que a operação seja concluída e os resultados sejam retornados no 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 sucesso, a resposta será semelhante a esse 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"
}

Em seguida, seu aplicativo cliente deve usar o ID da operação que foi retornado para verificar o status da operação até que ela seja bem-sucedida ou falhe, enviando uma solicitação GET para o endpoint analyzerResults.

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.