CustomInstanceExtensions.ImageSearchAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.CognitiveServices.Search.CustomImageSearch

Ensamblado:

Microsoft.Azure.CognitiveServices.Search.CustomImageSearch.dll

Paquete:

Microsoft.Azure.CognitiveServices.Search.CustomImageSearch v2.0.0

Custom Image Search API le permite enviar una consulta de búsqueda de imágenes a Bing y obtener los resultados de la imagen que se encuentran en la vista personalizada de la web.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.CustomImageSearch.Models.Images> ImageSearchAsync (this Microsoft.Azure.CognitiveServices.Search.CustomImageSearch.ICustomInstance operations, string customConfig, string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string aspect = default, string color = default, string countryCode = default, int? count = default, string freshness = default, int? height = default, string id = default, string imageContent = default, string imageType = default, string license = default, string market = default, long? maxFileSize = default, long? maxHeight = default, long? maxWidth = default, long? minFileSize = default, long? minHeight = default, long? minWidth = default, long? offset = default, string safeSearch = default, string size = default, string setLang = default, int? width = default, System.Threading.CancellationToken cancellationToken = default);

static member ImageSearchAsync : Microsoft.Azure.CognitiveServices.Search.CustomImageSearch.ICustomInstance * string * string * string * string * string * string * string * string * string * string * Nullable<int> * string * Nullable<int> * string * string * string * string * string * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * Nullable<int64> * string * string * string * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.CustomImageSearch.Models.Images>

<Extension()>
Public Function ImageSearchAsync (operations As ICustomInstance, customConfig As String, query As String, Optional acceptLanguage As String = Nothing, Optional userAgent As String = Nothing, Optional clientId As String = Nothing, Optional clientIp As String = Nothing, Optional location As String = Nothing, Optional aspect As String = Nothing, Optional color As String = Nothing, Optional countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As String = Nothing, Optional height As Nullable(Of Integer) = Nothing, Optional id As String = Nothing, Optional imageContent As String = Nothing, Optional imageType As String = Nothing, Optional license As String = Nothing, Optional market As String = Nothing, Optional maxFileSize As Nullable(Of Long) = Nothing, Optional maxHeight As Nullable(Of Long) = Nothing, Optional maxWidth As Nullable(Of Long) = Nothing, Optional minFileSize As Nullable(Of Long) = Nothing, Optional minHeight As Nullable(Of Long) = Nothing, Optional minWidth As Nullable(Of Long) = Nothing, Optional offset As Nullable(Of Long) = Nothing, Optional safeSearch As String = Nothing, Optional size As String = Nothing, Optional setLang As String = Nothing, Optional width As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Images)

Parámetros

operations

ICustomInstance

El grupo de operaciones de este método de extensión.

customConfig

String

Identificador de la configuración de búsqueda personalizada

query

String

Término de consulta de búsqueda del usuario. El término no puede estar vacío. El término puede contener operadores avanzados de Bing. Por ejemplo, para limitar las imágenes a un dominio específico, use el operador site: . Para ayudar a mejorar la relevancia de una consulta de insights (consulte insightsToken), siempre debe incluir el término de consulta del usuario. Use este parámetro solo con image Search API.Do no especifique este parámetro al llamar a Trending Images API.

acceptLanguage

String

Lista delimitada por comas de uno o varios idiomas que se van a usar para las cadenas de la interfaz de usuario. La lista se muestra en orden de preferencia decreciente. Para obtener más información, incluido el formato esperado, consulte RFC2616. Este encabezado y el parámetro de consulta setLang son mutuamente excluyentes; no especifique ambos. Si establece este encabezado, debe especificar también el parámetro de consulta cc. Para determinar el mercado para el que se devuelven los resultados, Bing usa el primer idioma admitido que encuentra en la lista y lo combina con el valor del parámetro cc. Si la lista no incluye ningún idioma compatible, Bing busca el idioma y el mercado más cercanos que admiten la solicitud, o bien usa un mercado agregado o predeterminado para los resultados. Para determinar el mercado que usó Bing, consulte el encabezado BingAPIs-Market. Use este encabezado y el parámetro de consulta cc solo si especifica varios idiomas. En caso contrario, use los parámetros de consulta mkt y setLang. Una cadena de interfaz de usuario es aquella que se usa como etiqueta en una interfaz de usuario. Hay pocas cadenas de interfaz de usuario en los objetos de respuesta JSON. Todos los vínculos a las propiedades de Bing.com en los objetos de respuesta aplican el idioma especificado.

