WebOperations Klasa
Operacje WebOperations.
Nie należy tworzyć wystąpienia bezpośrednio tej klasy, ale utworzyć wystąpienie klienta, które utworzy je dla Ciebie i dołączyć jako atrybut.
- Dziedziczenie
-
builtins.objectWebOperations
Konstruktor
WebOperations(client, config, serializer, deserializer)Parametry
- client
Klient żądań obsługi.
- config
Konfiguracja klienta usługi.
- serializer
Serializator modelu obiektów.
- deserializer
Deserializator modelu obiektów.
Zmienne
- x_bing_apis_sdk
Aktywuj zgodność struktury Swagger. Stała wartość: "true".
Metody
| search |
Interfejs API wyszukiwania w sieci Web umożliwia wysyłanie zapytania wyszukiwania do usługi Bing i uzyskiwanie wyników wyszukiwania, które zawierają linki do stron internetowych, obrazów i nie tylko. |
search
Interfejs API wyszukiwania w sieci Web umożliwia wysyłanie zapytania wyszukiwania do usługi Bing i uzyskiwanie wyników wyszukiwania, które zawierają linki do stron internetowych, obrazów i nie tylko.
search(query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, answer_count=None, country_code=None, count=None, freshness=None, market='en-us', offset=None, promote=None, response_filter=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)Parametry
- query
- str
Termin zapytania wyszukiwania użytkownika. Termin może nie być pusty. Termin może zawierać operatory zaawansowane Bing. Aby na przykład ograniczyć wyniki do określonej domeny, użyj operatora site: .
- accept_language
- str
Rozdzielana przecinkami lista co najmniej jednego języka do użycia dla ciągów interfejsu użytkownika. Lista jest zorganizowana w malejącym porządku preferencji. Aby uzyskać dodatkowe informacje, w tym oczekiwany format, zobacz RFC2616. Ten nagłówek i parametr zapytania setLang wzajemnie się wykluczają; nie należy określać obu tych elementów. Jeśli ustawisz ten nagłówek, musisz także określić parametr zapytania cc. Usługa Bing użyje pierwszego obsługiwanego języka znalezionego z listy i połączy ten język z wartością parametru cc, aby określić rynek, aby zwrócić wyniki. Jeśli lista nie zawiera obsługiwanego języka, usługa Bing znajdzie najbliższy język i rynek, który obsługuje żądanie, i może użyć zagregowanego lub domyślnego rynku wyników zamiast określonego. Należy użyć tego nagłówka i parametru zapytania cc tylko wtedy, gdy określisz wiele języków; w przeciwnym razie należy użyć parametrów zapytania mkt i setLang. Ciąg interfejsu użytkownika to ciąg, który jest używany jako etykieta w interfejsie użytkownika. W obiektach odpowiedzi JSON istnieje bardzo niewiele ciągów interfejsu użytkownika. Wszystkie linki w obiektach odpowiedzi do Bing.com właściwości będą miały zastosowanie do określonego języka.
- pragma
- str
Usługa Bing domyślnie zwraca zawartość buforowaną, jeśli jest dostępna. Aby zapobiec zwracaniu zawartości buforowanej przez usługę Bing, dla nagłówka Pragma ustaw wartość no-cache (na przykład Pragma: no-cache).
- user_agent
- str
Agent użytkownika, od którego pochodzi żądanie. Usługa Bing korzysta z agenta użytkownika, aby zapewnić zoptymalizowane środowisko obsługi dla użytkowników urządzeń przenośnych. Mimo że jest to opcjonalne, zdecydowanie zachęcamy do określenia tego nagłówka. Agent użytkownika powinien być tym samym ciągiem, który będzie wysyłany przez dowolną często używaną przeglądarkę. Aby uzyskać informacje na temat agentów użytkownika, zobacz RFC 2616.
- client_id
- str
Usługa Bing używa tego nagłówka, aby zapewnić użytkownikom spójne zachowanie dla wywołań interfejsu API usługi Bing. Usługa Bing często testuje nowe funkcje i ulepszenia i używa identyfikatora klienta jako klucza do przypisywania ruchu dla różnych pakietów testowych. Jeśli nie będziesz używać tego samego identyfikatora klienta dla użytkownika w wielu żądaniach, usługa Bing może przypisać użytkownika do różnych, konfliktowych pakietów testowych. Przypisanie do wielu konfliktowych pakietów testowych może prowadzić do niespójnego środowiska użytkownika. Jeśli na przykład drugie żądanie ma przypisany inny pakiet testowy, niż pierwsze, środowisko obsługi może być nieoczekiwane. Ponadto usługa Bing może użyć identyfikatora klienta, aby dostosować wyniki internetowe do historii wyszukiwania tego identyfikatora klienta, zapewniając bogatsze środowisko dla użytkownika. Usługa Bing używa także tego nagłówka, aby ulepszyć pozycjonowanie wyników, analizując aktywność generowaną przez identyfikator klienta. Ulepszenia istotności pomagają zwiększyć jakość wyników dostarczanych przez interfejsy API usługi Bing, co w rezultacie daje wyższą częstotliwość kliknięć dla użytkownika interfejsu API. WAŻNE: Mimo że ten nagłówek jest opcjonalny, można go uważać za wymagany. Utrwalenie identyfikatora klienta dla wielu żądań dla połączenia tego samego użytkownika końcowego i urządzenia umożliwia (1) zapewnienie użytkownikowi interfejsu API spójnego środowiska obsługi oraz (2) uzyskanie wyższej częstotliwości kliknięć dzięki lepszej jakość wyników z interfejsów API usługi Bing. Każdy użytkownik, który korzysta z Twojej aplikacji na urządzeniu, musi mieć unikatowy identyfikator klienta wygenerowany przez usługę Bing. Jeśli nie uwzględnisz tego nagłówka w żądaniu, usługa Bing wygeneruje identyfikator i zwróci go w nagłówku odpowiedzi X-MSEdge-ClientID. Jedyną sytuacją, w której NIE należy uwzględniać tego nagłówka w żądaniu, jest pierwsze użycie Twojej aplikacji przez danego użytkownika na danym urządzeniu. Używaj identyfikatora klienta dla każdego żądania interfejsu API usługi Bing, które Twoja aplikacja wykonuje dla tego użytkownika na danym urządzeniu. Utrwal identyfikator klienta. Aby utrwalić identyfikator w aplikacji przeglądarki, użyj trwałego pliku cookie HTTP, aby mieć pewność, że dany identyfikator będzie używany we wszystkich sesjach. Nie należy używać plików cookie sesji. W przypadku innych aplikacji, takich jak aplikacje mobilne, użyj magazynu trwałego urządzenia, aby utrwalić identyfikator. Następnym razem, gdy użytkownik będzie używać Twojej aplikacji na tym urządzeniu, uzyskaj utrwalony identyfikator klienta. Odpowiedzi Bing mogą lub nie mogą zawierać tego nagłówka. Jeśli odpowiedź zawiera ten nagłówek, przechwyć identyfikator klienta i używaj go dla wszystkich kolejnych żądań usługi Bing dla tego użytkownika na tym urządzeniu. Jeśli dołączysz identyfikator X-MSEdge-ClientID, nie możesz uwzględnić plików cookie w żądaniu.
- client_ip
- str
Adres IPv4 lub IPv6 na urządzeniu klienckim. Adres IP jest używany w celu odnalezienia lokalizacji użytkownika. Usługa Bing używa informacji o lokalizacji, aby określić sposób bezpiecznego wyszukiwania. Mimo że jest to opcjonalne, zaleca się, aby zawsze określać ten nagłówek i nagłówek X-Search-Location. Nie należy zaciemniać adres (na przykład zamieniając ostatni oktet na 0). Zaciemnianie adresu powoduje, że ustalona lokalizacja nie jest nawet przybliżona do rzeczywistej lokalizacji urządzenia, przez co usługa Bing może zwracać błędne wyniki.
- location
- str
Rozdzielana średnikami lista par klucz/wartość, które opisują geograficzną lokalizację klienta. Usługa Bing używa informacji o lokalizacji, aby określić sposób bezpiecznego wyszukiwania i aby zwracać odpowiednią zawartość lokalną. Określ parę klucz/wartość jako :. Poniżej przedstawiono klucze, które służą do określania lokalizacji użytkownika. lat (wymagane): szerokość geograficzna lokalizacji klienta w stopniach. Szerokość geograficzna musi być większa niż lub równa -90.0 i mniejsza niż lub równa +90.0. Wartości ujemne wskazują południową szerokość geograficzną, a wartości dodatnie wskazują północną szerokość geograficzną. long (wymagane): długość geograficzna lokalizacji klienta w stopniach. Długość geograficzna musi być większa niż lub równa -180.0 i mniejsza niż lub równa +180.0. Wartości ujemne wskazują zachodnią długość geograficzną, a wartości dodatnie wskazują wschodnią długość geograficzną. re (wymagane): promień w metrach, który określa poziomą dokładność współrzędnych. Przekaż wartość zwróconą przez usługę lokalizacji urządzenia. Typowe wartości mogą wynosić 22 m dla sieci GPS/Wi-Fi, 380 m dla triangulacji wieży sieci komórkowej i 18 000 m dla wstecznego wyszukiwania adresu IP. ts (opcjonalnie): sygnatura czasowa UTC systemu UNIX, kiedy klient znajdował się w lokalizacji. (Sygnatura czasowa systemu UNIX to liczba sekund od 1 stycznia 1970 r.). head (opcjonalnie): względny kierunek lub kierunek podróży klienta. Określ kierunek ruchu jako liczbę stopni z zakresu od 0 do 360, zliczanych zgodnie z ruchem wskazówek zegara względem prawdziwej północy. Określ ten klucz tylko wtedy, gdy klucz sp jest niezerowy. sp (opcjonalnie): Szybkość pozioma (prędkość), w metrach na sekundę, że urządzenie klienckie podróżuje. alt (opcjonalnie): wysokość urządzenia klienckiego, w metrach. are (opcjonalnie): promień w metrach, który określa pionową dokładność współrzędnych. Określ ten klucz tylko wtedy, gdy określisz klawisz alt. Chociaż wiele kluczy jest opcjonalnych, tym więcej informacji podajesz, tym bardziej dokładne są wyniki lokalizacji. Mimo że jest to opcjonalne, zachęcamy do określenia lokalizacji geograficznej użytkownika. Podanie lokalizacji jest szczególnie ważne, jeśli adres IP klienta nie odzwierciedla precyzyjnie fizycznej lokalizacji użytkownika (na przykład, jeśli klient korzysta z sieci VPN). Aby uzyskać optymalne wyniki należy uwzględnić ten nagłówek i nagłówek X-MSEdge-ClientIP, a co najmniej należy uwzględnić ten nagłówek.
- answer_count
- int
Liczba odpowiedzi, które mają zostać uwzględnione. Odpowiedzi zwracane przez usługę Bing są oparte na klasyfikacji. Jeśli na przykład usługa Bing zwraca strony internetowe, obrazy, klipy wideo i powiązaneWyszukiwysze żądanie i ustawisz ten parametr na dwa (2), odpowiedź zawiera strony internetowe i obrazy. Jeśli parametr zapytania responseFilter został uwzględniony w tym samym żądaniu i ustawić go na strony internetowe i wiadomości, odpowiedź będzie zawierać tylko strony internetowe.
- country_code
- str
2-znakowy kod kraju dla kraju, z którego pochodzą wyniki. Ten interfejs API obsługuje tylko rynek Stany Zjednoczone. Jeśli określisz ten parametr zapytania, musi być on ustawiony na nas. Jeśli ustawisz ten parametr, musisz także określić nagłówek Accept-Language. Usługa Bing używa pierwszego obsługiwanego języka znalezionego z listy języków i połącz ten język z określonym kodem kraju, aby określić rynek, dla którego mają być zwracane wyniki. Jeśli lista języków nie zawiera obsługiwanego języka, usługa Bing znajdzie najbliższy język i rynek, który obsługuje żądanie, lub może użyć zagregowanego lub domyślnego rynku wyników zamiast określonego. Należy użyć tego parametru zapytania i parametru zapytania Accept-Language tylko wtedy, gdy określisz wiele języków; w przeciwnym razie należy użyć parametrów zapytania mkt i setLang. Ten parametr i parametr zapytania mkt wzajemnie się wykluczają — nie należy określać obu tych parametrów.
- count
- int
Liczba wyników wyszukiwania, które mają być zwracane w odpowiedzi. Wartość domyślna to 10, a maksymalna wartość to 50. Rzeczywista liczba dostarczona może być mniejsza niż żądana. Użyj tego parametru wraz z parametrem przesunięcia do wyników strony. Jeśli na przykład interfejs użytkownika wyświetla 10 wyników wyszukiwania na stronę, ustaw wartość 10 i przesunięcie na 0, aby uzyskać pierwszą stronę wyników. Dla każdej kolejnej strony przesunięcie przyrostowe o 10 (na przykład 0, 10, 20). Istnieje możliwość, aby wiele stron obejmowało niektóre nakładające się wyniki.
Filtruj wyniki wyszukiwania według następujących wartości wieku: Day — Zwraca strony internetowe odnalezione przez usługę Bing w ciągu ostatnich 24 godzin. Tydzień — zwraca strony internetowe odnalezione przez usługę Bing w ciągu ostatnich 7 dni. Miesiąc — zwraca strony internetowe odnalezione w ciągu ostatnich 30 dni. Ten filtr dotyczy tylko wyników stron internetowych, a nie innych wyników, takich jak wiadomości i obrazy. Możliwe wartości to: "Dzień", "Tydzień", "Miesiąc"
- market
- str
Rynek, z którego pochodzą wyniki. Zazwyczaj mkt to kraj, w którym użytkownik wysyła żądanie. Jednak może to być inny kraj, jeśli użytkownik nie znajduje się w kraju, w którym usługa Bing dostarcza wyniki. Rynek musi być w formie - . Na przykład en-US. Ciąg jest niewrażliwy na wielkość liter. Jeśli jest znany, zachęcamy do zawsze określenia rynku. Określenie rynku pomaga usłudze Bing w kierowaniu żądania i zwracaniu odpowiedniej i optymalnej odpowiedzi. Jeśli określisz rynek, który nie jest wymieniony w kodach rynkowych, usługa Bing używa najlepszego odpowiedniego kodu rynku na podstawie wewnętrznego mapowania, które podlega zmianie. Ten parametr i parametr zapytania cc wykluczają się wzajemnie — nie należy określać obu parametrów.
- offset
- int
Przesunięcie oparte na zerach, które wskazuje liczbę wyników wyszukiwania do pominięcia przed zwróceniem wyników. Wartość domyślna to 0. Przesunięcie powinno być mniejsze niż (totalEstimatedMatches — count). Użyj tego parametru wraz z parametrem count, aby stronicować wyniki. Jeśli na przykład interfejs użytkownika wyświetla 10 wyników wyszukiwania na stronę, ustaw wartość 10 i przesunięcie na 0, aby uzyskać pierwszą stronę wyników. Dla każdej kolejnej strony przesunięcie przyrostowe o 10 (na przykład 0, 10, 20). istnieje możliwość, aby wiele stron obejmowało niektóre nakładające się wyniki.
- promote
- list[str lub AnswerType]
Rozdzielana przecinkami lista odpowiedzi, które mają zostać uwzględnione niezależnie od ich klasyfikacji. Jeśli na przykład ustawisz wartość answerCount) na dwie (2), aby usługa Bing zwróciła dwie pierwsze sklasyfikowane odpowiedzi, ale chcesz również, aby odpowiedź zawierała wiadomości, ustawisz podwyższanie poziomu do wiadomości. Jeśli najczęściej oceniane odpowiedzi to strony internetowe, obrazy, filmy wideo i powiązaneSearches, odpowiedź zawiera strony internetowe i obrazy, ponieważ wiadomości nie są sklasyfikowaną odpowiedzią. Jeśli jednak ustawisz podwyższanie poziomu do wideo, usługa Bing podwyższy odpowiedź wideo na odpowiedź i zwróci strony internetowe, obrazy i filmy wideo. Odpowiedzi, które chcesz podwyższyć, nie są liczone względem limitu answerCount. Jeśli na przykład sklasyfikowane odpowiedzi to wiadomości, obrazy i filmy wideo, a następnie ustawisz wartość answerCount na wartość 1 i podwyższ poziom do wiadomości, odpowiedź zawiera wiadomości i obrazy. Jeśli natomiast sklasyfikowane odpowiedzi to filmy wideo, obrazy i wiadomości, odpowiedź zawiera filmy wideo i wiadomości. Możliwe wartości to Obliczenia, Obrazy, Wiadomości, RelatedSearches, SpellSuggestions, TimeZone, Wideo, Strony internetowe. Użyj tylko wtedy, gdy określisz wartość answerCount.
- response_filter
- list[str lub AnswerType]
Rozdzielana przecinkami lista odpowiedzi do uwzględnienia w odpowiedzi. Jeśli nie określisz tego parametru, odpowiedź zawiera wszystkie odpowiedzi wyszukiwania, dla których znajdują się odpowiednie dane. Możliwe wartości filtrów to Obliczenia, Obrazy, Wiadomości, RelatedSearches, SpellSuggestions, TimeZone, Wideo, Strony internetowe. Chociaż ten filtr może służyć do uzyskania pojedynczej odpowiedzi, należy zamiast tego użyć punktu końcowego specyficznego dla odpowiedzi, aby uzyskać bogatsze wyniki. Aby na przykład odbierać tylko obrazy, wyślij żądanie do jednego z punktów końcowych interfejsu API wyszukiwania obrazów. Odpowiedzi na temat funkcji RelatedSearches i SpellSuggestions nie obsługują oddzielnego punktu końcowego, takiego jak interfejs API wyszukiwania obrazów (zwraca je tylko interfejs API wyszukiwania w sieci Web). Aby uwzględnić odpowiedzi, które w przeciwnym razie zostaną wykluczone z powodu klasyfikacji, zobacz parametr zapytania podwyższania poziomu.
- safe_search
- str lub SafeSearch
Filtr używany do odfiltrowania zawartości dla dorosłych. Wyłączone: Zwracaj strony internetowe z tekstem dla dorosłych, obrazami lub filmami wideo. Moderowanie: Zwracanie stron internetowych z tekstem dla dorosłych, ale nie obrazów dla dorosłych ani filmów wideo. Ścisłe: nie zwracaj stron internetowych z tekstem dla dorosłych, obrazami ani filmami wideo. Wartość domyślna to Moderate. Jeśli żądanie pochodzi z rynku, w przypadku którego zasady Bing dla dorosłych wymagają ustawienia safeSearch na wartość Strict, usługa Bing ignoruje wartość safeSearch i używa wartości Strict. Jeśli używasz operatora witryny: zapytanie, istnieje prawdopodobieństwo, że odpowiedź może zawierać zawartość dla dorosłych niezależnie od tego, na czym jest ustawiony parametr zapytania safeSearch. Użyj witryny: tylko wtedy, gdy masz świadomość zawartości w witrynie i scenariusz obsługuje możliwość zawartości dla dorosłych. Możliwe wartości to: "Wyłączone", "Umiarkowane", "Strict"
- set_lang
- str
Język ciągów interfejsu użytkownika. Określ język przy użyciu 2-literowego kodu języka w standardzie ISO 639-1. Na przykład kod języka dla języka angielskiego to EN. Wartość domyślna to EN (język angielski). Mimo, że jest to opcjonalne, należy zawsze określić język. Zazwyczaj ustawiono dla zestawuLang ten sam język określony przez mkt, chyba że użytkownik chce, aby ciągi interfejsu użytkownika wyświetlane w innym języku. Ten parametr i nagłówek Accept-Language wykluczają się wzajemnie; nie należy określać obu tych elementów. Ciąg interfejsu użytkownika to ciąg, który jest używany jako etykieta w interfejsie użytkownika. W obiektach odpowiedzi JSON istnieje kilka ciągów interfejsu użytkownika. Ponadto wszelkie linki do właściwości witryny Bing.com w obiektach odpowiedzi także stosują określony język.
- text_decorations
- bool
Wartość logiczna określająca, czy ciągi wyświetlane powinny zawierać znaczniki dekoracji, takie jak znaki wyróżniania trafień. Jeśli wartość true, ciągi mogą zawierać znaczniki. Wartością domyślną jest false. Aby określić, czy używać znaków Unicode, czy tagów HTML jako znaczników, zobacz parametr zapytania textFormat.
- text_format
- str lub TextFormat
Typ znaczników do użycia na potrzeby dekoracji tekstu (zobacz parametr zapytania textDecorations). Możliwe wartości to Nieprzetworzone — użyj znaków Unicode, aby oznaczyć zawartość, która wymaga specjalnego formatowania. Znaki Unicode znajdują się w zakresie od E000 do E019. Na przykład usługa Bing używa wartości E000 i E001 do oznaczania początku i końca terminów zapytania na potrzeby wyróżniania trafień. HTML — użyj tagów HTML, aby oznaczyć zawartość, która wymaga specjalnego formatowania. Na przykład użyj tagów, aby wyróżnić terminy zapytania w ciągach wyświetlania. Wartość domyślna to Nieprzetworzone. W przypadku ciągów wyświetlania, które zawierają znaki HTML, które mogą być escapable, takie jak <, >i &, jeśli format textFormat jest ustawiony na HTML, usługa Bing unika znaków odpowiednio (na przykład < zostanie uniknięta wartość <). Możliwe wartości to: "Raw", "Html"
- operation_config
Przesłonięcia konfiguracji operacji.
Zwraca
SearchResponse lub ClientRawResponse, jeśli raw=true
Typ zwracany
Wyjątki
Atrybuty
models
models = <module 'azure.cognitiveservices.search.websearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\websearch\\models\\__init__.py'>
Azure SDK for Python