Compartilhar via

ImagesSearchOptionalParams interface

  • Referência
Pacote:
@azure/cognitiveservices-imagesearch

Parâmetros opcionais.

Extends
RequestOptionsBase

Propriedades

acceptLanguage

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. Para determinar o mercado para o qual retornar resultados, o Bing usa a primeira linguagem com suporte encontrada na lista e a combina com o valor do parâmetro cc. Se a lista não inclui um idioma compatível, o Bing encontra o idioma e o mercado mais próximos que dão suporte à solicitação ou usa um mercado padrão ou agregado para os resultados. Para determinar o mercado usado pelo Bing, confira o cabeçalho BingAPIs-Market. Use esse cabeçalho e o parâmetro de consulta cc somente se você especificar vários idiomas. Caso contrário, use 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á poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Todos os links para as propriedades de Bing.com nos objetos de resposta aplicam o idioma especificado.
aspect

Filtre imagens pelas taxas de proporção a seguir. Tudo: não filtre por aspecto. Especificar esse valor é o mesmo que não especificar o parâmetro de aspecto. Quadrado: retornar imagens com taxa de proporção padrão. Largo: retornar imagens com taxa de proporção de tela larga. Alto: retornar imagens com proporção alta. Os valores possíveis incluem: 'All', 'Square', 'Wide', 'Tall'
clientId

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

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.
color

Filtre imagens pelas opções de cor a seguir. ColorOnly: retornar imagens coloridas. Monocromático: retornar imagens em preto e branco. Retornar imagens com uma das seguintes cores dominantes: Preto, Azul, Marrom, Cinza, Verde, Laranja, Rosa, Roxo, Vermelho, Teal, Branco, Amarelo. Os valores possíveis incluem: 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'
count

O número de imagens a serem retornadas na resposta. O número real entregue pode ser menor que o solicitado. O padrão é 35. O valor máximo é 150. Você usa esse parâmetro junto com o parâmetro de deslocamento para os resultados da página. Por exemplo, se a interface do usuário exibir 20 imagens por página, defina contagem como 20 e deslocamento para 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 20 (por exemplo, 0, 20, 40). Use esse parâmetro somente com a Pesquisa de Imagem API.Do não especifique esse parâmetro ao chamar as APIs insights, Imagens de Tendências ou Pesquisa na Web.
countryCode

O código de dois caracteres do país do qual os resultados são obtidos. Para obter uma lista de valores possíveis, consulte Códigos de mercado. 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.
freshness

Filtre imagens pelas seguintes opções de descoberta. Dia: retornar imagens descobertas pelo Bing nas últimas 24 horas. Semana: retornar imagens descobertas pelo Bing nos últimos 7 dias. Mês: retornar imagens descobertas pelo Bing nos últimos 30 dias. Os valores possíveis incluem: 'Day', 'Week', 'Month'
height

Filtre imagens que tenham a altura especificada, em pixels. Você pode usar esse filtro com o filtro de tamanho para retornar imagens pequenas que têm uma altura de 150 pixels.
id

Uma ID que identifica exclusivamente uma imagem. Use esse parâmetro para garantir que a imagem especificada seja a primeira imagem na lista de imagens retornadas pelo Bing. O campo imageId do objeto Image contém a ID para a qual você definiu esse parâmetro.
imageContent

Filtre imagens pelos seguintes tipos de conteúdo. Rosto: retornar imagens que mostram apenas o rosto de uma pessoa. Retrato: retornar imagens que mostram apenas a cabeça e os ombros de uma pessoa. Os valores possíveis incluem: 'Face', 'Portrait'
imageType

Filtre imagens pelos seguintes tipos de imagem. AnimatedGif: retornar apenas GIFs animados. Clipart: retornar somente imagens de clip-art. Linha: retornar somente desenhos de linha. Foto: Retornar somente fotografias (exceto desenhos de linha, Gifs animados e clip-art). Compras: retorne apenas imagens que contêm itens em que o Bing sabe de um comerciante que está vendendo os itens. Essa opção é válida somente no mercado en - EUA. Transparente: retornar somente imagens com uma tela de fundo transparente. Os valores possíveis incluem: 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent'
license

