ImagesOperations.DetailsWithHttpMessagesAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.CognitiveServices.Search.ImageSearch

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

Pacote:: Microsoft.Azure.CognitiveServices.Search.ImageSearch 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 de Detalhes de Imagem permite pesquisar no Bing e obter informações sobre uma imagem, como páginas da Web que incluem a imagem. Esta seção fornece detalhes técnicos sobre os parâmetros e cabeçalhos de consulta que você usa para solicitar insights de imagens e os objetos de resposta JSON que os contêm. Para obter exemplos que mostram como fazer solicitações, consulte Pesquisando imagens na Web.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Azure.CognitiveServices.Search.ImageSearch.Models.ImageInsights>> DetailsWithHttpMessagesAsync (string query, string acceptLanguage = default, string contentType = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, double? cropBottom = default, double? cropLeft = default, double? cropRight = default, double? cropTop = default, string cropType = default, string countryCode = default, string id = default, string imageUrl = default, string insightsToken = default, System.Collections.Generic.IList<string> modules = default, string market = default, string safeSearch = default, string setLang = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DetailsWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * string * string * string * string * string * System.Collections.Generic.IList<string> * string * string * 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.ImageSearch.Models.ImageInsights>>
override this.DetailsWithHttpMessagesAsync : string * string * string * string * string * string * string * Nullable<double> * Nullable<double> * Nullable<double> * Nullable<double> * string * string * string * string * string * System.Collections.Generic.IList<string> * string * string * 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.ImageSearch.Models.ImageInsights>>

Public Function DetailsWithHttpMessagesAsync (query As String, Optional acceptLanguage As String = Nothing, Optional contentType As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional cropBottom As Nullable(Of Double) = Nothing, Optional cropLeft As Nullable(Of Double) = Nothing, Optional cropRight As Nullable(Of Double) = Nothing, Optional cropTop As Nullable(Of Double) = Nothing, Optional cropType As String = Nothing, Optional countryCode As String = Nothing, Optional id As String = Nothing, Optional imageUrl As String = Nothing, Optional insightsToken As String = Nothing, Optional modules As IList(Of String) = Nothing, Optional market As String = Nothing, Optional safeSearch As String = Nothing, Optional setLang As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of ImageInsights))

Parâmetros

query: String

O termo de consulta de pesquisa do usuário. O termo não pode estar vazio. O termo pode conter Operadores Avançados do Bing. Por exemplo, para limitar imagens a um domínio específico, use o operador site: . Para ajudar a melhorar a relevância de uma consulta de insights (consulte insightsToken), você sempre deve incluir o termo de consulta do usuário. Use esse parâmetro somente com a Pesquisa de Imagem API.Do não especifique esse parâmetro ao chamar a API de Imagens de Tendências.

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

contentType: String

Cabeçalho de solicitação opcional. Se você definir o parâmetro de consulta de módulos como RecognizedEntities, poderá especificar o binário de uma imagem no corpo de uma solicitação POST. Se você especificar a imagem no corpo de uma solicitação POST, deverá especificar esse cabeçalho e definir seu valor como multipart/form-data. O tamanho máximo da imagem é de 1 MB.

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 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 de usuário, consulte RFC 2616. Veja a seguir exemplos de cadeias de caracteres de agente de 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 - nós; 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

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

cropBottom: Nullable<Double>

A coordenada inferior da região a ser recortar. A coordenada é um valor fracionário da altura da imagem original e é medida do canto superior esquerdo da imagem. Especifique a coordenada como um valor de 0,0 a 1,0. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

cropLeft: Nullable<Double>

A coordenada esquerda da região a ser recortar. A coordenada é um valor fracionário da altura da imagem original e é medida do canto superior esquerdo da imagem. Especifique a coordenada como um valor de 0,0 a 1,0. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

cropRight: Nullable<Double>

A coordenada direita da região a ser recortar. A coordenada é um valor fracionário da altura da imagem original e é medida do canto superior esquerdo da imagem. Especifique a coordenada como um valor de 0,0 a 1,0. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

cropTop: Nullable<Double>

A coordenada superior da região a ser recortar. A coordenada é um valor fracionário da altura da imagem original e é medida do canto superior esquerdo da imagem. Especifique a coordenada como um valor de 0,0 a 1,0. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

cropType: String

O tipo de corte a ser usado ao cortar a imagem com base nas coordenadas especificadas nos parâmetros cal, cat, car e cab. Veja os valores possíveis a seguir: 0: Retangular (padrão). Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web. Os valores possíveis incluem: 'Retangular'

countryCode: String

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.

id: String

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.

imageUrl: String

A URL de uma imagem da qual você deseja obter insights. Use esse parâmetro como alternativa ao uso do parâmetro insightsToken para especificar a imagem. Você também pode especificar a imagem colocando o binário da imagem no corpo de uma solicitação POST. Se você usar a opção binária, consulte o cabeçalho Tipo de Conteúdo . O tamanho máximo de imagem compatível é 1 MB. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

insightsToken: String

Um token de imagem. A imagem do objeto ImageInsightsToken contém o token. Especifique esse parâmetro para obter informações adicionais sobre uma imagem, como um legenda ou uma fonte de compras. Para obter uma lista das informações adicionais sobre uma imagem que você pode obter, consulte o parâmetro de consulta modules . Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

modules: IList<String>

Uma lista delimitada por vírgulas de insights a serem solicitados. Veja a seguir os possíveis valores que não diferenciam maiúsculas de minúsculas. Todos: retornar todos os insights, se disponíveis, exceto RecognizedEntities. BRQ: Melhor consulta representativa. O termo de consulta que melhor descreve a imagem. Legenda: um legenda que fornece informações sobre a imagem. Se o legenda contiver entidades, a resposta poderá incluir links para imagens dessas entidades. Coleções: uma lista de imagens relacionadas. Receitas: uma lista de receitas para cozinhar a comida mostrada nas imagens. PagesIncluding: uma lista de páginas da Web que incluem a imagem. RecognizedEntities: uma lista de entidades (pessoas) que foram reconhecidas na imagem. OBSERVAÇÃO: você pode não especificar este módulo com nenhum outro módulo. Se você especificá-lo com outros módulos, a resposta não inclui entidades reconhecidas. RelatedSearches: uma lista de pesquisas relacionadas feitas por outras pessoas. ShoppingSources: uma lista de comerciantes onde você pode comprar ofertas relacionadas. SimilarImages: uma lista de imagens que são visualmente semelhantes à imagem original. SimilarProducts: uma lista de imagens que contêm um produto semelhante a um produto encontrado na imagem original. Marcas: fornece características do tipo de conteúdo encontrado na imagem. Por exemplo, se a imagem for de uma pessoa, as marcas poderão indicar o sexo da pessoa e o tipo de roupa que ela está usando. Se você especificar um módulo e não houver dados para o módulo, o objeto de resposta não incluirá o campo relacionado. Por exemplo, se você especificar Caption e ela não existir, a resposta não incluirá o campo imageCaption. Para incluir pesquisas relacionadas, a solicitação deve incluir a cadeia de caracteres de consulta original. Embora a cadeia de caracteres de consulta original não seja necessária para imagens ou produtos semelhantes, você sempre deve incluí-la porque ela pode ajudar a melhorar a relevância e os resultados. Use esse parâmetro somente com a API do Insights. Não especifique esse parâmetro ao chamar as APIs Imagens, Imagens de Tendência ou Pesquisa na Web.

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

safeSearch: String

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 que são 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 vem 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.