userAgent

String

El agente de usuario que origina la solicitud. Bing usa el agente de usuario para proporcionar a los usuarios de dispositivos móviles una experiencia optimizada. Aunque es opcional, se recomienda especificar siempre este encabezado. El agente de usuario debe ser la misma cadena que envían los exploradores que más se usan. Para obtener información sobre los agentes de usuario, consulte RFC 2616. A continuación se muestran ejemplos de cadenas de agente de usuario. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; BRAZO; Tocar; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - nosotros; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb/ 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Tocar; rv:11.0) como Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 como Mac OS X) AppleWebKit / 537.51.1 (KHTML, como Gecko) Versión / 7.0 Mobile / 11A465 Safari / 9537.53

clientId

String

Bing usa este encabezado para proporcionar a los usuarios un comportamiento coherente en las llamadas API de Bing. Bing incorpora a menudo mejoras y características piloto nuevas, y usa el identificador de cliente como clave para asignar el tráfico en distintos paquetes piloto. Si no usa el mismo identificador de cliente para un usuario en varias solicitudes, Bing puede asignar el usuario a varios paquetes piloto en conflicto. La asignación a varios paquetes piloto en conflicto puede generar una experiencia de usuario incoherente. Por ejemplo, si la segunda solicitud tiene una asignación de paquete piloto distinta de la primera, puede que se produzca una experiencia inesperada. Además, Bing puede usar el identificador de cliente para personalizar los resultados web en el historial de búsqueda del identificador de cliente, lo que proporciona una experiencia enriquecida para el usuario. Bing también utiliza este encabezado para ayudar a mejorar las clasificaciones de resultados mediante el análisis de la actividad que genera un identificador de cliente. Las mejoras de relevancia ayudan con una mayor calidad de los resultados que devuelven las API de Bing y, a su vez, permiten un mayor porcentaje de clics para el consumidor de la API. IMPORTANTE: Aunque es opcional, considere este encabezado como obligatorio. Conservar el identificador de cliente en varias solicitudes para la misma combinación de usuario final y dispositivo permite 1) que el consumidor de API reciba una experiencia de usuario coherente y 2) un mayor porcentaje de clics a través de una mejor calidad de los resultados de las API de Bing. Cada usuario que utiliza la aplicación en el dispositivo debe tener un identificador de cliente único generado por Bing. Si no incluye este encabezado en la solicitud, Bing genera un identificador y lo devuelve en el encabezado de respuesta X-MSEdge-ClientID. La única ocasión en que NO debe incluir este encabezado en una solicitud es la primera vez que el usuario usa la aplicación en el dispositivo. Use el identificador de cliente para cada solicitud de API de Bing que haga la aplicación para este usuario en el dispositivo. Conserve el identificador de cliente. Para conservar el identificador en una aplicación de explorador, use una cookie HTTP persistente para asegurarse de que se use ese identificador en todas las sesiones. No use una cookie de sesión. Para otras aplicaciones, como aplicaciones móviles, use el almacenamiento persistente del dispositivo para conservar el identificador. La próxima vez que el usuario use la aplicación en ese dispositivo, obtenga el identificador de cliente que conservó. Las respuestas de Bing pueden incluir este encabezado o no incluirlo. Si la respuesta incluye este encabezado, capture el identificador de cliente y úselo para todas las solicitudes posteriores de Bing del usuario en dicho dispositivo. Si incluye X-MSEdge-ClientID, no debe incluir cookies en la solicitud.

clientIp

String

