Referenční informace k rozhraní REST API pro vyhledávání videí

Koncový bod:POST https://api.microsoft.ai/v3/search/videos

Ukázkový požadavek:

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 Výchozí Description
dotaz Ano řetězec - Řetězec vyhledávacího dotazu. Maximální délka je 1000 znaků.
maxResults No integer 30 Maximální počet výsledků, které se mají vrátit. Výchozí hodnota je 30 a maximální hodnota je 30.
jazyk No řetězec "en" Dvoumísmenný kód jazyka ISO 639-1 pro jazyk rozhraní ve výsledcích hledání. Úplný seznam najdete v části Podporované jazyky .
oblast No řetězec "US" 2písmenný kód země/oblasti, odkud mají výsledky pocházet (např. "US", "JP", "GB" atd.). Úplný seznam najdete v části Podporované oblasti .
enablePlaylist No boolean Nepravda Zda se mají výsledky seznamu stop zahrnout do odpovědi.
freshness No řetězec - Časový rozsah pro filtrování výsledků na základě data zjišťování. Podporuje formát "week", "month", "year" pro relativní čas nebo formát intervalu data ISO 8601: "RRRR-MM-DD/RRRR-MM-DD" nebo "RRRR-MM-DDTHH:mm:ssZ/RRRR-MM-DDTHH:mm:ssZ" pro rozsah data/data a času použijte .. vynechání počátečního nebo koncového data.
embeddable No pole řetězce - Filtrování videí pomocí možností vkládání Povolené hodnoty: "player" (má vložený přehrávač). Pokud není nastaveno, není použito žádné filtrování.
řešení No řetězec - Filtrujte videa podle minimálního rozlišení. Hodnoty: "360p", "480p", "720p", "1080p". Pokud není nastaveno, není použito žádné filtrování.
safeSearch No řetězec "striktní" Úroveň bezpečného filtrování hledání Hodnoty: "off", "strict". Výchozí hodnota je "striktní".
duration No řetězec - Filtrujte videa podle rozsahu doby trvání. Hodnoty: "short" (<5 min), "medium" (5–20 min), "long" (>20 min). Pokud není nastaveno, není použito žádné filtrování.

Hlavičky požadavku

Field Typ Description
hostitel řetězec Hostitel pro rozhraní API Microsoft AI: api.microsoft.ai.
x-apikey nebo authorization řetězec Váš klíč rozhraní API nebo Entra ID přístupový token pro ověřování.
typ obsahu řetězec Typ MIME textu požadavku. Použijte application/json.

Response

Odpověď na videa

Field Typ Description
videoResults pole videoResult Seznam výsledků videa
seznamy stop array of playlistResult (volitelné) Seznam výsledků seznamu stop
instrumentationClickBase řetězec Základní adresa URL pro kliknutí na požadavky ping instrumentationSuffix Připojte hodnotu z položky výsledku, která vytvoří úplnou adresu URL příkazu Ping. K dispozici pouze pro aplikace s příznakem profilu EnableInstrumentationPing. Poznámka: Kliknutím uživatele lze také protokolovat pomocí přesměrování adresy URL. Pokud je přesměrování povolené, nevyžaduje se žádná akce pro protokolování kliknutí uživatele a instrumentationClickBase nebude zahrnuta do odpovědi. Pokyny k nastavení najdete v průvodci instrumentací .
instrumentationCitationBase řetězec Základní adresa URL pro požadavky ping protokolu LLM Připojte datovou část k vytvoření úplné adresy URL příkazu Ping. K dispozici pouze pro aplikace s příznakem profilu EnableInstrumentationPing.
traceId řetězec ID trasování pro ladění

Note

playlists je volitelné pole, i když enablePlaylist je nastaveno na hodnotu true.

videoResult