Filtre imagens pelos seguintes tipos de licença. Tudo: não filtre por tipo de licença. Especificar esse valor é o mesmo que não especificar o parâmetro de licença. Any: retornar imagens que estão sob qualquer tipo de licença. A resposta não inclui imagens que não especificam uma licença ou a licença é desconhecida. Público: retornar imagens em que o criador renunciou aos seus direitos exclusivos, em toda a extensão permitida por lei. Compartilhamento: retornar imagens que podem ser compartilhadas com outras pessoas. Talvez não seja permitido alterar ou editar a imagem. Além disso, modificar, compartilhar e usar a imagem para fins comerciais pode não ser permitido. Normalmente, essa opção retorna a maioria das imagens. ShareCommercially: retornar imagens que podem ser compartilhadas com outras pessoas para fins pessoais ou comerciais. Talvez não seja permitido alterar ou editar a imagem. Modificar: retornar imagens que podem ser modificadas, compartilhadas e usadas. Talvez não seja permitido alterar ou editar a imagem. A modificação, o compartilhamento e o uso da imagem para fins comerciais podem não ser permitidos. ModifyCommercially: retornar imagens que podem ser modificadas, compartilhadas e usadas para fins pessoais ou comerciais. Normalmente, essa opção retorna o menor número de imagens. Para obter mais informações sobre esses tipos de licença, consulte Filtrar imagens por tipo de licença. Os valores possíveis incluem: 'All', 'Any', 'Public', 'Share', 'ShareCommercially', 'Modify', 'ModifyCommercially'
location

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 :. Veja a seguir as chaves usadas para especificar o local do usuário. lat (obrigatório): a latitude da localização 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 da localização 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.) cabeçalho (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 não for 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 chave 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.
market

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 na forma -. Por exemplo, en-US. A cadeia de caracteres não diferencia maiúsculas de minúsculas. Para obter uma lista de possíveis valores de mercado, consulte Códigos de mercado. OBSERVAÇÃO: se conhecido, você será 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.
maxFileSize

Imagens de filtro menores ou iguais ao tamanho do arquivo especificado. O tamanho máximo do arquivo que você pode especificar é de 520.192 bytes. Se você especificar um valor maior, a API usará 520.192. É possível que a resposta inclua imagens ligeiramente maiores que o máximo especificado. Você pode especificar esse filtro e minFileSize para filtrar imagens dentro de um intervalo de tamanhos de arquivo.
maxHeight

Imagens de filtro que têm uma altura menor ou igual à altura especificada. Especifique a altura em pixels. Você pode especificar esse filtro e minHeight para filtrar imagens dentro de um intervalo de alturas. Esse filtro e o filtro de altura são mutuamente exclusivos.
maxWidth

Imagens de filtro que têm uma largura menor ou igual à largura especificada. Especifique a largura em pixels. Você pode especificar esse filtro e maxWidth para filtrar imagens dentro de um intervalo de larguras. Esse filtro e o filtro de largura são mutuamente exclusivos.
minFileSize

Imagens de filtro maiores ou iguais ao tamanho do arquivo especificado. O tamanho máximo do arquivo que você pode especificar é de 520.192 bytes. Se você especificar um valor maior, a API usará 520.192. É possível que a resposta inclua imagens ligeiramente menores que o mínimo especificado. Você pode especificar esse filtro e maxFileSize para filtrar imagens dentro de um intervalo de tamanhos de arquivo.
minHeight

Imagens de filtro que têm uma altura maior ou igual à altura especificada. Especifique a altura em pixels. Você pode especificar esse filtro e maxHeight para filtrar imagens dentro de um intervalo de alturas. Esse filtro e o filtro de altura são mutuamente exclusivos.
minWidth

Imagens de filtro que têm uma largura maior ou igual à largura especificada. Especifique a largura em pixels. Você pode especificar esse filtro e maxWidth para filtrar imagens dentro de um intervalo de larguras. Esse filtro e o filtro de largura são mutuamente exclusivos.
offset

O deslocamento baseado em zero que indica o número de imagens a serem ignoradas antes de retornar imagens. O padrão é 0. O deslocamento deve ser menor que (totalEstimatedMatches

  • contagem). 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 20 imagens por página, defina count como 20 e deslocamento como 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 20 (por exemplo, 0, 20, 40). É possível que várias páginas incluam alguma sobreposição nos resultados. Para evitar duplicatas, consulte nextOffset. Use esse parâmetro somente com a API de Imagem. Não especifique esse parâmetro ao chamar a API de Imagens Populares ou a API de Pesquisa na Web.
safeSearch

Filtrar imagens para conteúdo adulto. Veja a seguir os possíveis valores de filtro. Desativado: pode retornar imagens com conteúdo adulto. Se a solicitação for por meio da API de Pesquisa de Imagem, a resposta incluirá imagens em miniatura claras (não difusas). No entanto, se a solicitação for por meio da API de Pesquisa na Web, a resposta incluirá imagens em miniatura pixeladas (difusas). Moderado: se a solicitação for por meio da API de Pesquisa de Imagem, a resposta não incluirá imagens com conteúdo adulto. Se a solicitação for por meio da API de Pesquisa na Web, a resposta poderá incluir imagens com conteúdo adulto (as imagens em miniatura são pixeladas (difusas)). Estrito: não retorne imagens com conteúdo adulto. 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

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.
size

Filtre imagens pelos tamanhos a seguir. Tudo: não filtre por tamanho. Especificar esse valor é o mesmo que não especificar o parâmetro size. Pequeno: retorna imagens com menos de 200 x 200 pixels. Médio: retorna imagens maiores ou iguais a 200 x 200 pixels, mas com menos de 500 x 500 pixels. Grande: retorna imagens com 500 x 500 pixels ou mais. Papel de parede: retornar imagens de papel de parede. Você pode usar esse parâmetro junto com os parâmetros de altura ou largura. Por exemplo, você pode usar altura e tamanho para solicitar imagens pequenas com 150 pixels de altura. Os valores possíveis incluem: 'All', 'Small', 'Medium', 'Large', 'Wallpaper'
userAgent

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 isso seja opcional, você é incentivado a sempre especificar esse cabeçalho. O agente do usuário deve ter a mesma cadeia de caracteres enviada por qualquer navegador geralmente usado. Para obter informações sobre agentes do usuário, confira RFC 2616. Veja a seguir exemplos de cadeias de caracteres de agente do usuário. Windows Phone: Mozilla/5.0 (compatível; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; BRAÇO; Toque; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; como Gecko) Versão / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 como Mac OS X) AppleWebKit / 536.26 (KHTML; como Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident/ 7.0; Toque; rv:11.0) como Gecko. iPad: Mozilla / 5.0 (iPad; SO da CPU 7_0 como Mac OS X) AppleWebKit / 537.51.1 (KHTML, como Gecko) Versão / 7.0 Mobile / 11A465 Safari / 9537.53
width

