Naslaginformatie over REST API voor video's zoeken

Eindpunt:POST https://api.microsoft.ai/v3/search/videos

Voorbeeldaanvraag:

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 Type Default Description
zoekopdracht Yes string - Een zoekquerytekenreeks. De maximale lengte is 1000 tekens.
maxResults No integer 30 Maximum aantal resultaten dat moet worden geretourneerd. De standaardwaarde is 30 en de maximumwaarde is 30.
taal No string "en" Een ISO 639-1-taalcode van 2 letters voor interfacetaal in de zoekresultaten. Zie Ondersteunde talen voor de volledige lijst.
region No string "US" Een land-/regiocode van 2 letters voor waar de resultaten vandaan moeten komen (bijvoorbeeld 'VS', 'JP', 'GB', enzovoort). Zie Ondersteunde regio's voor de volledige lijst.
enablePlaylist No boolean onwaar Of u afspeellijstresultaten wilt opnemen in antwoord.
freshness No string - Het tijdsbereik voor het filteren van resultaten op basis van de detectiedatum. Ondersteunt 'week', 'maand', 'jaar' voor relatieve tijd of ISO 8601-datumintervalnotatie: "JJJJ-MM-DD/JJJJ-MM-DD" of "JJJJ-MM-DDTHH:mm:ssZ/JJJJ-MM-DDTHH:mm:ssZ" voor een datum/datum/tijd-bereik. om de begin- of einddatum weg te laten.
insluitbaar No array van tekenreeksen - Filter video's door mogelijkheden in te sluiten. Toegestane waarden: "player" (heeft insluitbare speler). Wanneer deze niet is ingesteld, wordt er geen filter toegepast.
resolutie No string - Filter video's op minimale resolutie. Waarden: "360p", "480p", "720p", "1080p". Wanneer deze niet is ingesteld, wordt er geen filter toegepast.
safeSearch No string "strikt" Niveau van veilig zoeken filteren. Waarden: "uit", "strikt". De standaardwaarde is 'strikt'.
duration No string - Video's filteren op duurbereik. Waarden: "short" (<5 min), "medium" (5–20 min), "long" (>20 min). Wanneer deze niet is ingesteld, wordt er geen filter toegepast.

Aanvraagheaders

Veld Type Description
host string Host voor Microsoft AI-API's: api.microsoft.ai.
x-apikey of autorisatie string Uw API-sleutel of Entra ID toegangstoken voor verificatie.
inhoudstype string MIME-type van de aanvraagbody. Gebruik application/json.

Antwoord

Antwoord op video's

Veld Type Description
videoResults matrix van videoResult Lijst met videoresultaten.
afspeellijsten matrix van playlistResult (optioneel) Lijst met afspeellijstresultaten.
instrumentationClickBase string Basis-URL voor ping-aanvragen voor klikken. Voeg een instrumentationSuffix waarde van een resultaatitem toe om de volledige ping-URL te vormen. Alleen aanwezig voor toepassingen met de vlag EnableInstrumentationPing-profiel. Opmerking: Gebruikersklikken kunnen ook worden geregistreerd met behulp van URL-omleiding. Wanneer omleiding is ingeschakeld, is er geen actie vereist voor het vastleggen van klikken van gebruikers en instrumentationClickBase wordt deze niet opgenomen in het antwoord. Zie de instrumentatiehandleiding voor installatie-instructies.
instrumentationCitationBase string Basis-URL voor PING-aanvragen voor LLM-logboeken. Voeg een DATA-nettolading toe om de volledige ping-URL te vormen. Alleen aanwezig voor toepassingen met de vlag EnableInstrumentationPing-profiel.
traceId string Tracerings-id voor foutopsporing.

Note

playlists is een optioneel veld, zelfs als enablePlaylist deze is ingesteld op waar.

videoResult

