Szybki start: korzystanie z interfejsu API

Ważne

Ze względu na ogłoszenie wycofania usługi Azure Media Services usługa Azure AI Video Indexer ogłasza zmiany funkcji usługi Azure AI Video Indexer. Zobacz Zmiany związane z wycofaniem usługi Azure Media Service (AMS), aby dowiedzieć się, co to oznacza dla konta usługi Azure AI Video Indexer. Zobacz Przewodnik Przygotowywanie do wycofania usługi AMS: VI aktualizacji i migracji.

Usługa Azure AI Video Indexer konsoliduje różne technologie sztucznej inteligencji audio i wideo oferowane przez firmę Microsoft w jedną zintegrowaną usługę, dzięki czemu programowanie jest prostsze. Usługa Azure AI Video Indexer została zaprojektowana tak, aby umożliwić deweloperom skoncentrowanie się na używaniu technologii sztucznej inteligencji multimediów bez obaw o skalę, globalny zasięg, dostępność i niezawodność platform w chmurze. Interfejs API umożliwia przekazywanie plików, uzyskiwanie szczegółowych informacji wideo, uzyskiwanie adresów URL osadzonych szczegółowych informacji, widżetów odtwarzacza i nie tylko.

Gdy po raz pierwszy odwiedzasz witrynę internetową usługi Azure AI Video Indexer , zostanie automatycznie utworzone konto w wersji próbnej. Dzięki kontu wersji próbnej uzyskasz kilka bezpłatnych minut indeksowania. Później możesz dodać płatne konto. W przypadku opcji płatnej płacisz za indeksowane minuty. Aby uzyskać szczegółowe informacje o dostępnych kontach (opcje wersji próbnej i płatnej), zobacz Typy kont usługi Azure AI Video Indexer.

W tym artykule pokazano, jak używać interfejsu API usługi Azure AI Video Indexer.

Wymagania wstępne

Przekaż plik multimedialny. Istnieją dwa sposoby:

1. Przekaż plik multimedialny do wybranego adresu URL (zalecane). Można użyć publicznej lokalizacji sieciowej. Po przekazaniu pliku możesz sprawdzić, czy plik jest dostępny dla programu AVI, kopiując i wklejając go na pasku lokalizacji przeglądarki. Jeśli możesz odtworzyć plik multimedialny, prawdopodobnie vi może również uzyskać do niego dostęp. Jeśli chcesz zabezpieczyć lokalizację magazynu przy użyciu obiektu blob usługi Azure Storage, przekaż plik i uzyskaj adres URL sygnatury dostępu współdzielonego. Aby uzyskać więcej informacji na temat uzyskiwania bezpiecznego adresu URL dla pliku, zobacz Azure Blob Storage SAS URL (Adresy URL sygnatur dostępu współdzielonego usługi Azure Blob Storage). Ten adres URL służy do kopiowania pliku do usługi Azure AI Video Indexer na potrzeby indeksowania.

2. Wyślij plik wideo tablicę bajtów w treści żądania. Aby uzyskać więcej informacji na temat przekazywania pliku multimedialnego jako tablicy bajtów w treści żądania, zobacz Przekazywanie obiektu blob przy użyciu platformy .NET.

Uwaga

Istnieje limit żądań interfejsu API 10 żądań na sekundę i maksymalnie 120 żądań na minutę.

Subskrybowanie interfejsu API

Ważne

• Musisz użyć tej samej wiadomości e-mail, która została użyta podczas tworzenia konta w usłudze Azure AI Video Indexer.
• Osobiste konta Google i Microsoft (Outlook/Live) mogą być używane tylko na kontach w wersji próbnej. Konta połączone z platformą Azure wymagają identyfikatora Entra.
• Może istnieć tylko jedno aktywne konto na adres e-mail. Jeśli użytkownik spróbuje zalogować się w user@gmail.com usłudze LinkedIn i nowszym z usługą user@gmail.com Google, zostanie wyświetlona strona błędu z informacją, że użytkownik już istnieje.
• Klucze powinny być chronione. Powinno się ich używać tylko w kodzie serwera. Nie powinny być dostępne po stronie klienta (.js, .html itd.).

1. Zaloguj się do portalu deweloperów interfejsu API usługi Azure AI Video Indexer.
2. Subskrybuj , wybierając kartę Produkty . Następnie wybierz pozycję Autoryzacja i subskrybuj. Nowi użytkownicy automatycznie subskrybują autoryzację.
3. Znajdź, skopiuj i zapisz klucze podstawowe i pomocnicze. Subskrypcję można znaleźć w profilu. Klucze podstawowe i pomocnicze znajdują się w sekcji Subskrypcje .
4. Wybierz link Pokaż zarówno dla klucza podstawowego, jak i klucza pomocniczego. Skopiuj je i wklej do edytora tekstów, dopóki nie będzie można ich używać w pliku zmiennych środowiskowych.

Uzyskiwanie tokenu dostępu przy użyciu interfejsu API autoryzacji

Nie chcesz udzielać pełnego dostępu każdemu użytkownikowi dla aplikacji. Istnieje kilka poziomów dostępu dla vi.

Poziom	Wyświetlanie filmów wideo	Przetwarzanie klipów wideo	Wyświetlanie projektów	Przetwarzanie projektów	Wyświetlanie kont	Zarządzanie kontami
Czytnik wideo	✔️
Współautor wideo	✔️	✔️
Czytelnik projektu	✔️		✔️
Współautor projektu	✔️	✔️	✔️	✔️
Czytelnik konta	✔️		✔️		✔️
Współautor konta	✔️	✔️	✔️	✔️	✔️	✔️

Tworzenie i wysyłanie żądania tokenu dostępu

subscription-idUstaw , resource-group-name, VI account-name w żądaniu i ustaw scope parametr i permissionType w treści żądania na wymagany poziom dostępu.

Jeśli na przykład chcesz zapewnić użytkownikowi dostęp, aby mógł pracować z projektami, ale nie może pracować z kontami, ustaw wartość permissionType "Współautor" i scope wartość "Project". Jeśli ustawienie uprawnień dla projektu, podaj projectIdwartość .

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.VideoIndexer/accounts/{account-name}/generateAccessToken?api-version=2024-01-01

{
  "permissionType": "Reader",
  "scope": "Project",
  "projectId": "07ec9e38d4"
}

Przykładowa odpowiedź

{
  "accessToken": "<jwt token of 1260 characters length>"
}

Aby uzyskać więcej przykładów ustawiania zakresu i typów uprawnień, zobacz interfejs API REST VI.

Rozpocznij korzystanie z interfejsu API

Możesz rozpocząć korzystanie z interfejsu API. Znajdź szczegółowy opis każdego interfejsu API REST usługi Azure AI Video Indexer.

Szczegółowy przykład użycia kluczy w pliku zmiennej środowiskowej i używanie tokenów dostępu można znaleźć w przykładzie usługi Azure AI Video Indexer.

Zalecenia

• Wywołanie dla konkretnego pliku wideo interfejsu API, który pobiera szczegółowe informacje o wideo, powoduje pobranie w zawartości odpowiedzi szczegółowych danych wyjściowych JSON. Zobacz szczegółowe informacje o zwróconym formacie JSON w tym artykule.
• Dane wyjściowe JSON generowane przez interfejs API zawierają Insights elementy i SummarizedInsights . Zdecydowanie zalecamy używanie i Insights nieużywanie SummarizedInsights (co jest obecne w celu zapewnienia zgodności z poprzednimi wersjami).
• Nie zalecamy używania danych bezpośrednio z folderu artifacts w celach produkcyjnych. Artefakty to pośrednie dane wyjściowe procesu indeksowania i są nieprzetworzonymi danymi wyjściowymi różnych aparatów sztucznej inteligencji, które analizują filmy wideo. Schemat artefaktów może ulec zmianie w czasie.
• Użyj interfejsu API pobierania indeksu wideo zgodnie z opisem w artykule Uzyskiwanie szczegółowych informacji i artefaktów utworzonych przez interfejs API, a nieGet-Video-Artifact-Download-Url.