Imagens de filtro que têm a largura especificada, em pixels. Você pode usar esse filtro com o filtro de tamanho para retornar imagens pequenas que têm uma largura de 150 pixels.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.
customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.
onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.
onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.
timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

Detalhes da propriedade

acceptLanguage

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. Para determinar o mercado para o qual retornar resultados, o Bing usa a primeira linguagem com suporte encontrada na lista e a combina com o valor do parâmetro cc. Se a lista não inclui um idioma compatível, o Bing encontra o idioma e o mercado mais próximos que dão suporte à solicitação ou usa um mercado padrão ou agregado para os resultados. Para determinar o mercado usado pelo Bing, confira o cabeçalho BingAPIs-Market. Use esse cabeçalho e o parâmetro de consulta cc somente se você especificar vários idiomas. Caso contrário, use 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á poucas cadeias de caracteres de interface do usuário nos objetos de resposta JSON. Todos os links para as propriedades de Bing.com nos objetos de resposta aplicam o idioma especificado.

acceptLanguage?: string

Valor da propriedade

string

aspect

Filtre imagens pelas taxas de proporção a seguir. Tudo: não filtre por aspecto. Especificar esse valor é o mesmo que não especificar o parâmetro de aspecto. Quadrado: retornar imagens com taxa de proporção padrão. Largo: retornar imagens com taxa de proporção de tela larga. Alto: retornar imagens com proporção alta. Os valores possíveis incluem: 'All', 'Square', 'Wide', 'Tall'

