Dokumentacja interfejsu API REST wyszukiwania obrazów

Punkt końcowy:POST https://api.microsoft.ai/v3/search/images

Przykładowe żądanie:

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 Default Description
query Yes ciąg - Ciąg zapytania wyszukiwania. Maksymalna długość to 1000 znaków.
maxResults No liczba całkowita 30 Maksymalna liczba wyników do zwrócenia. Wartość domyślna to 30, a wartość maksymalna to 30.
language No ciąg "en" Dwuliterowy kod języka ISO 639-1 dla języka interfejsu w wynikach wyszukiwania. Aby uzyskać pełną listę, zobacz Obsługiwane języki .
region No ciąg "US" Dwuliterowy kod kraju/regionu, z którego powinny pochodzić wyniki (np. "USA", "JP", "CN"). Aby uzyskać pełną listę, zobacz Obsługiwane regiony .
aspectRatio No string(wyliczenie) - Filtruj obrazy według współczynnika proporcji. Wartości: "kwadrat" (około 1:1), "szeroki" (wysokość szerokości>), "wysoki" (szerokość).> Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.
color No string(wyliczenie) - Filtruj obrazy według koloru obrazu. Wartości: "colorOnly" (zwracane są tylko obrazy kolorów), "monochromatyczne" (zwracają tylko czarne i białe obrazy). Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.
safeSearch No string(wyliczenie) "strict" Poziom filtrowania bezpiecznego wyszukiwania. Wartości: "off", "strict". Wartość domyślna to "strict".
imageSize No string(wyliczenie) - Filtruj obrazy według kategorii rozmiaru. Wartości: "small" (<200x200px), "medium" (width or height 200-500px), "large" (width or height >=500px), "extraLarge" (>1024x768px). Może również używać ograniczeń pikseli (maxHeight, minHeight, maxWidth, minWidth) dla granic niestandardowych; ograniczenia pikseli mają pierwszeństwo przed rozmiarem obrazu, gdy powodują konflikt. Jeśli nie zostanie ustawiona, nie zostanie zastosowane filtrowanie.
watermarkFree No boolean false Wyklucz obrazy ze znakiem wodnym. Wartość domyślna to „false”.
maxHeight No liczba całkowita - Maksymalna wysokość obrazu w pikselach. Używany z właściwością imageSize dla granic niestandardowych.
minHeight No liczba całkowita - Minimalna wysokość obrazu w pikselach.
maxWidth No liczba całkowita - Maksymalna szerokość obrazu w pikselach.
minWidth No liczba całkowita - Minimalna szerokość obrazu w pikselach.

Nagłówki żądań

Pole Typ Description
gospodarz ciąg Host dla interfejsów API sztucznej inteligencji Microsoft: api.microsoft.ai.
x-apikey lub authorization ciąg Klucz interfejsu API lub token dostępu Entra ID na potrzeby uwierzytelniania.
typ zawartości ciąg Typ MIME treści żądania. Użyj application/json.

Odpowiedź

ObrazyResponse

Pole Typ Description
imageResults tablica wartości ImageResult Lista wyników obrazu.
instrumentationClickBase ciąg Podstawowy adres URL kliknięcia żądań ping. instrumentationSuffix Dołącz wartość z elementu wyniku, aby utworzyć pełny adres URL ping. Tylko dla aplikacji z flagą profilu EnableInstrumentationPing. Uwaga: kliknięcia użytkownika można również rejestrować przy użyciu przekierowania adresu URL. Po włączeniu przekierowania nie jest wymagana żadna akcja rejestrowania kliknięć użytkownika i instrumentationClickBase nie zostanie uwzględniona w odpowiedzi. Aby uzyskać instrukcje dotyczące konfiguracji, zobacz Przewodnik instrumentacji .
instrumentationCitationBase ciąg Podstawowy adres URL dla żądań ping dziennika LLM. Dołącz ładunek DANYCH, aby utworzyć pełny adres URL polecenia ping. Tylko dla aplikacji z flagą profilu EnableInstrumentationPing.
traceId ciąg Identyfikator śledzenia do debugowania i śledzenia.

ImageResult

Pole Typ Description
title ciąg Tytuł obrazu.
url ciąg Źródłowy adres URL obrazu. W przypadku użytkowników Chin z włączonym przekierowywaniem adresu URL to pole zawiera ten sam adres URL przekierowania co clickUrl.
domain ciąg Host docelowy dla wyniku. Zwracane tylko dla użytkowników z Chin z włączonym przekierowywaniem adresów URL.
hostPageUrl ciąg Adres URL strony internetowej, która hostuje obraz.
caption ciąg Wygenerowany opis obrazu.
width liczba całkowita Szerokość obrazu w pikselach.
height liczba całkowita Wysokość obrazu w pikselach.
thumbnailUrl ciąg Adres URL źródła miniatur obrazu.
lastUpdatedAt ciąg Data ostatniej aktualizacji obrazu jest zgodna z formatem ISO8601.
isAdult boolean Wskazuje, czy zawartość jest treścią dla dorosłych.
clickUrl ciąg Adres URL przekierowania, który serwer proxy klika za pośrednictwem usługi Bing. Występuje tylko po włączeniu przekierowania kliknięcia.
instrumentationSuffix ciąg Sufiks dołączany do bazy adresów URL ping instrumentacji dla tego elementu wyniku. Używana jako wartość K zarówno dla adresu URL polecenia ping instrumentacji, jak i przekierowania clickUrl . Występuje, gdy polecenie ping instrumentacji jest włączone.

Kody błędów

Kod stanu Kategoria błędów Description Typowe przyczyny
200 Powodzenie Żądanie zakończyło się pomyślnie. -
400 Nieprawidłowe żądanie Nieprawidłowe parametry żądania. Brak wymaganych pól, nieprawidłowe wartości parametrów, nieprawidłowo sformułowany kod JSON
401 Brak autoryzacji Uwierzytelnianie nie powiodło się lub nie powiodło się. Nieprawidłowy klucz interfejsu API, brak nagłówka x-apikey
403 Dostęp zabroniony Prawidłowe poświadczenia, ale niewystarczające uprawnienia. Klucz interfejsu API nie ma wymaganych uprawnień
410 Zniknęło Wymagany protokół HTTPS. Żądanie wykonane za pośrednictwem protokołu HTTP zamiast HTTPS
415 Nieobsługiwany typ nośnika Typ zawartości nie jest obsługiwany. Brak lub niepoprawny nagłówek typu zawartości
429 Zbyt wiele żądań Przekroczono limit szybkości. Zbyt wiele żądań w przedziale czasu
500 Wewnętrzny błąd serwera Nieoczekiwany błąd serwera. Tymczasowy problem z serwerem
503 Usługa niedostępna Usługa jest tymczasowo niedostępna. Konserwacja lub tymczasowa awaria
504 Przekroczono limit czasu bramy Upłynął limit czasu żądania. Limit czasu usługi nadrzędnej

Aby uzyskać szczegółowe wskazówki dotyczące obsługi błędów, zobacz Obsługa błędów.


Zobacz również:Wyszukiwanie wideo wyszukiwania | | w InterneciePrzeglądaj | wyszukiwanie | wiadomościMCP