Korzystanie z interfejsu API REST usługi Content Understanding

Ukończone

Interfejs API REST Content Understanding udostępnia interfejs programowy, którego można użyć do tworzenia analizatorów, zarządzania nimi i korzystania z nich.

Aby użyć interfejsu API REST, aplikacja kliencka przesyła wywołania HTTP do punktu końcowego usługi Content Understanding dla zasobu narzędzi Foundry, przekazując jeden z kluczy autoryzacji w nagłówku. Punkt końcowy i klucze można uzyskać w witrynie Azure Portal lub w portalu Microsoft Foundry. Możesz również użyć interfejsu API rozwiązania Microsoft Foundry, aby nawiązać połączenie z projektem i pobrać punkt końcowy i klucz zasobu narzędzi Foundry programowo.

Analizowanie zawartości przy użyciu interfejsu API REST

Jednym z najczęstszych zastosowań interfejsu API REST jest przesyłanie zawartości do istniejącego analizatora, który został wcześniej skompilowany, i pobieranie wyników analizy. Żądanie analizy zwraca wartość identyfikatora operacji reprezentującą zadanie asynchroniczne. Aplikacja kliencka musi następnie użyć innego żądania, aby przekazać identyfikator operacji z powrotem do punktu końcowego i pobrać stan operacji — potencjalnie wielokrotnie sprawdzając, dopóki operacja nie zostanie ukończona, a wyniki zostaną zwrócone w formacie JSON.

Na przykład w celu przeanalizowania dokumentu aplikacja kliencka może przesłać żądanie POST do analyze funkcji zawierającej następującą treść JSON:

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

Uwaga

Możesz określić adres URL lokalizacji pliku zawartości lub dołączyć zawartość binarną pliku.

Zakładając, że żądanie zostało uwierzytelnione i zainicjowane pomyślnie, odpowiedź będzie podobna do następującej:

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

Aplikacja kliencka musi następnie użyć identyfikatora operacji, który został zwrócony, aby sprawdzić stan operacji, dopóki operacja nie powiedzie się (lub nie powiodła się), przesyłając żądanie GET do results funkcji.

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

Po pomyślnym zakończeniu operacji odpowiedź zawiera ładunek JSON reprezentujący wyniki analizy. Konkretne wyniki zależą od zawartości i schematu.

Uwaga

Aby uzyskać więcej informacji na temat interfejsu API REST usługi Content Understanding, zobacz dokumentację referencyjną.