aspect?: ImageAspect

Valor da propriedade

ImageAspect

clientId

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.

clientId?: string

Valor da propriedade

string

clientIp

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.

clientIp?: string

Valor da propriedade

string

color

Filtre imagens pelas opções de cor a seguir. ColorOnly: retornar imagens coloridas. Monocromático: retornar imagens em preto e branco. Retornar imagens com uma das seguintes cores dominantes: Preto, Azul, Marrom, Cinza, Verde, Laranja, Rosa, Roxo, Vermelho, Teal, Branco, Amarelo. Os valores possíveis incluem: 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'

color?: ImageColor

Valor da propriedade

ImageColor

count

O número de imagens a serem retornadas na resposta. O número real entregue pode ser menor que o solicitado. O padrão é 35. O valor máximo é 150. Você usa esse parâmetro junto com o parâmetro de deslocamento para os resultados da página. Por exemplo, se a interface do usuário exibir 20 imagens por página, defina contagem como 20 e deslocamento para 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 20 (por exemplo, 0, 20, 40). Use esse parâmetro somente com a Pesquisa de Imagem API.Do não especifique esse parâmetro ao chamar as APIs insights, Imagens de Tendências ou Pesquisa na Web.

count?: number

Valor da propriedade

number

countryCode

O código de dois caracteres do país do qual os resultados são obtidos. Para obter uma lista de valores possíveis, consulte Códigos de mercado. 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.

countryCode?: string

Valor da propriedade

string

freshness

Filtre imagens pelas seguintes opções de descoberta. Dia: retornar imagens descobertas pelo Bing nas últimas 24 horas. Semana: retornar imagens descobertas pelo Bing nos últimos 7 dias. Mês: retornar imagens descobertas pelo Bing nos últimos 30 dias. Os valores possíveis incluem: 'Day', 'Week', 'Month'

freshness?: Freshness

Valor da propriedade

Freshness

height

Filtre imagens que tenham a altura especificada, em pixels. Você pode usar esse filtro com o filtro de tamanho para retornar imagens pequenas que têm uma altura de 150 pixels.

height?: number

Valor da propriedade

number

id

Uma ID que identifica exclusivamente uma imagem. Use esse parâmetro para garantir que a imagem especificada seja a primeira imagem na lista de imagens retornadas pelo Bing. O campo imageId do objeto Image contém a ID para a qual você definiu esse parâmetro.

id?: string

Valor da propriedade

string

imageContent

Filtre imagens pelos seguintes tipos de conteúdo. Rosto: retornar imagens que mostram apenas o rosto de uma pessoa. Retrato: retornar imagens que mostram apenas a cabeça e os ombros de uma pessoa. Os valores possíveis incluem: 'Face', 'Portrait'

imageContent?: ImageContent

Valor da propriedade

ImageContent

imageType

Filtre imagens pelos seguintes tipos de imagem. AnimatedGif: retornar apenas GIFs animados. Clipart: retornar somente imagens de clip-art. Linha: retornar somente desenhos de linha. Foto: Retornar somente fotografias (exceto desenhos de linha, Gifs animados e clip-art). Compras: retorne apenas imagens que contêm itens em que o Bing sabe de um comerciante que está vendendo os itens. Essa opção é válida somente no mercado en - EUA. Transparente: retornar somente imagens com uma tela de fundo transparente. Os valores possíveis incluem: 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent'

imageType?: ImageType

Valor da propriedade

ImageType

license

