Web.SearchWithHttpMessagesAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.CognitiveServices.Search.WebSearch

Assembly:: Microsoft.Azure.CognitiveServices.Search.WebSearch.dll

Pacote:: Microsoft.Azure.CognitiveServices.Search.WebSearch v2.0.0

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

A API de Pesquisa na Web permite que você envie uma consulta de pesquisa para o Bing e obtenha de volta os resultados da pesquisa que incluem links para páginas da Web, imagens e muito mais.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>> SearchWithHttpMessagesAsync (string query, string acceptLanguage = default, string pragma = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, int? answerCount = default, string countryCode = default, int? count = default, string freshness = default, string market = "en-us", int? offset = default, System.Collections.Generic.IList<string> promote = default, System.Collections.Generic.IList<string> responseFilter = default, string safeSearch = default, string setLang = default, bool? textDecorations = default, string textFormat = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<int> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>>
override this.SearchWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * Nullable<int> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * Nullable<bool> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.WebSearch.Models.SearchResponse>>

Public Function SearchWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional pragma As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional answerCount As Nullable(Of Integer) = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As String = Nothing, Optional market As String = "en-us", Optional offset As Nullable(Of Integer) = Nothing, Optional promote As IList(Of String) = Nothing, Optional responseFilter As IList(Of String) = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of SearchResponse))

Parâmetros

query: String

O termo de consulta de pesquisa do usuário. 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, use o operador site: .

acceptLanguage: String

Uma lista delimitada por vírgulas de um ou mais idiomas a serem usados para cadeias de caracteres de interface do usuário. A lista está em ordem decrescente de preferência. Para obter informações adicionais, incluindo o formato esperado, consulte RFC2616. Esse cabeçalho e o parâmetro de consulta setLang são mutuamente exclusivos; não especifique ambos. Se você definir esse cabeçalho, também deverá especificar o parâmetro de consulta cc. O Bing usará a primeira linguagem com suporte encontrada na lista e combinará essa linguagem com o valor do parâmetro cc para determinar o mercado para o qual retornar os resultados. Se a lista não incluir um idioma com suporte, o Bing encontrará o idioma e o mercado mais próximos que dão suporte à solicitação e poderá usar um mercado agregado ou padrão para os resultados em vez de um especificado. Você deve usar esse cabeçalho e o parâmetro de consulta cc somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Uma cadeia de caracteres de interface do usuário é uma cadeia de caracteres que é usada como um rótulo em uma interface do usuário. Há muito poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Todos os links nos objetos de resposta para Bing.com propriedades aplicarão o idioma especificado.

pragma: String

Por padrão, o Bing retorna o conteúdo armazenado em cache se disponível. Para impedir que o Bing retorne o conteúdo armazenado em cache, defina o cabeçalho Pragma como no-cache (por exemplo, Pragma: no-cache).

userAgent: String

O agente do usuário que originou a solicitação. O Bing usa o agente do usuário para fornecer uma experiência otimizada aos usuários móveis. Embora seja opcional, você é altamente incentivado a sempre especificar esse cabeçalho. O agente de usuário deve ser a mesma cadeia de caracteres que qualquer navegador comumente usado enviaria. Para obter informações sobre agentes do usuário, confira RFC 2616.

clientId: String

