Dokumentacja interfejsu API REST wyszukiwania wiadomości

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

Przykładowe żądanie:

curl -X POST "https://api.microsoft.ai/v3/search/news" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "latest VC funding in tech",
    "maxResults": 10,
    "language": "en",
    "region": "US",
    "maxLength": 3000,
    "contentFormat": "passage"
  }'

Parameters

Parameter Required Typ Default Description
kwerenda Yes ciąg - Zapytanie wyszukiwania wyników wiadomości. Maksymalna długość to 1000 znaków.
maksWyniki No liczba całkowita 10 Maksymalna liczba wyników do zwrócenia. Wartość domyślna to 10. Wartość maksymalna to 20.
język 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", "GB" itp.). Aby uzyskać pełną listę, zobacz Obsługiwane regiony .
lokalizacja No ciąg - Informacje o lokalizacji w formacie "lat:<float>; long:<float>", np. "lat:40.753250; long:-74.003807".
contentFormat (format treści) No ciąg "fragment" ("tekst" z pełnym dostępem do dokumentu) passage Zwraca części każdego wyniku najbardziej istotne dla zapytania (zalecane do uziemienia). text html i markdown zwróć pełny dokument i zastosuj tylko do aplikacji z pełnym dostępem do dokumentu; zobacz Fragmenty i formaty zawartości. Ustaw je na każdym żądaniu.
maksymalna długość No liczba całkowita 3000 (10000 z pełnym dostępem do dokumentu) Maksymalna liczba znaków na content wynik, od 1 do 500000. Bez pełnego dostępu do content dokumentu jest co najwyżej 3000 znaków. Zobacz Wartości domyślne i limity. Ustaw je na każdym żądaniu.

Formaty zawartości

Ustaw contentFormat = passage , aby uzyskać części każdego wyniku najbardziej istotne dla zapytania, maksymalnie do maxLength znaków (3000 jest dobrym punktem wyjścia). Jest to zalecany format do uziemienia; zobacz Co to jest passage, i dlaczego go używać? w często zadawanych pytaniach. Aplikacje z pełnym dostępem do dokumentów mogą również żądać pełnego dokumentu jako text, html lub markdown; w przypadku innych aplikacji te formaty zwracają http 403. Zobacz Fragmenty i formaty zawartości.

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ź

Odpowiedź na wiadomości

Pole Typ Description
newsResults tablica wiadomościResult Lista wyników artykułu z wiadomościami.
instrumentacjaClickBase 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 .
instrumentacjaCitationBase 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 na potrzeby debugowania.

newsResult

Pole Typ Description
title ciąg Tytuł wiadomości.
url ciąg Źródłowy adres URL artykułu z wiadomościami. W przypadku użytkowników Chin z włączonym przekierowywaniem adresu URL to pole zawiera ten sam adres URL przekierowania co clickUrl.
domena ciąg Host docelowy dla wyniku. Zwracane tylko dla użytkowników z Chin z włączonym przekierowywaniem adresów URL.
zawartość ciąg Szczegółowa zawartość strony internetowej (czyli uziemienie) wyniku wiadomości.
miniatura obiekt thumbnail Miniatura artykułu z wiadomościami.
lastUpdatedAt ciąg Data ostatniej aktualizacji wiadomości w formacie UTC ISO8601.
crawledAt ciąg Data ostatniego przeszukania wiadomości jest zgodna z formatem ISO8601.
język ciąg Język artykułu informacyjnego używa kodu języka ISO 639-1.
przesłać źródło ciąg nazwa Publisher, taka jak "USA TODAY | MSN", "CNN", itp.
isAdult boolean Wskazuje, czy zawartość jest 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.
instrumentacjaSuffix 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.

Note

lastUpdatedAt pole jest opcjonalne — oznacza to, że dla tego pola może być widoczna pusta wartość.

miniatura

Pole Typ Description
url ciąg URL miniaturki.
width liczba całkowita Szerokość miniatury w pikselach.
height liczba całkowita Wysokość miniatury w pikselach.

Note

thumbnail jest również opcjonalnym obiektem odpowiedzi — może nie być dostępny dla niektórych wyników wiadomości.

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 InternecieWyszukiwanie | obrazów Wyszukiwanie | | obrazówMCP

  • Ostatnia aktualizacja o