Field Typ Description
title řetězec Název nebo název videa
url řetězec Zdrojová adresa URL videa. Pro uživatele v Číně s povoleným přesměrováním adresy URL místo toho toto pole obsahuje stejnou adresu URL přesměrování jako clickUrl.
doména řetězec Cílový hostitel výsledku. Vráceno pouze pro uživatele v Číně s povoleným přesměrováním adresy URL.
description řetězec Popis obsahu videa Ten poskytuje buď nahrávač videa, nebo ho vygeneruje LLM.
publishedBy řetězec Nahrávač nebo vydavatel videa
viewCount long Počet zobrazení videa.
souhrn řetězec Souhrn videa vygenerovaný AI
length řetězec Délka videa ve formátu HH:MM:SS.
allowHttpsEmbedding boolean Určuje, jestli je povolené vkládání HTTPS.
allowMobileEmbedding boolean Určuje, jestli je povolené vkládání mobilních zařízení.
embeddingUrl řetězec Adresa URL pro vložení videa
lastUpdatedAt řetězec Datum poslední aktualizace jako formátovaný řetězec.
bestMomentIndex integer Index nejlepšího okamžiku nebo zvýraznění ve videu
okamžiky pole momentu Pole segmentů a momentů videa
thumbnailUrl řetězec Adresa URL miniatury videa
width integer Šířka videa v pixelech.
height integer Výška videa v pixelech.
isAdult boolean Určuje, jestli výsledek obsahuje obsah pro dospělé.
clickUrl řetězec Přesměrujte adresu URL, která přesMěruje proxy přes Bing. Je k dispozici pouze v době, kdy je povoleno kliknutí na přesměrování.
instrumentationSuffix řetězec Přípona pro připojení k základu adresy URL příkazu ping instrumentace pro tuto položku výsledku. Používá se jako hodnota K pro adresu URL příkazu ping instrumentace i pro clickUrl přesměrování. Je k dispozici, když je povolený příkaz ping instrumentace.

Note

Některé z výše uvedených polí jsou volitelné – obsluhují se, pokud jsou k dispozici.

moment

Field Typ Description
title řetězec Název segmentu momentu.
description řetězec Popis toho, co se v tomto okamžiku stane.
startTime řetězec Počáteční čas okamžiku ve formátu d.hh:mm:ss.
endTime řetězec Koncový čas okamžiku ve formátu "d.hh:mm:ss".
momentUrl řetězec Direct URL to this specific moment in the video.

Note

moment je volitelný objekt odpovědi. Není k dispozici pro každý výsledek videa.

playlistResult

Field Typ Description
title řetězec Název seznamu stop.
description řetězec Popis seznamu stop.
videa pole videa Pole videí v seznamu stop.

Note

playlistResult je volitelný objekt odpovědi.

video

Field Typ Description
title řetězec Název videa.
description řetězec Popis videa
url řetězec Adresa URL videa

Kódy chyb

Kód stavu Kategorie chyb Description Běžné příčiny
200 Success Žádost byla úspěšná. -
400 Nesprávná žádost Neplatné parametry požadavku. Chybí požadovaná pole, neplatné hodnoty parametrů, chybně formátovaný JSON.
401 Neautorizováno Ověřování se nezdařilo nebo chybí. Neplatný klíč rozhraní API, chybějící hlavička x-apikey
403 Zakázáno Platné přihlašovací údaje, ale nedostatečná oprávnění Klíč rozhraní API nemá požadovaná oprávnění
410 Pryč Vyžaduje se HTTPS. Požadavek provedený přes PROTOKOL HTTP místo HTTPS
415 Nepodporovaný typ média Typ obsahu není podporován. Chybějící nebo nesprávná hlavička typu obsahu
429 Příliš mnoho požadavků Byl překročen limit rychlosti. Příliš mnoho požadavků v časovém intervalu
500 Vnitřní chyba serveru Neočekávaná chyba serveru Dočasný problém se serverem
503 Služba není k dispozici Služba je dočasně nedostupná. Údržba nebo dočasný výpadek
504 Časový limit brány Vypršel časový limit požadavku. Upstreamový časový limit služby

Podrobné pokyny pro zpracování chyb najdete v tématu Zpracování chyb.

Viz také:Web SearchBrowse | News Search | | Images Search | MCP

  • Poslední aktualizace v