O Bing usa esse cabeçalho para fornecer aos usuários um comportamento consistente nas chamadas à API do Bing. Em geral, o Bing faz o pré-lançamento de novos recursos e novas melhorias e usa a ID do cliente como uma chave para atribuição de tráfego em versões de pré-lançamento diferentes. Se você não usar a mesma ID do cliente para um usuário em várias solicitações, o Bing poderá atribuir o usuário a várias versões de pré-lançamento conflitantes. A atribuição a várias versões de pré-lançamento conflitantes pode levar a uma experiência do usuário inconsistente. Por exemplo, se a segunda solicitação tem uma atribuição de versão de pré-lançamento diferente da primeira, a experiência pode ser inesperada. Além disso, o Bing pode usar a ID do cliente para adaptar os resultados da Web ao histórico de pesquisa dessa ID do cliente, fornecendo uma experiência mais rica para o usuário. O Bing também usa esse cabeçalho para ajudar a melhorar as classificações de resultado pela análise da atividade gerada por uma ID do cliente. As melhorias de relevância ajudam com uma melhor qualidade dos resultados fornecidos pelas APIs do Bing e, por sua vez, permitem taxas de clickthrough mais altas para o consumidor da API. IMPORTANTE: embora isso seja opcional, você deve considerar esse cabeçalho obrigatório. A persistência da ID do cliente em várias solicitações para a mesma combinação de usuário final e dispositivo permite 1) ao consumidor da API receber uma experiência do usuário consistente e 2) taxas de clickthrough mais altas por meio de uma melhor qualidade dos resultados das APIs do Bing. Cada usuário que usa o aplicativo no dispositivo precisa ter uma ID do cliente exclusiva gerada pelo Bing. Se você não incluir esse cabeçalho na solicitação, o Bing gerará uma ID e a retornará no cabeçalho de resposta X-MSEdge-ClientID. A única vez que você NÃO deve incluir esse cabeçalho em uma solicitação é a primeira vez que o usuário usa o aplicativo nesse dispositivo. Use a ID do cliente para cada solicitação da API do Bing feita pelo aplicativo para esse usuário no dispositivo. Persista a ID do cliente. Para persistir a ID em um aplicativo de navegador, use um cookie HTTP persistente para garantir que a ID seja usada em todas as sessões. Não use um cookie de sessão. Para outros aplicativos, como aplicativos móveis, use o armazenamento persistente do dispositivo para persistir a ID. Na próxima vez que o usuário usar o aplicativo no dispositivo, obtenha a ID do cliente persistente. As respostas do Bing podem ou não incluir esse cabeçalho. Se a resposta incluir esse cabeçalho, capture a ID do cliente e use-a para todas as solicitações seguintes do Bing para o usuário no dispositivo. Se você incluir o X-MSEdge-ClientID, não deverá incluir cookies na solicitação.

clientIp: String

O endereço IPv4 ou IPv6 do dispositivo cliente. O endereço IP é usado para descobrir o local do usuário. O Bing usa as informações de local para determinar o comportamento da pesquisa segura. Embora opcional, é recomendável sempre especificar esse cabeçalho e o cabeçalho X-Search-Location. Não oculte o endereço (por exemplo, alterando o último octeto para 0). Se você ocultar o endereço, isso fará com que o local não fique em nenhum lugar próximo ao local real do dispositivo, o que poderá resultar no fornecimento de resultados incorretos pelo Bing.

location: String

Uma lista delimitada por ponto-e-vírgula de pares chave/valor que descrevem a localização geográfica do cliente. O Bing usa as informações de local para determinar o comportamento da pesquisa segura e retornar o conteúdo local relevante. Especifique o par chave/valor como <key>:<value>. Veja a seguir as chaves usadas para especificar o local do usuário. lat (obrigatório): a latitude do local do cliente, em graus. A latitude precisa ser superior ou igual a -90,0 e inferior ou igual a +90,0. Valores negativos indicam latitudes sul e valores positivos indicam latitudes norte. long (obrigatório): a longitude do local do cliente, em graus. A longitude precisa ser superior ou igual a -180,0 e inferior ou igual a +180,0. Valores negativos indicam longitudes oeste e valores positivos indicam longitudes leste. re (obrigatório): o raio, em metros, que especifica a precisão horizontal das coordenadas. Passe o valor retornado pelo serviço de local do dispositivo. Os valores típicos podem ser 22 m para GPS/Wi-Fi, 380 m para triangulação de torres de celular e 18.000 m para a pesquisa inversa de IP. ts (opcional): o carimbo de data/hora UTC UNIX de quando o cliente estava no local. (O carimbo de data/hora UNIX é o número de segundos desde 1º de janeiro de 1970.) head (opcional): o título relativo do cliente ou a direção da viagem. Especifique a direção da viagem como graus de 0 a 360, no sentido horário em relação ao norte verdadeiro. Especifique essa chave somente se a chave sp for diferente de zero. sp (opcional): a velocidade horizontal (velocidade), em metros por segundo, que o dispositivo cliente está viajando. alt (opcional): a altitude do dispositivo cliente, em metros. são (opcional): o raio, em metros, que especifica a precisão vertical das coordenadas. Especifique essa chave somente se você especificar a tecla Alt. Embora muitas chaves sejam opcionais, quanto mais informações você fornecer, mais precisos serão os resultados da localização. Embora opcional, é recomendável sempre especificar a localização geográfica do usuário. O fornecimento do local é especialmente importante se o endereço IP do cliente não reflete precisamente o local físico do usuário (por exemplo, se o cliente usa VPN). Para obter melhores resultados, você deve incluir esse cabeçalho e o cabeçalho X-MSEdge-ClientIP, mas, no mínimo, você deve incluir esse cabeçalho.

