Rest API-referens för bildsökning

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

Exempelbegäran:

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 - En sökfrågesträng. Maximal längd är 1 000 tecken.
maxResults No integer 30 Maximalt antal resultat som ska returneras. Standardvärdet är 30 och maxvärdet är 30.
language No string "en" En iso 639-1-språkkod med två bokstäver för gränssnittsspråk i sökresultaten. Se Språk som stöds för den fullständiga listan.
region No string "US" En lands-/regionkod med två bokstäver för var resultaten ska komma från (t.ex. "US", "JP", "CN"). Se Regioner som stöds för den fullständiga listan.
aspectRatio No string(enum) - Filtrera bilder efter proportioner. Värden: "kvadrat" (ungefär 1:1), "bred" (breddhöjd > ), "hög" (höjdbredd > ). När den inte har angetts tillämpas ingen filtrering.
color No string(enum) - Filtrera bilder efter bildfärg. Värden: "colorOnly" (returnerar endast färgbilder), "monokrom" (returnerar endast svartvita bilder). När den inte har angetts tillämpas ingen filtrering.
safeSearch No string(enum) "strikt" Nivå av säker sökfiltrering. Värden: "off", "strict". Standardvärdet är "strikt".
imageSize No string(enum) - Filtrera bilder efter storlekskategori. Värden: "small" (<200x200px), "medium" (bredd eller höjd 200-500px), "large" (width or height >=500px), "extraLarge" (>1024x768px). Kan också använda pixelbegränsningar (maxHeight, minHeight, maxWidth, minWidth) för anpassade gränser. pixelbegränsningar har företräde framför imageSize när de är i konflikt. När den inte har angetts tillämpas ingen filtrering.
watermarkFree No boolean falskt Exkludera bilder med vattenstämpel. Standardvärdet är false.
maxHeight No integer - Maximal bildhöjd i bildpunkter. Används med imageSize för anpassade gränser.
minHeight No integer - Minsta bildhöjd i bildpunkter.
maxWidth No integer - Maximal bildbredd i bildpunkter.
minWidth No integer - Minsta bildbredd i bildpunkter.

Rubriker för begäran

Fält Type Description
host string Värd för Microsoft AI-API:er: api.microsoft.ai.
x-apikey eller auktorisering string Din API-nyckel eller Entra ID åtkomsttoken för autentisering.
innehållstyp string MIME-typ av begärandetext. Använd application/json.

Svar

ImagesResponse

Fält Type Description
imageResults matris med ImageResult Lista över bildresultat.
instrumentationClickBase string Bas-URL för att klicka på ping-begäranden. Lägg till ett instrumentationSuffix värde från ett resultatobjekt för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing. Obs! Användarklick kan också loggas med url-omdirigering. När omdirigering har aktiverats krävs ingen åtgärd för att logga användarklickningar och instrumentationClickBase tas inte med i svaret. Se instrumenteringsguiden för installationsinstruktioner.
instrumentationCitationBase string Bas-URL för LLM-loggens pingbegäranden. Lägg till en DATA-nyttolast för att skapa den fullständiga ping-URL:en. Finns endast för program med profilflaggan EnableInstrumentationPing.
traceId string Spårnings-ID för felsökning och spårning.

ImageResult

Fält Type Description
title string Bildens rubrik.
url string Käll-URL:en för bilden. För Kina-användare med URL-omdirigering aktiverat innehåller det här fältet i stället samma omdirigerings-URL som clickUrl.
domain string Målvärden för resultatet. Returneras endast för Kina-användare med URL-omdirigering aktiverat.
hostPageUrl string URL:en för webbsidan som är värd för avbildningen.
caption string Genererad beskrivning av bilden.
width integer Bildens bredd i bildpunkter.
height integer Bildens höjd, i bildpunkter.
thumbnailUrl string Bildens url för miniatyrkälla.
lastUpdatedAt string Det senast uppdaterade datumet för avbildningen följer ISO8601 format.
isAdult boolean Anger om innehållet är vuxet innehåll.
clickUrl string Omdirigerings-URL som proxyservrar klickar genom Bing. Visas endast när klickomdirigering är aktiverat.
instrumentationSuffix string Suffix som ska läggas till i instrumentations-ping-URL-basen för det här resultatobjektet. Används som K-värde för både instrumentations-ping-URL:en och clickUrl omdirigeringen. Presentera när instrumentations ping är aktiverat.

Felkoder

Statuskod Felkategori Description Vanliga orsaker
200 Success Begäran lyckades. -
400 Felaktig förfrågan Ogiltiga parametrar för begäran. Obligatoriska fält saknas, ogiltiga parametervärden, felaktigt formaterad JSON
401 Behörighet saknas Autentiseringen misslyckades eller saknas. Ogiltig API-nyckel, x-apikey-huvud saknas
403 Ej tillåtet Giltiga autentiseringsuppgifter men otillräckliga behörigheter. API-nyckeln saknar nödvändiga behörigheter
410 Borta HTTPS krävs. Begäran som görs via HTTP i stället för HTTPS
415 Medietyp som inte stöds Innehållstypen stöds inte. Rubrik av innehållstyp saknas eller är felaktig
429 För många begäranden Hastighetsgränsen har överskridits. För många begäranden i tidsfönstret
500 Internt serverfel Oväntat serverfel. Problem med tillfällig server
503 Tjänsten är inte tillgänglig Tjänsten är inte tillgänglig för tillfället. Underhåll eller tillfälligt avbrott
504 Tidsgräns för gateway Tidsgränsen för begäran har överskridits. Timeout för överordnad tjänst

Detaljerad vägledning för felhantering finns i Felhantering.

Se även:Sök efter webbsökningsvideor | | Sök efter | nyhetssökning | MCP

  • Uppdaterades senast