CustomInstanceOperations Osztály
CustomInstanceOperations műveletek.
Ne példányosítsa közvetlenül ezt az osztályt, hanem hozzon létre egy ügyfélpéldányt, amely létrehozza és attribútumként csatolja.
- Öröklődés
-
builtins.objectCustomInstanceOperations
Konstruktor
CustomInstanceOperations(client, config, serializer, deserializer)Paraméterek
- client
Ügyfél a szolgáltatáskérésekhez.
- config
A szolgáltatásügyfél konfigurálása.
- serializer
Egy objektummodell szerializálója.
- deserializer
Objektummodell-deszerializáló.
Változók
- x_bing_apis_sdk
Aktiválja a Swagger-megfelelőséget. Állandó érték: "igaz".
Metódusok
| search |
A Custom Search API lehetővé teszi, hogy keresési lekérdezést küldjön a Bingnek, és visszaállítsa az egyéni webes nézetben talált weblapokat. |
search
A Custom Search API lehetővé teszi, hogy keresési lekérdezést küldjön a Bingnek, és visszaállítsa az egyéni webes nézetben talált weblapokat.
search(custom_config, query, accept_language=None, user_agent=None, client_id=None, client_ip=None, location=None, country_code=None, count=None, market='en-us', offset=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- query
- str
A felhasználó keresési lekérdezési kifejezése. Lehet, hogy a kifejezés nem üres. A kifejezés tartalmazhat Bing Advanced Operátorokat. Ha például egy adott tartományra szeretné korlátozni az eredményeket, használja a site: operátort.
- accept_language
- str
A felhasználói felületi sztringekhez használandó nyelvek vesszővel tagolt listája. A lista prioritás szerinti csökkenő sorrendben jelenik meg. További információ, beleértve a várt formátumot is, lásd: RFC2616. Ez a fejléc és a setLang lekérdezési paraméter kölcsönösen kizáró; ne adja meg mindkettőt. Ha beállítja ezt a fejlécet, akkor a cc lekérdezési paramétert is meg kell adnia. A Bing az első támogatott nyelvet fogja használni, amelyet a listából talál, és kombinálja a nyelvet a cc paraméter értékével annak meghatározásához, hogy melyik piac adja vissza az eredményeket. Ha a lista nem tartalmaz támogatott nyelvet, a Bing megkeresi a kérést támogató legközelebbi nyelvet és piacot, és a megadott helyett egy összesített vagy alapértelmezett piacot használhat az eredményekhez. Ezt a fejlécet és a másolatot kap lekérdezési paramétert csak akkor használja, ha több nyelvet ad meg; ellenkező esetben az mkt és a setLang lekérdezési paramétereket kell használnia. A felhasználóifelület-sztring egy olyan sztring, amelyet feliratként használnak a felhasználói felületen. A JSON-válaszobjektumokban nagyon kevés felhasználói felületi sztring található. A válaszobjektumok Bing.com tulajdonságokra mutató hivatkozásai a megadott nyelvet alkalmazzák.
- user_agent
- str
A kérelmet küldő felhasználói ügynök. A Bing arra használja a felhasználói ügynököt, hogy optimalizált élményt nyújtson a mobilfelhasználóknak. Bár nem kötelező, javasoljuk, hogy mindig adja meg ezt a fejlécet. A felhasználói ügynöknek ugyanaz a sztringnek kell lennie, amelyet a gyakran használt böngészők küldenek. A felhasználói ügynökökkel kapcsolatos információért lásd: RFC 2616.
- client_id
- str
A Bing ezt a fejlécet használja ahhoz, hogy következetes viselkedést biztosítson a felhasználók számára a Bing API-hívásaiban. A Bing gyakran tesztel új funkciókat és fejlesztéseket, és az ügyfél-azonosítót használja kulcsként ahhoz, hogy a tesztcsomagokhoz rendelje a forgalmat. Ha a kérelmekben nem ugyanazt az ügyfél-azonosítót használja egy adott felhasználóhoz, előfordulhat, hogy a Bing több ütköző tesztcsomaghoz rendeli hozzá a felhasználót. Az ütköző tesztcsomagok hozzárendelése inkonzisztens felhasználói élményhez vezethet. Például ha a második kérelemhez más tesztcsomag van hozzárendelve, mint az elsőhöz, az váratlan működést eredményezhet. A Bing az ügyfél-azonosítóval is testre szabhatja a webes találatokat az ügyfél-azonosító keresési előzményeihez, így gazdagabb felhasználói élményt nyújtva a felhasználónak. A Bing továbbá az ügyfél-azonosító által létrehozott tevékenységek elemzésével az eredmények rangsorolásának javítására is használja a fejlécet. A relevancia javítása segít abban, hogy a Bing API-k jobb minőségű eredményeket biztosítsanak, ami pedig lehetővé teszi a magasabb átkattintási arányt az API fogyasztója számára. FONTOS: Bár nem kötelező, javasoljuk, hogy tekintse annak ezt a fejlécet. Ha ugyanahhoz a végfelhasználóhoz és eszközkombinációhoz több kérelemben is megőrzi az ügyfél-azonosítót, azzal lehetővé teszi, 1) hogy az API fogyasztójának egységes felhasználói élményben legyen része, és 2) magasabb legyen az átkattintási arány a Bing API-k jobb minőségű eredményeinek köszönhetően. Minden felhasználónak, aki használja az eszközön lévő alkalmazást, rendelkeznie kell egy egyedi, Bing által létrehozott ügyfél-azonosítóval. Ha nem foglalja bele ezt a fejlécet a kérelembe, a Bing létrehoz egy azonosítót, és visszaküldi azt az X-MSEdge-ClientID válaszfejlécben. Ezt a fejlécet csak akkor NEM szabad belefoglalni a kérelembe, amikor a felhasználó először használja az alkalmazást azon az eszközön. Használja az ügyfél-azonosítót minden olyan Bing API-kéréshez, amelyet az alkalmazás intéz a felhasználó kapcsán az eszközön. Őrizze meg az ügyfél-azonosítót. Az azonosító böngészőalkalmazásban való megőrzéséhez használjon egy állandó HTTP-cookie-t, amely biztosítja, hogy minden munkamenetben ez az azonosító legyen használva. Ne használjon munkamenet-cookie-t. Más alkalmazások, például a mobilalkalmazások esetében az azonosító megőrzéséhez használja az eszköz állandó tárolóját. Kérje le a megőrzött ügyfél-azonosítót, amikor a felhasználó ismét használja az alkalmazást az eszközön. A Bing-válaszok tartalmazhatják vagy nem tartalmazzák ezt a fejlécet. Ha a válasz tartalmazza ezt a fejlécet, rögzítse az ügyfél-azonosítót, és használja azt a felhasználó összes további Bing-kérelméhez az adott eszközön. Ha az X-MSEdge-ClientID azonosítót is tartalmazza, nem tartalmazhat cookie-kat a kérelemben.
- client_ip
- str
Az ügyféleszköz IPv4- vagy IPv6-címe. Az IP-cím a felhasználó tartózkodási helyének felderítésére szolgál. A Bing arra használja a helyadatokat, hogy meghatározza a biztonságos keresés viselkedését. Bár nem kötelező, javasoljuk, hogy mindig adja meg ezt a fejlécet és az X-Search-Location fejlécet. Ne rejtse el a címet (például úgy, hogy 0-ra módosítja az utolsó oktettet). Ha elrejti a címet, a tartózkodási hely távol fog esni az eszköz tényleges helyétől, amely ahhoz vezethet, hogy a Bing téves eredményeket fog megadni.
- location
- str
Kulcs/érték párok pontosvesszővel elválasztott listája, amely leírja az ügyfél földrajzi helyét. A Bing arra használja a helyadatokat, hogy meghatározza a biztonságos keresés viselkedését, illetve releváns helyi tartalmakat adjon vissza. Adja meg a kulcs/érték pár értékét a következőként: : . Az alábbiakban láthatja a felhasználó tartózkodási helyének megadására használt kulcsokat. lat (kötelező): Az ügyfél helyének szélessége fokban. A földrajzi szélesség nem lehet -90,0 foknál kisebb és +90,0 foknál nagyobb. A negatív értékek a déli szélességeket, a pozitív értékek pedig az északi szélességeket jelölik. long (kötelező): Az ügyfél helyének hosszúsága fokban. A földrajzi hosszúság nem lehet -180,0 foknál kisebb és +180,0 foknál nagyobb. A negatív értékek a nyugati hosszúságokat, a pozitív értékek pedig a keleti hosszúságokat jelölik. re (kötelező): A mérőben megadott sugár, amely a koordináták vízszintes pontosságát határozza meg. Adja át az eszköz helymeghatározási szolgáltatása által visszaadott értéket. A tipikus érték GPS/Wi-Fi esetén 22 m, telefontoronnyal végzett háromszögelés esetén 380 m, fordított IP-keresés esetén pedig 18 000 m. ts (nem kötelező): Az UTC UNIX időbélyege, amely azt jelzi, hogy mikor volt az ügyfél a helyen. (A UNIX időbélyege az 1970. január 1. óta eltelt másodpercek száma.) head (nem kötelező): Az ügyfél relatív címsora vagy utazási iránya. Az utazás irányt fokban adja meg 0 és 360 között, a tényleges északhoz képest az óramutató járásával megegyező irányban számítva. Csak akkor adja meg ezt a kulcsot, ha az sp kulcs nem nulla. sp (nem kötelező): Az ügyféleszköz által mért vízszintes sebesség (sebesség) méterben. alt (nem kötelező): Az ügyféleszköz magasságát mérőben. are (nem kötelező): A koordináták függőleges pontosságát mérőben megadott sugár. Csak akkor adja meg ezt a kulcsot, ha a helyettesítő kulcsot adja meg. Bár a kulcsok közül sok nem kötelező, minél több információt ad meg, annál pontosabbak a helyadatok. Bár nem kötelező, javasoljuk, hogy mindig adja meg a felhasználó földrajzi helyét. Különösen fontos megadni a helyet, ha az ügyfél IP-címe nem tükrözi pontosan a felhasználó fizikai helyét (például ha az ügyfél VPN-t használ). Az optimális eredmény érdekében foglalja bele a kérelembe ezt a fejlécet és az X-MSEdge-ClientIP fejlécet, de legalább ezt a fejlécet.
- country_code
- str
Annak az országnak a két karakterből álló országkódja, ahonnan az eredmények származnak. Ez az API csak a Egyesült Államok piacot támogatja. Ha megadja ezt a lekérdezési paramétert, azt nekünk kell beállítania. Ha beállítja ezt a paramétert, az Accept-Language fejlécet is meg kell adnia. A Bing az első támogatott nyelvet használja, amelyet a nyelvek listájából talál, és kombinálja ezt a nyelvet az Ön által megadott országkóddal annak meghatározásához, hogy melyik piac adja vissza az eredményeket. Ha a nyelvek listája nem tartalmaz támogatott nyelvet, a Bing megkeresi a kérést támogató legközelebbi nyelvet és piacot, vagy egy adott helyett összesített vagy alapértelmezett piacot használhat az eredményekhez. Ezt a lekérdezési paramétert és a Accept-Language lekérdezési paramétert csak akkor használja, ha több nyelvet ad meg; ellenkező esetben az mkt és a setLang lekérdezési paramétereket kell használnia. Ez a paraméter és az mkt lekérdezési paraméter kölcsönösen kizáró – ne adja meg mindkettőt.
- count
- int
A válaszban visszaadandó keresési eredmények száma. Az alapértelmezett érték 10, a maximális érték pedig 50. Előfordulhat, hogy a ténylegesen kézbesített szám kisebb a kértnél. Használja ezt a paramétert az eltolás paraméterrel együtt az oldaleredmények eléréséhez. Ha például a felhasználói felület oldalanként 10 találatot jelenít meg, állítsa a darabszámot 10-re, az eltolást pedig 0-ra a találatok első oldalának lekéréséhez. Minden további oldal esetében növekményes eltolás 10-zel (például 0, 10, 20). Több oldal is tartalmazhat átfedést az eredmények között.
- market
- str
A piac, ahonnan az eredmények származnak. Az mkt általában az az ország, ahonnan a felhasználó kérést küld. Más ország is lehet azonban, ha a felhasználó nem olyan országban található, ahol a Bing eredményeket ad. A piacnak formában kell lennie. Például: en-US. A sztring nem különbözteti meg a kis- és nagybetűket. Ha ismert, javasoljuk, hogy mindig határozza meg a piacot. Ha megadja a piacot, azzal elősegíti, hogy a Bing a kérelmet továbbítva megfelelő, optimális választ adjon vissza. Ha olyan piacot ad meg, amely nem szerepel a Piaci kódok között, a Bing egy olyan belső leképezésen alapuló legjobb piaci kódot használ, amely változhat. Ez a paraméter és a másolatot kap lekérdezési paraméter kölcsönösen kizáró – ne adja meg mindkettőt.
- offset
- int
A nulla alapú eltolás, amely azt jelzi, hogy hány keresési találatot kell kihagyni az eredmények visszaadása előtt. Az alapértelmezett érték a 0. Az eltolásnak kisebbnek kell lennie, mint (totalEstimatedMatches - count). Használja ezt a paramétert a laperedmények count paraméterével együtt. Ha például a felhasználói felület oldalanként 10 találatot jelenít meg, állítsa a darabszámot 10-re, az eltolást pedig 0-ra a találatok első oldalának lekéréséhez. Minden további oldal esetében növekményes eltolás 10-zel (például 0, 10, 20). több oldal is tartalmazhat átfedést az eredmények között.
- safe_search
- str vagy SafeSearch
Felnőtt tartalmak szűrésére szolgáló szűrő. Kikapcsolva: Felnőtteknek szóló szöveget, képeket vagy videókat tartalmazó weblapokat ad vissza. Közepes: Felnőtteknek szóló szöveget tartalmazó weblapokat ad vissza, felnőtt képeket és videókat nem. Szigorú: Ne küldje vissza a felnőtteknek szóló szöveget, képeket vagy videókat tartalmazó weblapokat. Az alapértelmezett érték a Moderate. Ha a kérés olyan piacról érkezik, amelyhez a Bing felnőttkori szabályzata megköveteli, hogy a safeSearch értéke Strict legyen, a Bing figyelmen kívül hagyja a safeSearch értéket, és a Strict értéket használja. Ha a site: query operátort használja, előfordulhat, hogy a válasz felnőtt tartalmat tartalmaz, függetlenül attól, hogy a safeSearch lekérdezési paraméter mire van beállítva. Webhely használata: csak akkor, ha ismeri a webhely tartalmát, és a forgatókönyv támogatja a felnőtt tartalom lehetőségét. Lehetséges értékek: "Off", "Moderate", "Strict"
- set_lang
- str
A felhasználói felület sztringjeihez használni kívánt nyelv. A nyelv megadásához használja az ISO 639-1 kétbetűs nyelvkódját. Az angol nyelv nyelvkódja például az EN. Az alapértelmezett érték az EN (angol). Bár nem kötelező, javasoljuk, hogy mindig adja meg a nyelvet. ALang beállítást általában az mkt által megadott nyelvre kell beállítani, hacsak a felhasználó nem szeretné, hogy a felhasználói felület sztringjei más nyelven jelenjenek meg. Ez a paraméter és a Accept-Language fejléc kölcsönösen kizáró; ne adja meg mindkettőt. A felhasználóifelület-sztring egy olyan sztring, amelyet feliratként használnak a felhasználói felületen. A JSON-válaszobjektumok tartalmaznak néhány felhasználóifelület-sztringet. A válaszobjektumokban található, a Bing.com tulajdonságaira mutató hivatkozások is a megadott nyelvet alkalmazzák.
- text_decorations
- bool
Logikai érték, amely meghatározza, hogy a megjelenítési sztringeknek tartalmazniuk kell-e dekorációjelölőket, például találatkiemelési karaktereket. Ha igaz, a sztringek jelölőket is tartalmazhatnak. Az alapértelmezett érték hamis. Ha meg szeretné adni, hogy Unicode-karaktereket vagy HTML-címkéket használjon-e jelölőként, tekintse meg a textFormat lekérdezési paramétert.
- text_format
- str vagy TextFormat
A szövegdekorációkhoz használandó jelölők típusa (lásd a textDecorations lekérdezési paramétert). Lehetséges értékek: Nyers – Unicode-karakterek használatával jelölhet meg speciális formázást igénylő tartalmakat. A Unicode-karakterek az E000–E019 tartományban találhatók. A Bing például E000 és E001 használatával jelöli meg a lekérdezési kifejezések elejét és végét a találatok kiemeléséhez. HTML – HTML-címkék használatával jelölhet meg speciális formázást igénylő tartalmakat. Például címkékkel emelheti ki a lekérdezési kifejezéseket a megjelenítési sztringekben. Az alapértelmezett érték a Nyers. Az escapable HTML-karaktereket (például <, >és &) tartalmazó megjelenítési sztringek esetében, ha a textFormat HTML-ra van állítva, a Bing a megfelelő módon feloldja a karaktereket (például < a feloldása <). A lehetséges értékek a következők: "Raw", "Html"
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
Műveleti konfiguráció felülbírálásai.
Válaszok
SearchResponse vagy ClientRawResponse ha raw=true
Visszatérési típus
Kivételek
Attribútumok
models
models = <module 'azure.cognitiveservices.search.customsearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\customsearch\\models\\__init__.py'>
Azure SDK for Python
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: