EntitiesSearchOptionalParams interface

Pacote:

@azure/cognitiveservices-entitysearch

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 da interface do usuário. A lista está em ordem decrescente de preferência. Para obter informações adicionais, incluindo o formato esperado, consulte RFC2616. Este cabeçalho e o parâmetro de consulta setLang são mutuamente exclusivos; não especificar ambos. Se você definir esse cabeçalho, também deverá especificar o parâmetro cc query. O Bing usará 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 retornar resultados. Se a lista não incluir um idioma suportado, o Bing encontrará o idioma e o mercado mais próximos que suportam a solicitação e poderá usar um mercado agregado ou padrão para os resultados em vez de um mercado especificado. Você deve usar esse cabeçalho e o parâmetro cc query somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Uma cadeia de caracteres da interface do usuário é uma cadeia de caracteres 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. Quaisquer links nos objetos de resposta para Bing.com propriedades aplicarão o idioma especificado.
clientId	O Bing usa esse cabeçalho para fornecer aos usuários um comportamento consistente em chamadas de API do Bing. O Bing frequentemente oferece novos recursos e melhorias, e usa a ID do cliente como uma chave para atribuir tráfego em voos diferentes. Se você não usar a mesma ID de cliente para um usuário em várias solicitações, o Bing poderá atribuir o usuário a vários voos conflitantes. Ser atribuído a vários voos conflitantes pode levar a uma experiência de usuário inconsistente. Por exemplo, se a segunda solicitação tiver uma atribuição de voo 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 resultados, analisando a atividade gerada por uma ID de cliente. As melhorias de relevância ajudam com a melhor qualidade dos resultados fornecidos pelas APIs do Bing e, por sua vez, permitem taxas de cliques mais altas para o consumidor da API. IMPORTANTE: Embora opcional, você deve considerar este cabeçalho obrigatório. A persistência da ID do cliente em várias solicitações para o mesmo usuário final e combinação de dispositivos permite que 1) o consumidor da API receba uma experiência de usuário consistente e 2) taxas de cliques mais altas por meio de uma melhor qualidade dos resultados das APIs do Bing. Cada usuário que usa seu aplicativo no dispositivo deve ter uma ID de 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 seu aplicativo nesse dispositivo. Use a ID do cliente para cada solicitação de API do Bing que seu aplicativo faz para esse usuário no dispositivo. Persista o ID do cliente. Para manter o ID em um aplicativo de navegador, use um cookie HTTP persistente para garantir que o ID seja usado em todas as sessões. Não utilize um cookie de sessão. Para outros aplicativos, como aplicativos móveis, use o armazenamento persistente do dispositivo para manter a ID. Da próxima vez que o usuário usar seu aplicativo nesse dispositivo, obtenha a ID do cliente que você persistiu. As respostas do Bing podem ou não incluir este cabeçalho. Se a resposta incluir esse cabeçalho, capture a ID do cliente e use-a para todas as solicitações subsequentes do Bing para o usuário nesse dispositivo. Se incluir o X-MSEdge-ClientID, não deve incluir cookies no pedido.
clientIp	O endereço IPv4 ou IPv6 do dispositivo cliente. O endereço IP é usado para descobrir a localização do usuário. O Bing usa as informações de localização para determinar o comportamento de pesquisa segura. Embora opcional, você é encorajado a sempre especificar esse cabeçalho e o cabeçalho X-Search-Location. Não ofusque o endereço (por exemplo, alterando o último octeto para 0). Ofuscar o endereço faz com que o local não esteja nem perto da localização real do dispositivo, o que pode resultar em resultados errados para o Bing.
countryCode	Um código de país de 2 caracteres do país de onde provêm os resultados. Esta API suporta apenas o mercado dos Estados Unidos. Se você especificar esse parâmetro de consulta, ele deverá ser definido como nós. Se você definir esse parâmetro, também deverá 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 de país especificado para determinar o mercado para o qual retornar resultados. Se a lista de idiomas não incluir um idioma suportado, o Bing encontrará o idioma e o mercado mais próximos que suportam a solicitação ou poderá usar um mercado agregado ou padrão para os resultados em vez de um mercado 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. Este parâmetro e o parâmetro de consulta mkt são mutuamente exclusivos — não especifique ambos.
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 localização para determinar o comportamento de pesquisa segura e retornar conteúdo local relevante. Especifique o par chave/valor como <chave>:<valor>. A seguir estão as chaves que você usa para especificar a localização do usuário. lat (obrigatório): A latitude da localização do cliente, em graus. A latitude deve ser maior ou igual a -90,0 e menor ou igual a +90,0. Valores negativos indicam latitudes meridionais e valores positivos indicam latitudes setentrionais. longo (obrigatório): A longitude da localização do cliente, em graus. A longitude deve ser maior ou igual a -180,0 e menor ou igual a +180,0. Valores negativos indicam longitudes ocidentais e valores positivos indicam longitudes orientais. re (obrigatório): O raio, em metros, que especifica a precisão horizontal das coordenadas. Passe o valor retornado pelo serviço de localização do dispositivo. Os valores típicos podem ser 22m para GPS/Wi-Fi, 380m para triangulação de torre de celular e 18.000m para pesquisa reversa de IP. ts (opcional): O carimbo de data/hora UTC UNIX de quando o cliente estava no local. (O carimbo de data/hora do UNIX é o número de segundos desde 1º de janeiro de 1970.) head (opcional): A direção relativa do cliente ou direção de viagem. Especifique a direção da viagem como graus de 0 a 360, contando 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. are (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 das chaves sejam opcionais, quanto mais informações você fornecer, mais precisos serão os resultados de localização. Embora opcional, você é encorajado a sempre especificar a localização geográfica do usuário. Fornecer a localização é especialmente importante se o endereço IP do cliente não refletir com precisão a localização física do usuário (por exemplo, se o cliente usa VPN). Para obter resultados ideais, 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 de onde vêm os resultados. Recomenda-se vivamente que especifique sempre o mercado, se conhecido. Especificar o mercado ajuda o Bing a encaminhar a solicitação e retornar uma resposta apropriada e ideal. Este parâmetro e o parâmetro de consulta cc são mutuamente exclusivos—não especifique ambos. Valor padrão: 'en-us'.
pragma	Por padrão, o Bing retorna conteúdo armazenado em cache, se disponível. Para impedir que o Bing retorne conteúdo armazenado em cache, defina o cabeçalho Pragma como no-cache (por exemplo, Pragma: no-cache).
responseFilter	Uma lista delimitada por vírgulas de respostas a incluir na resposta. Se você não especificar esse parâmetro, a resposta incluirá todas as respostas de pesquisa para as quais há dados relevantes.
responseFormat	O tipo de mídia a ser usado para a resposta. A seguir estão os possíveis valores que não diferenciam maiúsculas de minúsculas: JSON, JSONLD. O padrão é JSON. Se você especificar JSONLD, o corpo da resposta incluirá JSON-LD objetos que contêm os resultados da pesquisa.
safeSearch	Um filtro usado para filtrar conteúdo adulto. Desativado: retorna páginas da Web com texto, imagens ou vídeos para adultos. Moderado: retorna páginas da Web com texto adulto, mas não imagens ou vídeos para adultos. Estrito: Não retorne páginas da Web com texto, imagens ou vídeos para adultos. O padrão é Moderado. Se a solicitação vier de um mercado que a política para adultos do Bing exige que o safeSearch esteja definido como Strict, 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. Use site: somente se você estiver ciente do conteúdo no site e seu cenário suporta a possibilidade de conteúdo adulto. Os valores possíveis incluem: 'Desativado', 'Moderado', 'Estrito'
setLang	O idioma a ser usado para cadeias de caracteres da interface do usuário. Especifique o idioma usando o código de idioma ISO 639-1 de 2 letras. Por exemplo, o código do idioma para inglês é EN. O padrão é EN (inglês). Embora opcional, você deve sempre especificar o idioma. Normalmente, você define setLang para o mesmo idioma especificado pelo mkt, a menos que o usuário queira que as cadeias de caracteres da interface do usuário sejam exibidas em um idioma diferente. Este parâmetro e o cabeçalho Accept-Language são mutuamente exclusivos; não especificar ambos. Uma cadeia de caracteres da interface do usuário é uma cadeia de caracteres 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, quaisquer links para propriedades Bing.com nos objetos de resposta aplicam o idioma especificado.
userAgent	O agente de usuário que origina a solicitação. O Bing usa o agente do usuário para fornecer aos usuários móveis uma experiência otimizada. Embora opcional, é altamente recomendável especificar sempre esse cabeçalho. O agente do usuário deve ser a mesma cadeia de caracteres que qualquer navegador comumente usado enviaria. Para obter informações sobre agentes de usuário, consulte RFC 2616.

Propriedades Herdadas

abortSignal	O sinal que pode ser usado para abortar solicitações.
customHeaders	Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes que a solicitação seja enviada.
onDownloadProgress	Retorno de chamada que é acionado após o progresso do download.
onUploadProgress	Retorno de chamada que é acionado após o progresso do carregamento.
timeout	O número de milissegundos que uma solicitação pode levar antes de ser encerrada automaticamente.

Detalhes de Propriedade

acceptLanguage

Uma lista delimitada por vírgulas de um ou mais idiomas a serem usados para cadeias de caracteres da interface do usuário. A lista está em ordem decrescente de preferência. Para obter informações adicionais, incluindo o formato esperado, consulte RFC2616. Este cabeçalho e o parâmetro de consulta setLang são mutuamente exclusivos; não especificar ambos. Se você definir esse cabeçalho, também deverá especificar o parâmetro cc query. O Bing usará 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 retornar resultados. Se a lista não incluir um idioma suportado, o Bing encontrará o idioma e o mercado mais próximos que suportam a solicitação e poderá usar um mercado agregado ou padrão para os resultados em vez de um mercado especificado. Você deve usar esse cabeçalho e o parâmetro cc query somente se especificar vários idiomas; caso contrário, você deve usar os parâmetros de consulta mkt e setLang. Uma cadeia de caracteres da interface do usuário é uma cadeia de caracteres 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. Quaisquer links nos objetos de resposta para Bing.com propriedades aplicarão o idioma especificado.

acceptLanguage?: string

Valor de Propriedade

string

clientId

O Bing usa esse cabeçalho para fornecer aos usuários um comportamento consistente em chamadas de API do Bing. O Bing frequentemente oferece novos recursos e melhorias, e usa a ID do cliente como uma chave para atribuir tráfego em voos diferentes. Se você não usar a mesma ID de cliente para um usuário em várias solicitações, o Bing poderá atribuir o usuário a vários voos conflitantes. Ser atribuído a vários voos conflitantes pode levar a uma experiência de usuário inconsistente. Por exemplo, se a segunda solicitação tiver uma atribuição de voo 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 resultados, analisando a atividade gerada por uma ID de cliente. As melhorias de relevância ajudam com a melhor qualidade dos resultados fornecidos pelas APIs do Bing e, por sua vez, permitem taxas de cliques mais altas para o consumidor da API. IMPORTANTE: Embora opcional, você deve considerar este cabeçalho obrigatório. A persistência da ID do cliente em várias solicitações para o mesmo usuário final e combinação de dispositivos permite que 1) o consumidor da API receba uma experiência de usuário consistente e 2) taxas de cliques mais altas por meio de uma melhor qualidade dos resultados das APIs do Bing. Cada usuário que usa seu aplicativo no dispositivo deve ter uma ID de 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 seu aplicativo nesse dispositivo. Use a ID do cliente para cada solicitação de API do Bing que seu aplicativo faz para esse usuário no dispositivo. Persista o ID do cliente. Para manter o ID em um aplicativo de navegador, use um cookie HTTP persistente para garantir que o ID seja usado em todas as sessões. Não utilize um cookie de sessão. Para outros aplicativos, como aplicativos móveis, use o armazenamento persistente do dispositivo para manter a ID. Da próxima vez que o usuário usar seu aplicativo nesse dispositivo, obtenha a ID do cliente que você persistiu. As respostas do Bing podem ou não incluir este cabeçalho. Se a resposta incluir esse cabeçalho, capture a ID do cliente e use-a para todas as solicitações subsequentes do Bing para o usuário nesse dispositivo. Se incluir o X-MSEdge-ClientID, não deve incluir cookies no pedido.