Dirección IPv4 o IPv6 del dispositivo cliente. La dirección IP se usa para detectar la ubicación del usuario. Bing usa la información de ubicación para determinar el comportamiento de la búsqueda segura. Aunque es opcional, se recomienda especificar siempre tanto este encabezado como el encabezado X-Search-Location. No ofusque la dirección (por ejemplo, cambiando el último octeto a 0). Al ofuscar los resultados de dirección, la ubicación no se encuentra cerca de la ubicación real, lo que puede provocar que Bing devuelva resultados erróneos.

location

String

Una lista delimitada por punto y coma de pares clave-valor que describen la ubicación geográfica del cliente. Bing usa la información de ubicación para determinar el comportamiento de la búsqueda segura y devolver contenido local apropiado. Especifique el par clave-valor como <clave>:<valor>. A continuación se incluyen las claves que usan para especificar la ubicación del usuario. lat (obligatorio): latitud de la ubicación del cliente, en grados. La latitud debe ser mayor o igual que -90.0, y menor o igual que +90.0. Los valores negativos indican latitudes del sur, mientras que los valores positivos indican latitudes del norte. long (obligatorio): longitud de la ubicación del cliente, en grados. La longitud debe ser mayor o igual que -180.0, y menor o igual que +180.0. Los valores negativos indican longitudes del oeste, mientras que los valores positivos indican longitudes del este. re (obligatorio): radio, en metros, que especifica la precisión horizontal de las coordenadas. Pase el valor que devuelve el servicio de ubicación del dispositivo. Los valores típicos pueden ser 22 m para GPS/Wi-Fi, 380 m para la triangulación de antenas repetidoras de telefonía móvil y 18 000 m para la búsqueda inversa de IP. ts (opcional): la marca de tiempo DE UNIX UTC de cuando el cliente estaba en la ubicación. (La marca de tiempo de UNIX es el número de segundos desde el 1 de enero de 1970). head (opcional): el encabezado relativo o la dirección del viaje del cliente. Especifique la dirección de desplazamiento como grados de 0 a 360, en la dirección de las agujas del reloj con respecto al norte verdadero. Especifique esta clave solo si la clave sp es distinta de cero. sp (opcional): velocidad horizontal (velocidad), en metros por segundo, que el dispositivo cliente está viajando. alt (opcional): altitud del dispositivo cliente, en metros. are (opcional): el radio, en metros, que especifica la precisión vertical de las coordenadas. Especifique esta clave solo si especifica la tecla alt. Aunque muchas de las claves son opcionales, cuanta más información proporcione, más precisos serán los resultados de ubicación. Aunque es opcional, se recomienda especificar siempre la ubicación geográfica del usuario. Proporcionar la ubicación es especialmente importante si la dirección IP del cliente no refleja con precisión la ubicación física del usuario (por ejemplo, si el cliente utiliza VPN). Para obtener resultados óptimos, debería incluir tanto este encabezado como X-MSEdge-ClientIP pero, como mínimo, debe incluir este.

aspect

String

Filtre las imágenes por las siguientes relaciones de aspecto. Todo: no filtre por aspecto. Especificar este valor es el mismo que no especificar el parámetro de aspecto. Cuadrado: devuelve imágenes con relación de aspecto estándar. Ancho: devuelve imágenes con relación de aspecto de pantalla ancha. Alto: devuelve imágenes con una relación de aspecto alta. Entre los valores posibles se incluyen: 'All', 'Square', 'Wide', 'Tall'

color

String

Filtre las imágenes por las siguientes opciones de color. ColorOnly: devuelve imágenes de color. Monocromo: devuelve imágenes negras y blancas. Devuelve imágenes con uno de los siguientes colores dominantes: Negro, Azul, Marrón, Gris, Verde, Naranja, Rosa, Púrpura, Rojo, Teal, Blanco, Amarillo. Entre los valores posibles se incluyen: 'ColorOnly', 'Monochrome', 'Black', 'Blue', 'Brown', 'Gray', 'Green', 'Orange', 'Pink', 'Purple', 'Red', 'Teal', 'White', 'Yellow'