answerCount: Nullable<Int32>

O número de respostas que você deseja que a resposta inclua. As respostas retornadas pelo Bing são baseadas na classificação. Por exemplo, se o Bing retornar páginas da Web, imagens, vídeos e relatedSearches para uma solicitação e você definir esse parâmetro como dois (2), a resposta incluirá páginas da Web e imagens. Se você incluísse o parâmetro de consulta responseFilter na mesma solicitação e o definisse como páginas da Web e notícias, a resposta incluiria apenas páginas da Web.

countryCode: String

O código de dois caracteres do país do qual os resultados são obtidos. Essa API dá suporte apenas ao mercado de Estados Unidos. Se você especificar esse parâmetro de consulta, ele deverá ser definido para nós. Se você definir esse parâmetro, também precisará especificar o cabeçalho Accept-Language. O Bing usa o primeiro idioma com suporte encontrado na lista de idiomas e combina esse idioma com o código do país que você especifica para determinar o mercado para o qual retornar os resultados. Se a lista de idiomas não incluir um idioma com suporte, o Bing localizará o idioma e o mercado mais próximos que dão suporte à solicitação ou poderá usar um mercado agregado ou padrão para os resultados em vez de um especificado. Você deve usar esse parâmetro de consulta e o parâmetro de consulta Accept-Language somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Esse parâmetro e o parâmetro de consulta mkt são mutuamente exclusivos – não especifique ambos.

count: Nullable<Int32>

O número de resultados da pesquisa a ser retornado na resposta. O padrão é 10 e o valor máximo é 50. O número real entregue pode ser menor do que o solicitado. Use esse parâmetro junto com o parâmetro offset para os resultados da página. Por exemplo, se a interface do usuário exibir 10 resultados de pesquisa por página, defina count como 10 e deslocamento como 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 10 (por exemplo, 0, 10, 20). É possível que várias páginas incluam alguma sobreposição nos resultados.

freshness: String

Filtre os resultados da pesquisa pelos seguintes valores de idade: Dia – Retornar páginas da Web que o Bing descobriu nas últimas 24 horas. Semana – retornar páginas da Web que o Bing descobriu nos últimos 7 dias. Mês – retornar páginas da Web que foram descobertas nos últimos 30 dias. Esse filtro se aplica somente aos resultados da página da Web e não aos outros resultados, como notícias e imagens. Os valores possíveis incluem: 'Day', 'Week', 'Month'

market: String

O mercado do qual os resultados são obtidos. Normalmente, mkt é o país do qual o usuário está fazendo a solicitação. No entanto, pode ser um país diferente se o usuário não estiver localizado em um país onde o Bing entrega resultados. O mercado deve estar no código> code-country da< linguagem> de formulário<. Por exemplo, en-US. A cadeia de caracteres não diferencia maiúsculas de minúsculas. Se conhecido, você é incentivado a sempre especificar o mercado. A especificação do mercado ajuda o Bing a encaminhar a solicitação e retornar uma resposta apropriada e ideal. Se você especificar um mercado que não esteja listado em Códigos de Mercado, o Bing usará um código de mercado mais adequado com base em um mapeamento interno que está sujeito a alterações. Esse parâmetro e o parâmetro de consulta cc são mutuamente exclusivos – não especifique ambos.

offset: Nullable<Int32>

O deslocamento baseado em zero que indica o número de resultados da pesquisa a serem ignoradas antes de retornar os resultados. O padrão é 0. O deslocamento deve ser menor que (totalEstimatedMatches - count). Use esse parâmetro junto com o parâmetro count para os resultados da página. Por exemplo, se a interface do usuário exibir 10 resultados de pesquisa por página, defina count como 10 e deslocamento como 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 10 (por exemplo, 0, 10, 20). é possível que várias páginas incluam alguma sobreposição nos resultados.

promote: IList<String>