Filtre imagens pelos seguintes tipos de licença. Tudo: não filtre por tipo de licença. Especificar esse valor é o mesmo que não especificar o parâmetro de licença. Any: retornar imagens que estão sob qualquer tipo de licença. A resposta não inclui imagens que não especificam uma licença ou a licença é desconhecida. Público: retornar imagens em que o criador renunciou aos seus direitos exclusivos, em toda a extensão permitida por lei. Compartilhamento: retornar imagens que podem ser compartilhadas com outras pessoas. Talvez não seja permitido alterar ou editar a imagem. Além disso, modificar, compartilhar e usar a imagem para fins comerciais pode não ser permitido. Normalmente, essa opção retorna a maioria das imagens. ShareCommercially: retornar imagens que podem ser compartilhadas com outras pessoas para fins pessoais ou comerciais. Talvez não seja permitido alterar ou editar a imagem. Modificar: retornar imagens que podem ser modificadas, compartilhadas e usadas. Talvez não seja permitido alterar ou editar a imagem. A modificação, o compartilhamento e o uso da imagem para fins comerciais podem não ser permitidos. ModifyCommercially: retornar imagens que podem ser modificadas, compartilhadas e usadas para fins pessoais ou comerciais. Normalmente, essa opção retorna o menor número de imagens. Para obter mais informações sobre esses tipos de licença, consulte Filtrar imagens por tipo de licença. Os valores possíveis incluem: 'All', 'Any', 'Public', 'Share', 'ShareCommercially', 'Modify', 'ModifyCommercially'

license?: ImageLicense

Valor da propriedade

ImageLicense

