WebOperations Classe
Operações WebOperations.
Não deve instanciar diretamente esta classe, mas criar uma instância de Cliente que irá criá-la e anexá-la como atributo.
- Herança
-
builtins.objectWebOperations
Construtor
WebOperations(client, config, serializer, deserializer)Parâmetros
- client
Cliente para pedidos de serviço.
- config
Configuração do cliente de serviço.
- serializer
Um serializador de modelo de objeto.
- deserializer
Um desserializador de modelo de objeto.
Variáveis
- x_bing_apis_sdk
Ativar a conformidade swagger. Valor constante: "true".
Métodos
| search |
A API de Pesquisa na Web permite-lhe enviar uma consulta de pesquisa para o Bing e obter resultados de pesquisa que incluem ligações para páginas Web, imagens e muito mais. |
search
A API de Pesquisa na Web permite-lhe enviar uma consulta de pesquisa para o Bing e obter resultados de pesquisa que incluem ligações para páginas Web, imagens e muito mais.
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)Parâmetros
- query
- str
O termo de consulta de pesquisa do utilizador. O termo pode não estar vazio. O termo pode conter Operadores Avançados do Bing. Por exemplo, para limitar os resultados a um domínio específico, utilize o operador site: .
- accept_language
- str
Uma lista delimitada por vírgulas de um ou mais idiomas a utilizar para cadeias de interface de utilizador. A lista está em ordem decrescente de preferência. Para obter informações adicionais, incluindo o formato esperado, veja RFC2616. Este cabeçalho e o parâmetro de consulta setLang são mutuamente exclusivos; não especifique ambos. Se definir este cabeçalho, também tem de especificar o parâmetro de consulta cc. O Bing utilizará o primeiro idioma suportado que encontrar na lista e combinará esse idioma com o valor do parâmetro cc para determinar o mercado para o qual pretende devolver resultados. Se a lista não incluir um idioma suportado, o Bing encontrará a linguagem e o mercado mais próximos que suportam o pedido e poderá utilizar um mercado agregado ou predefinido para os resultados em vez de um especificado. Deve utilizar este cabeçalho e o parâmetro de consulta cc apenas se especificar vários idiomas; caso contrário, deve utilizar os parâmetros de consulta mkt e setLang. As cadeias da interface de utilizador são cadeias utilizadas como etiquetas na interface de utilizador. Existem muito poucas cadeias de interface de utilizador nos objetos de resposta JSON. Todas as ligações nos objetos de resposta às propriedades Bing.com aplicarão o idioma especificado.
- pragma
- str
Por predefinição, o Bing devolve conteúdo em cache, se disponível. Para impedir que o Bing devolva conteúdo em cache, defina o cabeçalho Pragma como no-cache (por exemplo, Pragma: no-cache).
- user_agent
- str
O agente de utilizador que origina o pedido. O Bing utiliza o agente de utilizador para proporcionar uma experiência otimizada aos utilizadores de dispositivos móveis. Embora seja opcional, recomendamos vivamente que especifique sempre este cabeçalho. O utilizador-agente deve ser a mesma cadeia que qualquer browser utilizado normalmente enviaria. Para obter informações sobre os agentes de utilizador, veja RFC 2616.
- client_id
- str
O Bing utiliza este cabeçalho para proporcionar um comportamento consistente nas chamada à API do Bing aos utilizadores. O Bing lança, muitas vezes, funcionalidades e melhorias novas e utiliza o ID de cliente como uma chave para atribuir tráfego aos diferentes lançamentos. Se não utilizar o mesmo ID de cliente para um utilizador em vários pedidos, o Bing poderá atribuir esse utilizador a vários lançamentos sobrepostos. A atribuição a vários lançamentos sobrepostos pode provocar uma experiência de utilizador inconsistente. Por exemplo, se a atribuição de lançamento do segundo pedido for diferente da do primeiro, a experiência poderá ser inesperada. Além disso, o Bing pode utilizar o ID de cliente para adaptar os resultados da Web ao histórico de pesquisa desse ID de cliente, proporcionando uma experiência mais avançada para o utilizador. O Bing também utiliza este cabeçalho para ajudar a melhorar as classificações dos resultados ao analisar a atividade gerada por um ID de cliente. As melhorias à relevância ajudam a que as APIs do Bing devolvam resultados com melhor qualidade, o que, por sua vez, origina taxas de cliques mais altas para o consumidor da API. IMPORTANTE: embora seja opcional, deve ver este cabeçalho como obrigatório. Persistir o ID de cliente em vários pedidos para a mesma combinação de utilizador final e dispositivo permite 1) que o consumidor da API receba uma experiência de utilizador consistente e 2) taxas de cliques mais altas, através de resultados com melhor qualidade das APIs do Bing. Cada utilizador que utilize a sua aplicação no dispositivo tem de ter um ID de cliente exclusivo e gerado pelo Bing. Se não incluir este cabeçalho no pedido, o Bing gera um ID e devolve-o no cabeçalho da resposta X-MSEdge-ClientID. O único momento em que NÃO deve incluir este cabeçalho num pedido é na primeira vez que o utilizador utiliza a sua aplicação nesse dispositivo. Utilize o ID de cliente para cada pedido da API do Bing que a sua aplicação fizer para este utilizador no dispositivo. Persista o ID de cliente. Para persistir o ID numa aplicação de browser, utilize um cookie HTTP persistente para garantir que esse ID é utilizado em todas as sessões. Não utilize um cookie de sessão. Relativamente a outras aplicações, como aplicações móveis, utilize o armazenamento persistente do dispositivo para persistir o ID. Da próxima vez que o utilizador utilizar a aplicação nesse dispositivo, recebe o ID de cliente que foi persistido. As respostas do Bing podem ou não incluir este cabeçalho. Se a resposta incluir este cabeçalho, capture o ID de cliente e utilize-o em todos os pedidos do Bing subsequentes do utilizador nesse dispositivo. Se incluir o X-MSEdge-ClientID, não pode incluir cookies no pedido.
- client_ip
- str
O endereço IPv4 ou IPv6 do dispositivo cliente. O endereço IP é utilizado para detetar a localização do utilizador. O Bing utiliza as informações de localização para determinar o comportamento do safesearch. Embora seja opcional, recomendamos que especifique sempre este cabeçalho e o cabeçalho X-Search-Location. Não ofusque a morada (por exemplo, ao alterar o último octeto para 0). Ofuscar a morada faz com que a localização não esteja perto da localização efetiva do dispositivo, o que pode fazer com que o Bing sirva resultados errados.
- location
- str
Uma lista separada por ponto e vírgula de pares de chaves/valores que descreve a localização geográfica do cliente. O Bing utiliza as informações de localização para determinar o comportamento do safesearch e para devolver conteúdos locais relevantes. Especifique o par chave/valor como :. As chaves seguintes são as chaves utilizadas para especificar a localização do utilizador. lat (obrigatório): a latitude da localização do cliente, em graus. Tem de ser igual ou superior a -90,0 e inferior ou igual a +90,0. Os valores negativos indicam latitudes no hemisfério sul e os positivos latitudes no hemisfério norte. long (obrigatório): a longitude da localização do cliente, em graus. Tem de ser igual ou superior a -180.0 e inferior ou igual a +180.0. Os valores negativos indicam longitudes a ocidente e os positivos a oriente. re (obrigatório): o raio, em medidores, que especifica a precisão horizontal das coordenadas. Transmita o valor que o serviço de localização do dispositivo devolve. Os valores mais comuns podem ser 22 m para GPS/Wi-Fi, 380 m para triangulação de antenas e 18 000 m para pesquisa de IP inversa. ts (opcional): o carimbo de data/hora UNIX UTC de quando o cliente estava na localização. (O carimbo de data/hora UNIX é o número de segundos desde 1 de janeiro de 1970.) cabeça (opcional): o cabeçalho ou direção relativa da viagem do cliente. Especifique a direção de deslocamento em graus, de 0 a 360, a contar no sentido dos ponteiros do relógio em relação ao norte verdadeiro. Especifique esta chave apenas se a chave sp não forzero. sp (opcional): a velocidade horizontal (velocidade), em metros por segundo, que o dispositivo cliente está a percorrer. alt (opcional): a altitude do dispositivo cliente, em medidores. são (opcionais): o raio, em medidores, que especifica a precisão vertical das coordenadas. Especifique esta chave apenas se especificar a tecla alt. Embora muitas das chaves sejam opcionais, quanto mais informações fornecer, mais exatas são os resultados da localização. Embora seja opcional, recomendamos que especifique sempre a localização geográfica do utilizador. Especificar a localização é particularmente importante se o endereço IP do cliente não refletir, com precisão, a localização física do utilizador (por exemplo, se este utilizar VPN). Para obter os melhores resultados, deve incluir este cabeçalho e o cabeçalho X-MSEdge-ClientIP, mas deve incluir este cabeçalho, no mínimo.
- answer_count
- int
O número de respostas que pretende que a resposta inclua. As respostas que o Bing devolve baseiam-se na classificação. Por exemplo, se o Bing devolver páginas Web, imagens, vídeos e pesquisa relacionada para um pedido e definir este parâmetro como dois (2), a resposta inclui páginas Web e imagens. Se incluísse o parâmetro de consulta responseFilter no mesmo pedido e o definisse como páginas Web e notícias, a resposta incluiria apenas páginas Web.
- country_code
- str
Um código de país de dois carateres do país de onde os resultados provêm. Esta API suporta apenas o mercado Estados Unidos. Se especificar este parâmetro de consulta, este tem de ser definido para nós. Se definir este parâmetro, também tem de especificar o cabeçalho Accept-Language. O Bing utiliza o primeiro idioma suportado que encontra na lista de idiomas e combina esse idioma com o código de país que especificar para determinar o mercado para o qual pretende devolver resultados. Se a lista de idiomas não incluir um idioma suportado, o Bing encontra o idioma e o mercado mais próximos que suportam o pedido ou pode utilizar um mercado agregado ou predefinido para os resultados em vez de um especificado. Deve utilizar este parâmetro de consulta e o parâmetro de consulta Accept-Language apenas se especificar vários idiomas; caso contrário, deve utilizar os parâmetros de consulta mkt e setLang. Este parâmetro e o parâmetro de consulta mkt são mutuamente exclusivos. Não especifique ambos.
- count
- int
O número de resultados da pesquisa a devolver na resposta. A predefinição é 10 e o valor máximo é 50. O número real entregue pode ser menor do que o pedido. Utilize este parâmetro juntamente com o parâmetro offset para os resultados da página. Por exemplo, se a interface de utilizador apresentar 10 resultados de pesquisa por página, defina a contagem como 10 e desfase para 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o desvio em 10 (por exemplo, 0, 10, 20). É possível que várias páginas incluam alguma sobreposição nos resultados.
Filtre os resultados da pesquisa pelos seguintes valores etários: Dia — Devolver páginas Web que o Bing detetou nas últimas 24 horas. Semana — Devolver páginas Web que o Bing detetou nos últimos 7 dias. Mês — Devolver páginas Web que foram detetadas nos últimos 30 dias. Este filtro aplica-se apenas aos resultados da página Web e não aos outros resultados, como notícias e imagens. Os valores possíveis incluem: "Dia", "Semana", "Mês"
- market
- str
O mercado de onde os resultados provêm. Normalmente, mkt é o país a partir do qual o utilizador está a fazer o pedido. No entanto, pode ser um país diferente se o utilizador não estiver localizado num país onde o Bing fornece resultados. O mercado tem de estar na forma. Por exemplo: en-US. A cadeia não é sensível a maiúsculas e minúsculas. Se for conhecido, recomendamos que especifique sempre o mercado. Desta forma, ajuda o Bing a encaminhar o pedido e a devolver a resposta adequada e ideal. Se especificar um mercado que não esteja listado nos Códigos de Mercado, o Bing utiliza um código de mercado mais adequado com base num mapeamento interno sujeito a alterações. Este parâmetro e o parâmetro de consulta cc são mutuamente exclusivos. Não especifique ambos.
- offset
- int
O desvio baseado em zero que indica o número de resultados da pesquisa a ignorar antes de devolver resultados. A predefinição é 0. O desvio deve ser menor do que (totalEstimatedMatches - contagem). Utilize este parâmetro juntamente com o parâmetro de contagem para os resultados da página. Por exemplo, se a interface de utilizador apresentar 10 resultados de pesquisa por página, defina a contagem como 10 e desfase para 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o desvio em 10 (por exemplo, 0, 10, 20). é possível que várias páginas incluam alguma sobreposição nos resultados.
- promote
- list[str ou AnswerType]
Uma lista delimitada por vírgulas de respostas que pretende que a resposta inclua, independentemente da respetiva classificação. Por exemplo, se definir answerCount) para dois (2) para que o Bing devolva as duas principais respostas classificadas, mas também quiser que a resposta inclua notícias, definiria promover para notícias. Se as respostas mais bem classificadas forem páginas Web, imagens, vídeos e pesquisa relacionada, a resposta inclui páginas Web e imagens porque as notícias não são uma resposta classificada. No entanto, se definir a promoção para vídeo, o Bing promoverá a resposta de vídeo para a resposta e devolverá páginas Web, imagens e vídeos. As respostas que pretende promover não contam com o limite answerCount. Por exemplo, se as respostas classificadas forem notícias, imagens e vídeos e definir answerCount como 1 e promover para notícias, a resposta contém notícias e imagens. Ou, se as respostas classificadas forem vídeos, imagens e notícias, a resposta contém vídeos e notícias. Os valores possíveis são Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Utilize apenas se especificar answerCount.
- response_filter
- list[str ou AnswerType]
Uma lista delimitada por vírgulas de respostas a incluir na resposta. Se não especificar este parâmetro, a resposta inclui todas as respostas de pesquisa para as quais existem dados relevantes. Os valores de filtro possíveis são Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Embora possa utilizar este filtro para obter uma única resposta, deve, em vez disso, utilizar o ponto final específico da resposta para obter resultados mais avançados. Por exemplo, para receber apenas imagens, envie o pedido para um dos pontos finais da API de Pesquisa de Imagens. As respostas RelatedSearches e SpellSuggestions não suportam um ponto final separado como a API de Pesquisa de Imagens (apenas a API de Pesquisa na Web as devolve). Para incluir respostas que de outra forma seriam excluídas devido à classificação, veja o parâmetro promover consulta.
- safe_search
- str ou SafeSearch
É um filtro utilizado para filtrar conteúdo para adultos. Desativado: devolva páginas Web com texto para adultos, imagens ou vídeos. Moderado: devolver páginas Web com texto para adultos, mas não imagens ou vídeos para adultos. Estrito: não devolver páginas Web com texto, imagens ou vídeos para adultos. A predefinição é Moderado. Se o pedido for proveniente de um mercado em que a política de adultos do Bing requer que a pesquisa segura esteja definida como Estrita, o Bing ignora o valor safeSearch e utiliza Strict. Se utilizar o operador de consulta site: existe a possibilidade de a resposta poder conter conteúdo para adultos, independentemente do parâmetro de consulta safeSearch definido como. Utilizar o site: apenas se tiver conhecimento do conteúdo no site e o seu cenário suportar a possibilidade de conteúdo para adultos. Os valores possíveis incluem: "Off", "Moderate", "Strict"
- set_lang
- str
O idioma a utilizar nas cadeias da interface de utilizador. Especifique o idioma com o código de idioma ISO 639-1 de duas letras. Por exemplo, o código de idioma de inglês é EN. A predefinição é EN (inglês). Embora seja opcional, deve indicar sempre o idioma. Normalmente, define SetLang para o mesmo idioma especificado pelo mkt, a menos que o utilizador pretenda que as cadeias de interface de utilizador sejam apresentadas num idioma diferente. Este parâmetro e o cabeçalho Accept-Language são mutuamente exclusivos; não especifique ambos. As cadeias da interface de utilizador são cadeias utilizadas como etiquetas na interface de utilizador. Os objetos de resposta JSON têm poucas cadeias de interface de utilizador. Além disso, todas as ligações para propriedades de Bing.com nos objetos de resposta aplicam o idioma especificado.
- text_decorations
- bool
Um valor booleano que determina se as cadeias de apresentação devem conter marcadores de decoração, tais como carateres de realce de impacto. Se for verdadeiro, as cadeias podem incluir marcadores. A predefinição é falsa. Para especificar se pretende utilizar carateres Unicode ou etiquetas HTML como marcadores, veja o parâmetro de consulta textFormat.
- text_format
- str ou TextFormat
O tipo de marcadores a utilizar para decorações de texto (veja o parâmetro de consulta textDecorations). Os valores possíveis são Raw — utilize carateres Unicode para marcar conteúdo que precise de formatação especial. Os carateres Unicode estão no intervalo E000 a E019. Por exemplo, o Bing utiliza E000 e E001 para marcar o início e o fim dos termos de consulta para o realce de êxito. HTML — utilize etiquetas HTML para marcar conteúdos que precisem de formatação especial. Por exemplo, utilize etiquetas para realçar os termos da consulta nas cadeias de apresentação. A predefinição é Raw. Para cadeias de apresentação que contenham carateres HTML escapáveis, como <, >e &, se textFormat estiver definido como HTML, o Bing escapa aos carateres conforme adequado (por exemplo, < é escapado para <). Os valores possíveis incluem: "Raw", "Html"
- raw
- bool
devolve a resposta direta juntamente com a resposta desserializada
- operation_config
Substituições da configuração da operação.
Devoluções
SearchResponse ou ClientRawResponse se raw=true
Tipo de retorno
Exceções
Atributos
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