Dokumentacja interfejsu API REST wyszukiwania wideo

Punkt końcowy:POST https://api.microsoft.ai/v3/search/videos

Przykładowe żądanie:

curl -X POST "https://api.microsoft.ai/v3/search/videos" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "cute puppy videos",
    "maxResults": 30,
    "language": "en",
    "region": "US"
  }'

Parameters

Parameter	Required	Typ	Default	Description
kwerenda	Yes	ciąg	-	Ciąg zapytania wyszukiwania. Maksymalna długość to 1000 znaków.
maksWyniki	No	liczba całkowita	30	Maksymalna liczba wyników do zwrócenia. Wartość domyślna to 30, a wartość maksymalna to 30.
język	No	ciąg	"en"	Dwuliterowy kod języka ISO 639-1 dla języka interfejsu w wynikach wyszukiwania. Aby uzyskać pełną listę, zobacz Obsługiwane języki .
region	No	ciąg	"US"	Dwuliterowy kod kraju/regionu, z którego powinny pochodzić wyniki (np. "USA", "JP", "GB" itp.). Aby uzyskać pełną listę, zobacz Obsługiwane regiony .
enablePlaylist	No	boolean	false	Określa, czy lista odtwarzania ma być uwzględniana w odpowiedzi.
freshness	No	ciąg	-	Zakres czasu filtrowania wyników na podstawie daty odnajdywania. Obsługuje format interwału "tydzień", "miesiąc", "rok" dla czasu względnego lub format interwału daty ISO 8601: "RRRR-MM-DD/RRRR-MM-DD" lub "RRRR-MM-DDTHH:mm:ssZ/RRRR-MM-DDTHH:mm:ssZ" dla zakresu daty/daty/godziny. aby pominąć datę rozpoczęcia lub zakończenia.
osadzanie	No	tablica ciągów	-	Filtruj filmy wideo, osadzając możliwości. Dozwolone wartości: "player" (ma osadzony odtwarzacz). Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.
rozdzielczość	No	ciąg	-	Filtruj filmy wideo według minimalnej rozdzielczości. Wartości: "360p", "480p", "720p", "1080p". Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.
safeSearch	No	ciąg	"strict"	Poziom filtrowania bezpiecznego wyszukiwania. Wartości: "off", "strict". Wartość domyślna to "strict".
duration	No	ciąg	-	Filtruj filmy wideo według zakresu czasu trwania. Wartości: "krótki" (<5 minut), "średni" (5–20 minut), "długi" (>20 minut). Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.

Nagłówki żądań

Pole	Typ	Description
gospodarz	ciąg	Host dla interfejsów API sztucznej inteligencji Microsoft: api.microsoft.ai.
x-apikey lub authorization	ciąg	Klucz interfejsu API lub token dostępu Entra ID na potrzeby uwierzytelniania.
typ zawartości	ciąg	Typ MIME treści żądania. Użyj application/json.

Odpowiedź

Odpowiedź na wideo

Pole	Typ	Description
videoResults	tablica wideoResult	Lista wyników wideo.
listy odtwarzania	tablica listy odtwarzaniaResult (opcjonalnie)	Lista wyników listy odtwarzania.
instrumentacjaClickBase	ciąg	Podstawowy adres URL kliknięcia żądań ping. instrumentationSuffix Dołącz wartość z elementu wyniku, aby utworzyć pełny adres URL ping. Tylko dla aplikacji z flagą profilu EnableInstrumentationPing. Uwaga: kliknięcia użytkownika można również rejestrować przy użyciu przekierowania adresu URL. Po włączeniu przekierowania nie jest wymagana żadna akcja rejestrowania kliknięć użytkownika i instrumentationClickBase nie zostanie uwzględniona w odpowiedzi. Aby uzyskać instrukcje dotyczące konfiguracji, zobacz Przewodnik instrumentacji .
instrumentacjaCitationBase	ciąg	Podstawowy adres URL dla żądań ping dziennika LLM. Dołącz ładunek DANYCH, aby utworzyć pełny adres URL polecenia ping. Tylko dla aplikacji z flagą profilu EnableInstrumentationPing.
traceId	ciąg	Identyfikator śledzenia na potrzeby debugowania.

Note

playlists jest polem opcjonalnym nawet wtedy, gdy enablePlaylist jest ustawiona wartość true.

videoResult