countryCode

String

Un código de país de 2 caracteres del país del que provienen los resultados. Para obtener una lista de los valores posibles, consulte Códigos de mercado. Si establece este parámetro, debe especificar también el encabezado Accept-Language. Bing usa el primer idioma admitido que encuentra en la lista de idiomas y combina ese idioma con el código de país que especifiques para determinar el mercado para el que se devuelven los resultados. Si la lista de idiomas no incluye un idioma admitido, Bing busca el idioma y el mercado más cercanos que admiten la solicitud, o bien puede usar un mercado agregado o predeterminado para los resultados en lugar de uno especificado. Debe usar este parámetro de consulta y el parámetro de consulta Accept-Language solo si especifica varios idiomas; De lo contrario, debe usar los parámetros de consulta mkt y setLang. Este parámetro y el parámetro de consulta mkt son mutuamente excluyentes: no especifique los dos.

count

Nullable<Int32>

Número de imágenes que se van a devolver en la respuesta. El número real entregado puede ser menor que el solicitado. El valor predeterminado es 35. El valor máximo es 150. Este parámetro se usa junto con el parámetro offset para los resultados de la página. Por ejemplo, si la interfaz de usuario muestra 20 imágenes por página, establezca recuento en 20 y desplazamiento en 0 para obtener la primera página de resultados. Para cada página posterior, incremente el desplazamiento en 20 (por ejemplo, 0, 20, 40). Use este parámetro solo con image Search API.Do no especifique este parámetro al llamar a las API Insights, Trending Images o Web Search.

freshness

String

Filtre las imágenes por las siguientes opciones de detección. Día: devuelve imágenes detectadas por Bing en las últimas 24 horas. Semana: devuelve imágenes detectadas por Bing en los últimos 7 días. Mes: devuelve imágenes detectadas por Bing en los últimos 30 días. Entre los valores posibles se incluyen: 'Day', 'Week', 'Month'

height

Nullable<Int32>

Filtre las imágenes que tengan el alto especificado, en píxeles. Puede usar este filtro con el filtro de tamaño para devolver imágenes pequeñas que tengan un alto de 150 píxeles.

id

String

Identificador que identifica de forma única una imagen. Use este parámetro para asegurarse de que la imagen especificada es la primera imagen de la lista de imágenes que Bing devuelve. El campo imageId del objeto Image contiene el identificador en el que se establece este parámetro.

imageContent

String

Filtre las imágenes por los siguientes tipos de contenido. Cara: devuelve imágenes que muestran solo la cara de una persona. Vertical: devuelve imágenes que muestran solo la cabeza y los hombros de una persona. Entre los valores posibles se incluyen: "Face", "Portrait"

imageType

String

Filtre las imágenes por los siguientes tipos de imagen. AnimatedGif: devuelve solo GIF animados. Clipart: devuelve solo imágenes de imágenes prediseñadas. Línea: devuelve solo dibujos de línea. Foto: Devuelve solo fotografías (excepto dibujos de líneas, gifs animados y imágenes prediseñadas). Compras: devuelve solo imágenes que contienen elementos en los que Bing conoce a un comerciante que vende los artículos. Esta opción es válida solo en el mercado en - EE. UU. Transparente: devuelve solo imágenes con un fondo transparente. Entre los valores posibles se incluyen: 'AnimatedGif', 'Clipart', 'Line', 'Photo', 'Shopping', 'Transparent'

license

String