clientId?: string

Valor de Propriedade

string

clientIp

O endereço IPv4 ou IPv6 do dispositivo cliente. O endereço IP é usado para descobrir a localização do usuário. O Bing usa as informações de localização para determinar o comportamento de pesquisa segura. Embora opcional, você é encorajado a sempre especificar esse cabeçalho e o cabeçalho X-Search-Location. Não ofusque o endereço (por exemplo, alterando o último octeto para 0). Ofuscar o endereço faz com que o local não esteja nem perto da localização real do dispositivo, o que pode resultar em resultados errados para o Bing.

clientIp?: string

Valor de Propriedade

string

countryCode

Um código de país de 2 caracteres do país de onde provêm os resultados. Esta API suporta apenas o mercado dos Estados Unidos. Se você especificar esse parâmetro de consulta, ele deverá ser definido como nós. Se você definir esse parâmetro, também deverá 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 de país especificado para determinar o mercado para o qual retornar resultados. Se a lista de idiomas não incluir um idioma suportado, o Bing encontrará o idioma e o mercado mais próximos que suportam a solicitação ou poderá usar um mercado agregado ou padrão para os resultados em vez de um mercado 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. Este parâmetro e o parâmetro de consulta mkt são mutuamente exclusivos — não especifique ambos.

countryCode?: string