Pole	Typ	Description
title	ciąg	Tytuł lub nazwa filmu wideo.
url	ciąg	Źródłowy adres URL filmu wideo. W przypadku użytkowników Chin z włączonym przekierowywaniem adresu URL to pole zawiera ten sam adres URL przekierowania co clickUrl.
domena	ciąg	Host docelowy dla wyniku. Zwracane tylko dla użytkowników z Chin z włączonym przekierowywaniem adresów URL.
description	ciąg	Opis zawartości wideo. Jest to dostarczane przez program przekazujący wideo lub generowane przez llM.
publishedBy	ciąg	Uploader lub wydawca filmu wideo.
viewCount	long	Liczba wyświetleń wideo.
podsumowanie	ciąg	Podsumowanie wideo wygenerowane przez sztuczną inteligencję.
length	ciąg	Długość wideo w formacie HH:MM:SS.
allowHttpsEmbedding	boolean	Czy osadzanie HTTPS jest dozwolone.
allowMobileEmbedding	boolean	Czy osadzanie urządzeń przenośnych jest dozwolone.
embeddingUrl	ciąg	Adres URL osadzania wideo.
lastUpdatedAt	ciąg	Data ostatniej aktualizacji jako sformatowany ciąg.
bestMomentIndex	liczba całkowita	Indeks najlepszego momentu lub wyróżnienia w filmie wideo.
chwile	tablica momentów	Tablica segmentów wideo/momentów.
thumbnailUrl	ciąg	Adres URL miniatury filmu wideo.
width	liczba całkowita	Szerokość wideo w pikselach.
height	liczba całkowita	Wysokość wideo w pikselach.
isAdult	boolean	Wskazuje, czy wynik zawiera zawartość dla dorosłych.
clickUrl	ciąg	Adres URL przekierowania, który serwer proxy klika za pośrednictwem usługi Bing. Występuje tylko po włączeniu przekierowania kliknięcia.
instrumentacjaSuffix	ciąg	Sufiks dołączany do bazy adresów URL ping instrumentacji dla tego elementu wyniku. Używana jako wartość K zarówno dla adresu URL polecenia ping instrumentacji, jak i przekierowania clickUrl . Występuje, gdy polecenie ping instrumentacji jest włączone.

Note

Niektóre z powyższych pól są opcjonalne — są one obsługiwane, jeśli są dostępne.

moment

Pole	Typ	Description
title	ciąg	Tytuł segmentu momentów.
description	ciąg	Opis tego, co dzieje się w tej chwili.
startTime	ciąg	Godzina rozpoczęcia chwili w formacie "d.hh:mm:ss".
endTime	ciąg	Godzina zakończenia chwili w formacie "d.hh:mm:ss".
momentUrl	ciąg	Bezpośredni adres URL do tego konkretnego momentu w filmie wideo.

Note

moment jest opcjonalnym obiektem odpowiedzi. Nie jest on dostępny dla każdego wyniku wideo.

lista odtwarzaniaWybieranie

Pole	Typ	Description
title	ciąg	Tytuł listy odtwarzania.
description	ciąg	Opis listy odtwarzania.
filmy	tablica wideo	Tablica filmów wideo na liście odtwarzania.

Note

playlistResult jest opcjonalnym obiektem odpowiedzi.

wideo

Pole	Typ	Description
title	ciąg	Tytuł filmu wideo.
description	ciąg	Opis filmu wideo.
url	ciąg	Adres URL filmu wideo.

Kody błędów

Kod stanu	Kategoria błędów	Description	Typowe przyczyny
200	Powodzenie	Żądanie zakończyło się pomyślnie.	-
400	Nieprawidłowe żądanie	Nieprawidłowe parametry żądania.	Brak wymaganych pól, nieprawidłowe wartości parametrów, nieprawidłowo sformułowany kod JSON
401	Brak autoryzacji	Uwierzytelnianie nie powiodło się lub nie powiodło się.	Nieprawidłowy klucz interfejsu API, brak nagłówka x-apikey
403	Dostęp zabroniony	Prawidłowe poświadczenia, ale niewystarczające uprawnienia.	Klucz interfejsu API nie ma wymaganych uprawnień
410	Zniknęło	Wymagany protokół HTTPS.	Żądanie wykonane za pośrednictwem protokołu HTTP zamiast HTTPS
415	Nieobsługiwany typ nośnika	Typ zawartości nie jest obsługiwany.	Brak lub niepoprawny nagłówek typu zawartości
429	Zbyt wiele żądań	Przekroczono limit szybkości.	Zbyt wiele żądań w przedziale czasu
500	Wewnętrzny błąd serwera	Nieoczekiwany błąd serwera.	Tymczasowy problem z serwerem
503	Usługa niedostępna	Usługa jest tymczasowo niedostępna.	Konserwacja lub tymczasowa awaria
504	Przekroczono limit czasu bramy	Upłynął limit czasu żądania.	Limit czasu usługi nadrzędnej

Aby uzyskać szczegółowe wskazówki dotyczące obsługi błędów, zobacz Obsługa błędów.

---

Zobacz również:Wyszukiwanie w internecie | Przeglądaj | obrazywyszukiwania wiadomości Search | | MCP