Filtre las imágenes por los siguientes tipos de licencia. All: no filtre por tipo de licencia. Especificar este valor es el mismo que no especificar el parámetro de licencia. Any: devuelve imágenes que están bajo cualquier tipo de licencia. La respuesta no incluye imágenes que no especifican una licencia o la licencia es desconocida. Público: devuelve imágenes en las que el creador ha renunciado a sus derechos exclusivos, en la medida más completa permitida por la ley. Compartir: devuelve imágenes que se pueden compartir con otros usuarios. Es posible que no se permita cambiar o editar la imagen. Además, es posible que no se permita modificar, compartir y usar la imagen con fines comerciales. Normalmente, esta opción devuelve la mayoría de las imágenes. ShareCommercially: devuelve imágenes que se pueden compartir con otros usuarios con fines personales o comerciales. Es posible que no se permita cambiar o editar la imagen. Modificar: devuelve imágenes que se pueden modificar, compartir y usar. Es posible que no se permita cambiar o editar la imagen. Es posible que no se permita modificar, compartir y usar la imagen con fines comerciales. ModifyCommercially: devuelve imágenes que se pueden modificar, compartir y usar con fines personales o comerciales. Normalmente, esta opción devuelve las imágenes más pocas. Para obtener más información sobre estos tipos de licencia, vea Filtrar imágenes por tipo de licencia. Entre los valores posibles se incluyen: "All", "Any", "Public", "Share", "ShareCommercially", "Modify", "ModifyCommercially"

market

String

Mercado de dónde proceden los resultados. Normalmente, mkt es el país desde el que el usuario realiza la solicitud. Sin embargo, podría ser un país diferente si el usuario no se encuentra en un país donde Bing entrega resultados. El mercado debe estar en el código> de>< país del código de idioma de formulario<. Por ejemplo, en-US. La cadena no distingue mayúsculas de minúsculas. Para obtener una lista de posibles valores de mercado, consulte Códigos de mercado. NOTA: Si se conoce, se recomienda especificar siempre el mercado. Especificar el mercado ayuda a Bing a enrutar la solicitud y devolver una respuesta adecuada y óptima. Si especifica un mercado que no aparece en Códigos de mercado, Bing usa un código de mercado adecuado basado en una asignación interna que está sujeta a cambios. Este parámetro y el parámetro de consulta cc son mutuamente excluyentes: no especifique los dos.

maxFileSize

Nullable<Int64>

Filtre las imágenes que sean menores o iguales que el tamaño de archivo especificado. El tamaño máximo de archivo que puede especificar es de 520 192 bytes. Si especifica un valor mayor, la API usa 520 192. Es posible que la respuesta incluya imágenes ligeramente mayores que el máximo especificado. Puede especificar este filtro y minFileSize para filtrar imágenes dentro de un intervalo de tamaños de archivo.

maxHeight

Nullable<Int64>

Filtre las imágenes que tengan un alto menor o igual que el alto especificado. Especifique el alto en píxeles. Puede especificar este filtro y minHeight para filtrar imágenes dentro de un intervalo de alturas. Este filtro y el filtro de alto son mutuamente excluyentes.

maxWidth

Nullable<Int64>

Filtre las imágenes que tengan un ancho menor o igual que el ancho especificado. Especifique el ancho en píxeles. Puede especificar este filtro y maxWidth para filtrar imágenes dentro de un intervalo de anchos. Este filtro y el filtro de ancho son mutuamente excluyentes.

minFileSize

Nullable<Int64>

Filtre las imágenes que sean mayores o iguales que el tamaño de archivo especificado. El tamaño máximo de archivo que puede especificar es de 520 192 bytes. Si especifica un valor mayor, la API usa 520 192. Es posible que la respuesta incluya imágenes ligeramente más pequeñas que el mínimo especificado. Puede especificar este filtro y maxFileSize para filtrar imágenes dentro de un intervalo de tamaños de archivo.

minHeight

Nullable<Int64>

Filtre las imágenes que tengan un alto mayor o igual que el alto especificado. Especifique el alto en píxeles. Puede especificar este filtro y maxHeight para filtrar imágenes dentro de un intervalo de alturas. Este filtro y el filtro de alto son mutuamente excluyentes.

minWidth

Nullable<Int64>

Filtre las imágenes que tengan un ancho mayor o igual que el ancho especificado. Especifique el ancho en píxeles. Puede especificar este filtro y maxWidth para filtrar imágenes dentro de un intervalo de anchos. Este filtro y el filtro de ancho son mutuamente excluyentes.

offset

Nullable<Int64>

