Referenční informace k rozhraní REST API pro vyhledávání obrázků

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

Ukázkový požadavek:

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 Typ Výchozí Description
query 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.
language 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 .
region No řetězec "US" 2písmenný kód země/oblasti, ze kterého by měly výsledky pocházet (např. "US", "JP", "CN"). Úplný seznam najdete v části Podporované oblasti .
aspectRatio No string(výčet) - Filtrování obrázků podle poměru stran Hodnoty: "čtverec" (přibližně 1:1), "široký" (výška šířky > ), "vysoká" (šířka výšky > ). Pokud není nastaveno, není použito žádné filtrování.
color No string(výčet) - Filtrování obrázků podle barvy obrázku Hodnoty: "colorOnly" (vrátí pouze barevné obrázky), "monochromatické" (vrátí pouze černobílé obrázky). Pokud není nastaveno, není použito žádné filtrování.
safeSearch No string(výčet) "striktní" Úroveň bezpečného filtrování hledání Hodnoty: "off", "strict". Výchozí hodnota je "striktní".
imageSize No string(výčet) - Filtrování obrázků podle kategorie velikostí Hodnoty: "small" (<200x200px), "medium" (šířka nebo výška 200–500px), "large" (šířka nebo výška >=500px), "extraLarge" (>1024x768px). Lze také použít omezení pixelů (maxHeight, minHeight, maxWidth, minWidth) pro vlastní hranice; Omezení pixelů mají přednost před velikostí obrázků, když jsou v konfliktu. Pokud není nastaveno, není použito žádné filtrování.
watermarkFree No boolean Nepravda Vylučte obrázky s vodoznakem. Výchozí hodnota je nastavená na false.
maxHeight No integer - Maximální výška obrázku v pixelech Používá se s imageSize pro vlastní hranice.
minHeight No integer - Minimální výška obrázku v pixelech
maxWidth No integer - Maximální šířka obrázku v pixelech
minWidth No integer - Minimální šířka obrázku v pixelech

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

ImagesResponse

Field Typ Description
imageResults array of ImageResult Seznam výsledků obrázků
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í a sledování

ImageResult

Field Typ Description
title řetězec Název obrázku.
url řetězec Zdrojová adresa URL obrázku. 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.
domain ř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.
hostPageUrl řetězec Adresa URL webové stránky, která je hostitelem obrázku.
caption řetězec Vygenerovaný popis obrázku
width integer Šířka obrázku v pixelech.
height integer Výška obrázku v pixelech
thumbnailUrl řetězec Adresa URL zdroje miniatur obrázku.
lastUpdatedAt řetězec Datum poslední aktualizace obrázku se řídí formátem ISO8601.
isAdult boolean Určuje, jestli je obsah obsahem 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.

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 Search | Videos Search Search | Browse | News Search | MCP

  • Poslední aktualizace v