Uma lista delimitada por vírgulas de respostas que você deseja que a resposta inclua independentemente de sua classificação. Por exemplo, se você definir answerCount) como dois (2) para que o Bing retorne as duas principais respostas classificadas, mas você também quiser que a resposta inclua notícias, você definirá promover para notícias. Se as respostas mais bem classificadas forem páginas da Web, imagens, vídeos e relatedSearches, a resposta incluirá páginas da Web e imagens porque as notícias não são uma resposta classificada. Mas se você definir promover para vídeo, o Bing promoverá a resposta de vídeo para a resposta e retornará páginas da Web, imagens e vídeos. As respostas que você deseja promover não contam em relação ao limite answerCount. Por exemplo, se as respostas classificadas forem notícias, imagens e vídeos e você definir answerCount como 1 e promover para notícias, a resposta conterá notícias e imagens. Ou, se as respostas classificadas forem vídeos, imagens e notícias, a resposta conterá vídeos e notícias. Os valores possíveis são Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Use somente se você especificar answerCount.

responseFilter: IList<String>

Uma lista delimitada por vírgulas de respostas a serem incluídas na resposta. Se você não especificar esse parâmetro, a resposta incluirá todas as respostas de pesquisa para as quais há dados relevantes. Os valores de filtro possíveis são Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webpages. Embora você possa usar esse filtro para obter uma única resposta, você deve usar o ponto de extremidade específico da resposta para obter resultados mais avançados. Por exemplo, para receber apenas imagens, envie a solicitação para um dos pontos de extremidade da API de Pesquisa de Imagem. As respostas RelatedSearches e SpellSuggestions não dão suporte a um ponto de extremidade separado como a API de Pesquisa de Imagem (somente a API de Pesquisa na Web as retorna). Para incluir respostas que, de outra forma, seriam excluídas devido à classificação, consulte o parâmetro promover consulta.

safeSearch: String

Um filtro usado para filtrar o conteúdo para adulto. Desativado: retornar páginas da Web com texto, imagens ou vídeos adultos. Moderado: retornar páginas da Web com texto adulto, mas não imagens ou vídeos adultos. Estrito: não retorne páginas da Web com texto, imagens ou vídeos adultos. O padrão é Moderado. Se a solicitação vier de um mercado que a política de adulto do Bing exige que safeSearch esteja definido como Estrito, o Bing ignorará o valor safeSearch e usará Strict. Se você usar o operador de consulta site: , há a chance de que a resposta possa conter conteúdo adulto, independentemente do parâmetro de consulta safeSearch definido como. Usar site: somente se você estiver ciente do conteúdo no site e seu cenário der suporte à possibilidade de conteúdo adulto. Os valores possíveis incluem: 'Off', 'Moderate', 'Strict'

setLang: String

O idioma a ser usado para cadeias de caracteres de interface do usuário. Especifique o idioma usando o código de idioma ISO 639-1 de 2 letras. Por exemplo, o código de idioma para o inglês é EN. O padrão é EN (inglês). Embora isso seja opcional, você sempre deve especificar o idioma. Normalmente, você define setLang como o mesmo idioma especificado pelo mkt, a menos que o usuário queira que as cadeias de caracteres de interface do usuário sejam exibidas em um idioma diferente. Esse parâmetro e o cabeçalho Accept-Language são mutuamente exclusivos; não especifique ambos. Uma cadeia de caracteres de interface do usuário é uma cadeia de caracteres que é usada como um rótulo em uma interface do usuário. Há poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Além disso, todos os links para as propriedades de Bing.com nos objetos de resposta aplicam o idioma especificado.

textDecorations: Nullable<Boolean>

Um valor booliano que determina se as cadeias de caracteres de exibição devem conter marcadores de decoração, como caracteres de realce de clique. Se for true, as cadeias de caracteres poderão incluir marcadores. O padrão é falso. Para especificar se deseja usar caracteres Unicode ou marcas HTML como marcadores, consulte o parâmetro de consulta textFormat.

textFormat: String

O tipo de marcadores a serem usados para decorações de texto (consulte o parâmetro de consulta textDecorations). Os valores possíveis são Brutos– use caracteres Unicode para marcar o conteúdo que precisa de formatação especial. Os caracteres Unicode estão no intervalo E000 a E019. Por exemplo, o Bing usa E000 e E001 para marcar o início e o fim dos termos de consulta para realce de ocorrências. HTML – Use marcas HTML para marcar o conteúdo que precisa de formatação especial. Por exemplo, use <marcas b> para realçar termos de consulta em cadeias de caracteres de exibição. O padrão é Raw. Para cadeias de caracteres de exibição que contêm caracteres HTML capazes, como <, >e &, se textFormat estiver definido como HTML, o Bing escapará dos caracteres conforme apropriado (por exemplo, < será escapado para <). Os valores possíveis incluem: 'Raw', 'Html'