Rest API-verwijzing voor Afbeeldingen zoeken

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

Voorbeeldaanvraag:

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

Parameters

Parameter Required Type Default Description
query 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.
language 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', 'CN'). Zie Ondersteunde regio's voor de volledige lijst.
aspectRatio No string(enum) - Afbeeldingen filteren op hoogte-breedteverhouding. Waarden: "vierkant" (ongeveer 1:1), "breed" (breedtehoogte > ), "hoog" (hoogte van hoogte > ). Wanneer deze niet is ingesteld, wordt er geen filter toegepast.
color No string(enum) - Afbeeldingen filteren op afbeeldingskleur. Waarden: 'colorOnly' (alleen kleurafbeeldingen retourneren), 'monochroom' (alleen zwart-witafbeeldingen retourneren). Wanneer deze niet is ingesteld, wordt er geen filter toegepast.
safeSearch No string(enum) "strikt" Niveau van veilig zoeken filteren. Waarden: "uit", "strikt". De standaardwaarde is 'strikt'.
imageSize No string(enum) - Filter afbeeldingen op groottecategorie. Waarden: "klein" (<200x200px), "medium" (breedte of hoogte 200-500px), "large" (breedte of hoogte >=500px), "extraLarge" (>1024x768px). Kan ook pixelbeperkingen (maxHeight, minHeight, maxWidth, minWidth) gebruiken voor aangepaste grenzen; pixelbeperkingen hebben voorrang op imageSize wanneer ze conflicteren. Wanneer deze niet is ingesteld, wordt er geen filter toegepast.
watermarkFree No boolean onwaar Sluit afbeeldingen met watermerk uit. De standaardwaarde is vals.
maxHeight No integer - Maximale afbeeldingshoogte in pixels. Wordt gebruikt met imageSize voor aangepaste grenzen.
minHeight No integer - Minimale hoogte van de afbeelding in pixels.
maxWidth No integer - Maximale breedte van afbeelding in pixels.
minWidth No integer - Minimale breedte van afbeelding in pixels.

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

ImagesResponse

Veld Type Description
imageResults matrix van ImageResult Lijst met afbeeldingsresultaten.
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 en tracering.

ImageResult

Veld Type Description
title string De titel van de afbeelding.
url string De bron-URL van de afbeelding. 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.
hostPageUrl string De URL van de webpagina waarop de afbeelding wordt gehost.
caption string Gegenereerde beschrijving van de afbeelding.
width integer De breedte van de afbeelding, in pixels.
height integer De hoogte van de afbeelding, in pixels.
thumbnailUrl string De bron-URL van de miniatuur van de afbeelding.
lastUpdatedAt string De laatst bijgewerkte datum van de afbeelding volgt ISO8601 indeling.
isAdult boolean Geeft aan of de inhoud inhoud voor volwassenen is.
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.

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 invideo's zoeken in video's zoeken | in | | nieuws zoeken | MCP