Valor de Propriedade

string

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 localização para determinar o comportamento de pesquisa segura e retornar conteúdo local relevante. Especifique o par chave/valor como <chave>:<valor>. A seguir estão as chaves que você usa para especificar a localização do usuário. lat (obrigatório): A latitude da localização do cliente, em graus. A latitude deve ser maior ou igual a -90,0 e menor ou igual a +90,0. Valores negativos indicam latitudes meridionais e valores positivos indicam latitudes setentrionais. longo (obrigatório): A longitude da localização do cliente, em graus. A longitude deve ser maior ou igual a -180,0 e menor ou igual a +180,0. Valores negativos indicam longitudes ocidentais e valores positivos indicam longitudes orientais. re (obrigatório): O raio, em metros, que especifica a precisão horizontal das coordenadas. Passe o valor retornado pelo serviço de localização do dispositivo. Os valores típicos podem ser 22m para GPS/Wi-Fi, 380m para triangulação de torre de celular e 18.000m para pesquisa reversa de IP. ts (opcional): O carimbo de data/hora UTC UNIX de quando o cliente estava no local. (O carimbo de data/hora do UNIX é o número de segundos desde 1º de janeiro de 1970.) head (opcional): A direção relativa do cliente ou direção de viagem. Especifique a direção da viagem como graus de 0 a 360, contando 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. are (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 das chaves sejam opcionais, quanto mais informações você fornecer, mais precisos serão os resultados de localização. Embora opcional, você é encorajado a sempre especificar a localização geográfica do usuário. Fornecer a localização é especialmente importante se o endereço IP do cliente não refletir com precisão a localização física do usuário (por exemplo, se o cliente usa VPN). Para obter resultados ideais, 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 de Propriedade

string

market

O mercado de onde vêm os resultados. Recomenda-se vivamente que especifique sempre o mercado, se conhecido. Especificar o mercado ajuda o Bing a encaminhar a solicitação e retornar uma resposta apropriada e ideal. Este parâmetro e o parâmetro de consulta cc são mutuamente exclusivos—não especifique ambos. Valor padrão: 'en-us'.

market?: string

Valor de Propriedade

string

pragma

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

pragma?: string

Valor de Propriedade

string

responseFilter

Uma lista delimitada por vírgulas de respostas a incluir na resposta. Se você não especificar esse parâmetro, a resposta incluirá todas as respostas de pesquisa para as quais há dados relevantes.

responseFilter?: AnswerType[]

Valor de Propriedade

AnswerType[]

responseFormat

O tipo de mídia a ser usado para a resposta. A seguir estão os possíveis valores que não diferenciam maiúsculas de minúsculas: JSON, JSONLD. O padrão é JSON. Se você especificar JSONLD, o corpo da resposta incluirá JSON-LD objetos que contêm os resultados da pesquisa.

responseFormat?: ResponseFormat[]

Valor de Propriedade

ResponseFormat[]

safeSearch

Um filtro usado para filtrar conteúdo adulto. Desativado: retorna páginas da Web com texto, imagens ou vídeos para adultos. Moderado: retorna páginas da Web com texto adulto, mas não imagens ou vídeos para adultos. Estrito: Não retorne páginas da Web com texto, imagens ou vídeos para adultos. O padrão é Moderado. Se a solicitação vier de um mercado que a política para adultos do Bing exige que o safeSearch esteja definido como Strict, 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. Use site: somente se você estiver ciente do conteúdo no site e seu cenário suporta a possibilidade de conteúdo adulto. Os valores possíveis incluem: 'Desativado', 'Moderado', 'Estrito'

safeSearch?: SafeSearch

Valor de Propriedade

SafeSearch

setLang

O idioma a ser usado para cadeias de caracteres da interface do usuário. Especifique o idioma usando o código de idioma ISO 639-1 de 2 letras. Por exemplo, o código do idioma para inglês é EN. O padrão é EN (inglês). Embora opcional, você deve sempre especificar o idioma. Normalmente, você define setLang para o mesmo idioma especificado pelo mkt, a menos que o usuário queira que as cadeias de caracteres da interface do usuário sejam exibidas em um idioma diferente. Este parâmetro e o cabeçalho Accept-Language são mutuamente exclusivos; não especificar ambos. Uma cadeia de caracteres da interface do usuário é uma cadeia de caracteres 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, quaisquer links para propriedades Bing.com nos objetos de resposta aplicam o idioma especificado.

setLang?: string

Valor de Propriedade

string

userAgent

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

userAgent?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

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

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de msRest.RequestOptionsBase.abortSignal

customHeaders

Cabeçalhos de solicitação personalizados definidos pelo usuário que serão aplicados antes que a solicitação seja enviada.

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

Valor de Propriedade

{[key: string]: string}

herdado de msRest.RequestOptionsBase.customHeaders

onDownloadProgress

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

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valor de Propriedade

(progress: TransferProgressEvent) => void

herdado de msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Retorno de chamada que é acionado após o progresso do carregamento.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valor de 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 de Propriedade

number

herdado de msRest.RequestOptionsBase.timeout