Veld Type Description
title string De titel of naam van de video.
url string De bron-URL van de video. Voor China-gebruikers waarvoor URL-omleiding is ingeschakeld, bevat dit veld in plaats daarvan dezelfde omleidings-URL als clickUrl.
domain string De doelhost voor het resultaat. Alleen geretourneerd voor China-gebruikers waarvoor URL-omleiding is ingeschakeld.
description string Beschrijving van de video-inhoud. Dit wordt geleverd door de video-uploader of gegenereerd door een LLM.
publishedBy string Uploader of uitgever van de video.
viewCount long Het aantal weergaven dat de video heeft.
summary string Door AI gegenereerde videosamenvatting.
length string De lengte van de video in HH:MM:SS-indeling.
allowHttpsEmbedding boolean Of HTTPS-insluiting is toegestaan.
allowMobileEmbedding boolean Of mobiel insluiten is toegestaan.
embeddingUrl string URL voor het insluiten van de video.
laatsteBijgewerktOp string De laatst bijgewerkte datum als een opgemaakte tekenreeks.
bestMomentIndex integer Index van het beste moment of de markering in de video.
ogenblikken matrix van moment Matrix van videosegmenten/momenten.
thumbnailUrl string Miniatuur-URL van de video.
width integer De breedte van de video in pixels.
height integer De hoogte van de video in pixels.
isAdult boolean Geeft aan of het resultaat inhoud voor volwassenen bevat.
clickUrl string Omleidings-URL die de klik via Bing proxyt. Alleen aanwezig wanneer klikken op omleiding is ingeschakeld.
instrumentationSuffix string Achtervoegsel dat moet worden toegevoegd aan de URL-basis voor instrumentatie-ping voor dit resultaatitem. Wordt gebruikt als de K-waarde voor zowel de ping-URL voor instrumentatie als de clickUrl omleiding. Aanwezig wanneer instrumentatie ping is ingeschakeld.

Note

Verschillende van de bovenstaande velden zijn optioneel: ze worden geleverd als ze beschikbaar zijn.

moment

Veld Type Description
title string Titel van het momentsegment.
description string Beschrijving van wat er op dit moment gebeurt.
startTime string Begintijd van het moment in de notatie d.hh:mm:ss.
endTime string Eindtijd van het moment in notatie 'd.hh:mm:ss'.
momentUrl string Directe URL naar dit specifieke moment in de video.

Note

moment is een optioneel antwoordobject. Het is niet beschikbaar voor elk videoresultaat.

playlistResult

Veld Type Description
title string Titel van de afspeellijst.
description string Beschrijving van de afspeellijst.
video's matrix van video Matrix van video's in de afspeellijst.

Note

playlistResult is een optioneel antwoordobject.

video

Veld Type Description
title string Titel van de video.
description string Beschrijving van de video.
url string URL van de video.

Foutcodes

Statuscode Foutcategorie Description Veelvoorkomende oorzaken
200 Success Het verzoek slaagde. -
400 Onjuiste aanvraag Ongeldige aanvraagparameters. Ontbrekende vereiste velden, ongeldige parameterwaarden, ongeldige JSON
401 Niet geautoriseerd Verificatie is mislukt of ontbreekt. Ongeldige API-sleutel, ontbrekende x-apikey-header
403 Verboden Geldige referenties, maar onvoldoende machtigingen. API-sleutel heeft geen vereiste machtigingen
410 Weg HTTPS vereist. Aanvraag via HTTP in plaats van HTTPS
415 Niet-ondersteund mediatype Inhoudstype wordt niet ondersteund. Ontbrekende of onjuiste header van inhoudstype
429 Te veel aanvragen De snelheidslimiet is overschreden. Te veel aanvragen in tijdvenster
500 Interne serverfout Onverwachte serverfout. Probleem met tijdelijke server
503 Service niet beschikbaar Service is tijdelijk niet beschikbaar. Onderhoud of tijdelijke storing
504 Gateway-time-out Er is een time-out opgetreden voor het verzoek. Time-out van upstream-service

Zie Foutafhandeling voor gedetailleerde richtlijnen voor foutafhandeling.

Zie ook:Zoeken op internetdoor | nieuws zoeken | | afbeeldingen zoeken | MCP

  • Laatst bijgewerkt om