Desplazamiento de base cero que indica el número de imágenes que se van a omitir antes de devolver imágenes. El valor predeterminado es 0. El desplazamiento debe ser menor que (totalEstimatedMatches)

• count). Use este parámetro junto con el parámetro count para los resultados de la página. Por ejemplo, si la interfaz de usuario muestra 20 imágenes por página, establezca recuento en 20 y desplazamiento en 0 para obtener la primera página de resultados. Para cada página posterior, incremente el desplazamiento en 20 (por ejemplo, 0, 20, 40). Es posible que varias páginas incluyan alguna superposición en los resultados. Para evitar duplicados, consulte nextOffset. Use este parámetro solo con Image API. No especifique este parámetro al llamar a Trending Images API o a Web Search API.

safeSearch

String

Filtrar imágenes para contenido para adultos. A continuación se muestran los valores de filtro posibles. Desactivado: puede devolver imágenes con contenido para adultos. Si la solicitud se realiza a través de Image Search API, la respuesta incluye imágenes en miniatura que están claras (no aproximadas). Sin embargo, si la solicitud se realiza a través de Web Search API, la respuesta incluye imágenes en miniatura pixeladas (aproximadas). Moderado: si la solicitud se realiza a través de Image Search API, la respuesta no incluye imágenes con contenido para adultos. Si la solicitud se realiza a través de Web Search API, la respuesta puede incluir imágenes con contenido para adultos (las imágenes en miniatura se pixelan (aproximadamente)). Strict: no devuelva imágenes con contenido para adultos. El valor predeterminado es Moderado. Si la solicitud procede de un mercado que la directiva para adultos de Bing requiere que safeSearch esté establecido en Strict, Bing omite el valor safeSearch y usa Strict. Si usa el operador de consulta site: , existe la posibilidad de que la respuesta contenga contenido para adultos, independientemente de en qué se establezca el parámetro de consulta safeSearch. Usar sitio: solo si conoce el contenido en el sitio y su escenario admite la posibilidad de contenido para adultos. Entre los valores posibles se incluyen: "Off", "Moderate", "Strict"

size

String

Filtre las imágenes por los tamaños siguientes. Todo: no filtre por tamaño. Especificar este valor es el mismo que no especificar el parámetro size. Pequeño: devuelve imágenes que tienen menos de 200 x 200 píxeles. Medio: devuelve imágenes mayores o iguales que 200 x 200 píxeles, pero menores que 500 x 500 píxeles. Grande: devuelve imágenes de 500 x 500 píxeles o más. Papel tapiz: Devuelve imágenes de fondo de pantalla. Puede usar este parámetro junto con los parámetros de alto o ancho. Por ejemplo, puede usar el alto y el tamaño para solicitar imágenes pequeñas de 150 píxeles de alto. Entre los valores posibles se incluyen: 'All', 'Small', 'Medium', 'Large', 'Wallpaper'

setLang

String

Idioma que se usará para las cadenas de la interfaz de usuario. Especifique el idioma con el código ISO 639-1 de 2 letras. Por ejemplo, el código de idioma de inglés es EN. El valor predeterminado es EN (inglés). Aunque sea opcional, siempre debe especificar el idioma. Normalmente, establece setLang en el mismo idioma especificado por mkt a menos que el usuario quiera que las cadenas de la interfaz de usuario se muestren en un idioma diferente. Este parámetro y el encabezado Accept-Language son mutuamente excluyentes; no especifique ambos. Una cadena de interfaz de usuario es aquella que se usa como etiqueta en una interfaz de usuario. Hay pocas cadenas de interfaz de usuario en los objetos de respuesta JSON. Además, los vínculos a las propiedades de Bing.com de los objetos de respuesta aplican el idioma especificado.

width

Nullable<Int32>

Filtre las imágenes que tienen el ancho especificado, en píxeles. Puede usar este filtro con el filtro de tamaño para devolver imágenes pequeñas con un ancho de 150 píxeles.

cancellationToken

CancellationToken

Token de cancelación.

Devoluciones

Task<Images>