location

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 :. Veja a seguir as chaves usadas para especificar o local do usuário. lat (obrigatório): a latitude da localização 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 da localização 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.) cabeçalho (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 não for 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 chave 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.

location?: string

Valor da propriedade

string

market

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 na forma -. Por exemplo, en-US. A cadeia de caracteres não diferencia maiúsculas de minúsculas. Para obter uma lista de possíveis valores de mercado, consulte Códigos de mercado. OBSERVAÇÃO: se conhecido, você será 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.

market?: string

Valor da propriedade

string

maxFileSize

Imagens de filtro menores ou iguais ao tamanho do arquivo especificado. O tamanho máximo do arquivo que você pode especificar é de 520.192 bytes. Se você especificar um valor maior, a API usará 520.192. É possível que a resposta inclua imagens ligeiramente maiores que o máximo especificado. Você pode especificar esse filtro e minFileSize para filtrar imagens dentro de um intervalo de tamanhos de arquivo.

maxFileSize?: number

Valor da propriedade

number

maxHeight

Imagens de filtro que têm uma altura menor ou igual à altura especificada. Especifique a altura em pixels. Você pode especificar esse filtro e minHeight para filtrar imagens dentro de um intervalo de alturas. Esse filtro e o filtro de altura são mutuamente exclusivos.

maxHeight?: number

Valor da propriedade

number

maxWidth

Imagens de filtro que têm uma largura menor ou igual à largura especificada. Especifique a largura em pixels. Você pode especificar esse filtro e maxWidth para filtrar imagens dentro de um intervalo de larguras. Esse filtro e o filtro de largura são mutuamente exclusivos.

maxWidth?: number

Valor da propriedade

number

minFileSize

Imagens de filtro maiores ou iguais ao tamanho do arquivo especificado. O tamanho máximo do arquivo que você pode especificar é de 520.192 bytes. Se você especificar um valor maior, a API usará 520.192. É possível que a resposta inclua imagens ligeiramente menores que o mínimo especificado. Você pode especificar esse filtro e maxFileSize para filtrar imagens dentro de um intervalo de tamanhos de arquivo.

minFileSize?: number

Valor da propriedade

number

minHeight

Imagens de filtro que têm uma altura maior ou igual à altura especificada. Especifique a altura em pixels. Você pode especificar esse filtro e maxHeight para filtrar imagens dentro de um intervalo de alturas. Esse filtro e o filtro de altura são mutuamente exclusivos.

minHeight?: number

Valor da propriedade

number

minWidth

Imagens de filtro que têm uma largura maior ou igual à largura especificada. Especifique a largura em pixels. Você pode especificar esse filtro e maxWidth para filtrar imagens dentro de um intervalo de larguras. Esse filtro e o filtro de largura são mutuamente exclusivos.

minWidth?: number

Valor da propriedade

number

offset

O deslocamento baseado em zero que indica o número de imagens a serem ignoradas antes de retornar imagens. O padrão é 0. O deslocamento deve ser menor que (totalEstimatedMatches

  • contagem). 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 20 imagens por página, defina count como 20 e deslocamento como 0 para obter a primeira página de resultados. Para cada página subsequente, incremente o deslocamento em 20 (por exemplo, 0, 20, 40). É possível que várias páginas incluam alguma sobreposição nos resultados. Para evitar duplicatas, consulte nextOffset. Use esse parâmetro somente com a API de Imagem. Não especifique esse parâmetro ao chamar a API de Imagens Populares ou a API de Pesquisa na Web.
offset?: number

Valor da propriedade

number

safeSearch

Filtrar imagens para conteúdo adulto. Veja a seguir os possíveis valores de filtro. Desativado: pode retornar imagens com conteúdo adulto. Se a solicitação for por meio da API de Pesquisa de Imagem, a resposta incluirá imagens em miniatura claras (não difusas). No entanto, se a solicitação for por meio da API de Pesquisa na Web, a resposta incluirá imagens em miniatura pixeladas (difusas). Moderado: se a solicitação for por meio da API de Pesquisa de Imagem, a resposta não incluirá imagens com conteúdo adulto. Se a solicitação for por meio da API de Pesquisa na Web, a resposta poderá incluir imagens com conteúdo adulto (as imagens em miniatura são pixeladas (difusas)). Estrito: não retorne imagens com conteúdo adulto. 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'

safeSearch?: SafeSearch

Valor da propriedade

SafeSearch

setLang

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.

setLang?: string

Valor da propriedade

string

size

Filtre imagens pelos tamanhos a seguir. Tudo: não filtre por tamanho. Especificar esse valor é o mesmo que não especificar o parâmetro size. Pequeno: retorna imagens com menos de 200 x 200 pixels. Médio: retorna imagens maiores ou iguais a 200 x 200 pixels, mas com menos de 500 x 500 pixels. Grande: retorna imagens com 500 x 500 pixels ou mais. Papel de parede: retornar imagens de papel de parede. Você pode usar esse parâmetro junto com os parâmetros de altura ou largura. Por exemplo, você pode usar altura e tamanho para solicitar imagens pequenas com 150 pixels de altura. Os valores possíveis incluem: 'All', 'Small', 'Medium', 'Large', 'Wallpaper'

size?: ImageSize

Valor da propriedade

ImageSize

userAgent

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 isso seja opcional, você é incentivado a sempre especificar esse cabeçalho. O agente do usuário deve ter a mesma cadeia de caracteres enviada por qualquer navegador geralmente usado. Para obter informações sobre agentes do usuário, confira RFC 2616. Veja a seguir exemplos de cadeias de caracteres de agente do usuário. Windows Phone: Mozilla/5.0 (compatível; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; BRAÇO; Toque; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; como Gecko) Versão / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 como Mac OS X) AppleWebKit / 536.26 (KHTML; como Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident/ 7.0; Toque; rv:11.0) como Gecko. iPad: Mozilla / 5.0 (iPad; SO da CPU 7_0 como Mac OS X) AppleWebKit / 537.51.1 (KHTML, como Gecko) Versão / 7.0 Mobile / 11A465 Safari / 9537.53

userAgent?: string

Valor da propriedade

string

width

Imagens de filtro que têm a largura especificada, em pixels. Você pode usar esse filtro com o filtro de tamanho para retornar imagens pequenas que têm uma largura de 150 pixels.

width?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

Herdado de msRest.RequestOptionsBase.abortSignal

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes do envio da solicitação.

customHeaders?: {[key: string]: string}

Valor da propriedade

{[key: string]: string}

Herdado de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Retorno de chamada que é disparado após o progresso do download.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é disparado após o progresso do upload.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor da propriedade

(progress: TransferProgressEvent) => void

Herdado de msRest.RequestOptionsBase.onUploadProgress

timeout

O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

timeout?: number

Valor da propriedade

number

Herdado de msRest.RequestOptionsBase.timeout