Verwenden der REST-API für Inhaltsverständnis

Die REST-API für Inhaltsverständnis bietet eine programmgesteuerte Schnittstelle, die Sie zum Erstellen, Verwalten und Nutzen von Analysetools verwenden können.

Um die REST-API zu verwenden, sendet Ihre Clientanwendung HTTP-Aufrufe an den Inhaltsverständnis-Endpunkt für Ihre Foundry Tools-Ressource, und übergibt einen der Autorisierungsschlüssel im Header. Sie können den Endpunkt und die Schlüssel im Azure-Portal oder im Microsoft Foundry-Portal abrufen. Sie können auch die Microsoft Foundry-API verwenden, um eine Verbindung mit dem Projekt herzustellen und den Endpunkt und den Schlüssel für Ihre Ressource "Foundry Tools" programmgesteuert abzurufen.

Verwenden der REST-API zum Analysieren von Inhalten

Eine der häufigsten Verwendungen der REST-API besteht darin, Inhalte an ein vorhandenes Analysetool zu übermitteln, das Sie zuvor erstellt haben, und die Ergebnisse der Analyse abzurufen. Die Analyseanforderung gibt einen Vorgangs-ID-Wert zurück, der eine asynchrone Aufgabe darstellt. Ihre Clientanwendung muss dann eine weitere Anforderung verwenden, um die Vorgangs-ID zurück an den Endpunkt zu übergeben und den Vorgangsstatus abzurufen – potenziell mehrmals abfragen, bis der Vorgang abgeschlossen ist und die Ergebnisse im JSON-Format zurückgegeben werden.

Um beispielsweise ein Dokument zu analysieren, kann eine Clientanwendung eine POST-Anforderung an die Funktion senden, die den folgenden JSON-Text enthält: analyze

POST {endpoint}/contentunderstanding/analyzers/{analyzer}:analyze?api-version={api version}
{
  "url": "https://host.com/doc.pdf"
}

Wenn die Anforderung authentifiziert und erfolgreich initiiert wird, ähnelt die Antwort diesem Beispiel:

Operation-Id: 1234abcd-1234-abcd-1234-abcd1234abcd
Operation-Location: {endpoint}/contentunderstanding/analyzers/{analyzer}/results/1234abcd-1234-abcd-1234-abcd1234abcd?api-version={api version}
{
  "id": "1234abcd-1234-abcd-1234-abcd1234abcd",
  "status": "NotStarted"
}

Ihre Clientanwendung muss dann die Vorgangs-ID verwenden, die zurückgegeben wurde, um den Status des Vorgangs zu überprüfen, bis der Vorgang erfolgreich war (oder fehlgeschlagen ist), indem eine GET-Anforderung an die results Funktion übermittelt wird.

GET {endpoint}/contentunderstanding/analyzers/{analyzer}/results/1234abcd-1234-abcd-1234-abcd1234abcd?api-version={api version}

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält die Antwort eine JSON-Nutzlast, die die Ergebnisse der Analyse darstellt. Die spezifischen Ergebnisse hängen vom Inhalt und Schema ab.