VideosOperationsExtensions.SearchAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.CognitiveServices.Search.VideoSearch

Ensamblado:

Microsoft.Azure.CognitiveServices.Search.VideoSearch.dll

Paquete:

Microsoft.Azure.CognitiveServices.Search.VideoSearch v2.0.0

Video Search API le permite enviar una consulta de búsqueda a Bing y obtener una lista de vídeos relevantes para la consulta de búsqueda. En esta sección se proporcionan detalles técnicos sobre los parámetros y encabezados de consulta que se usan para solicitar vídeos y los objetos de respuesta JSON que los contienen. Para obtener ejemplos que muestran cómo realizar solicitudes, vea Buscar en la Web para vídeos.

public static System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos> SearchAsync (this Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations operations, string query, string acceptLanguage = default, string userAgent = default, string clientId = default, string clientIp = default, string location = default, string countryCode = default, int? count = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness? freshness = default, string id = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength? length = default, string market = default, int? offset = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing? pricing = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution? resolution = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch? safeSearch = default, string setLang = default, bool? textDecorations = default, Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat? textFormat = default, System.Threading.CancellationToken cancellationToken = default);

static member SearchAsync : Microsoft.Azure.CognitiveServices.Search.VideoSearch.IVideosOperations * string * string * string * string * string * string * string * Nullable<int> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Freshness> * string * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoLength> * string * Nullable<int> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoPricing> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.VideoResolution> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.SafeSearch> * string * Nullable<bool> * Nullable<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.TextFormat> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.CognitiveServices.Search.VideoSearch.Models.Videos>

<Extension()>
Public Function SearchAsync (operations As IVideosOperations, 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 countryCode As String = Nothing, Optional count As Nullable(Of Integer) = Nothing, Optional freshness As Nullable(Of Freshness) = Nothing, Optional id As String = Nothing, Optional length As Nullable(Of VideoLength) = Nothing, Optional market As String = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional pricing As Nullable(Of VideoPricing) = Nothing, Optional resolution As Nullable(Of VideoResolution) = Nothing, Optional safeSearch As Nullable(Of SafeSearch) = Nothing, Optional setLang As String = Nothing, Optional textDecorations As Nullable(Of Boolean) = Nothing, Optional textFormat As Nullable(Of TextFormat) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Videos)

Parámetros

operations

IVideosOperations

Grupo de operaciones para este método de extensión.

query

String

Cadena de consulta de búsqueda del usuario. La cadena de consulta no puede estar vacía. La cadena de consulta puede contener operadores avanzados de Bing. Por ejemplo, para limitar vídeos a un dominio específico, use el operador site: . Use este parámetro solo con Video Search API. No especifique este parámetro al llamar a Trending Videos API.

acceptLanguage

String

Lista delimitada por comas de uno o varios idiomas que se usarán 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 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; 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): 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): encabezado relativo del cliente o dirección de viaje. 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 no es cero. sp (opcional): velocidad horizontal (velocidad), en metros por segundo, que el dispositivo cliente está viajando. alt (opcional): la altitud del dispositivo cliente, en metros. are (opcional): 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.

countryCode

String

Un código de país de 2 caracteres del país del que provienen los resultados. Esta API solo admite el mercado de Estados Unidos. Si especifica este parámetro de consulta, debe establecerse en nosotros. 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 vídeos 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 máximo es 105. Puede usar este parámetro junto con el parámetro offset para los resultados de la página. Por ejemplo, si la interfaz de usuario presenta 20 vídeos 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 Video Search API. No especifique este parámetro al llamar a Trending Videos API ni a Web Search API.

freshness

Nullable<Freshness>

Filtre los vídeos por la fecha y hora en que Bing detectó el vídeo. A continuación se muestran los valores de filtro posibles. Día: devuelve vídeos detectados en las últimas 24 horas. Semana: devuelve vídeos detectados en los últimos 7 días. Mes: devuelve vídeos detectados en los últimos 30 días. Entre los valores posibles se incluyen: 'Day', 'Week', 'Month'

id

String

Identificador que identifica de forma única un vídeo. El campo VideoId del objeto Video contiene el identificador en el que se establece este parámetro. Use este parámetro para asegurarse de que el vídeo especificado es el primer vídeo de la lista de vídeos que Bing devuelve.

length

Nullable<VideoLength>

Filtrar vídeos por las siguientes longitudes: Short: Return videos que tienen menos de 5 minutos. Medio: devuelve vídeos entre 5 y 20 minutos, ambos incluidos. Long: devuelve vídeos que tienen más de 20 minutos. All: No filtre por longitud. Especificar este valor es el mismo que no especificar el parámetro videoLength. Entre los valores posibles se incluyen: "All", "Short", "Medium", "Long"

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.

offset

Nullable<Int32>

Desplazamiento de base cero que indica el número de vídeos que se omitirán antes de devolver vídeos. 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 vídeos 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 Video Search API.

pricing

Nullable<VideoPricing>

Filtre vídeos por las siguientes opciones de precios: Gratis: Devuelve vídeos que son gratuitos para ver. Pago: devuelve vídeos que requieren una suscripción o un pago para ver. All: No filtre por precios. Especificar este valor es el mismo que no especificar el parámetro de precios. Entre los valores posibles se incluyen: "All", "Free", "Paid"

resolution

Nullable<VideoResolution>

Filtrar vídeos por las siguientes resoluciones: SD480p: Devuelve vídeos con una resolución de 480p o superior. HD720p: devuelve vídeos con una resolución de 720p o superior. HD1080p: devuelve vídeos con una resolución de 1080p o superior. All: No filtre por resolución. Especificar este valor es el mismo que no especificar el parámetro de resolución. Entre los valores posibles se incluyen: "All", "SD480p", "HD720p", "HD1080p".

safeSearch

Nullable<SafeSearch>

Filtrar vídeos para contenido para adultos. A continuación se muestran los valores de filtro posibles. Desactivado: si la solicitud se realiza a través de Video Search API, la respuesta incluye vídeos para adultos y las imágenes en miniatura de los vídeos están claras (no aproximadas). Si la solicitud se realiza a través de Web Search API, la respuesta incluye vídeos para adultos, pero las imágenes en miniatura de los vídeos se pixelan (aproximadamente). Moderado: si la solicitud se realiza a través de Video Search API, la respuesta no incluye vídeos con contenido para adultos. Si la solicitud se realiza a través de Web Search API, la respuesta puede incluir vídeos con contenido para adultos, pero las imágenes en miniatura de los vídeos se pixelan (aproximadamente). Strict: no devuelve vídeos 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 lo que se establezca en el parámetro de consulta safeSearch. Sitio de uso: 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"

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.

textDecorations

Nullable<Boolean>

Valor booleano que determina si las cadenas de presentación contienen marcadores de decoración, como caracteres resaltados de aciertos. Si es true, las cadenas pueden incluir marcadores. El valor predeterminado es false. Para especificar si se deben usar caracteres Unicode o etiquetas HTML como marcadores, consulte el parámetro de consulta textFormat . Para obtener información sobre el resaltado de aciertos, vea Resaltado de aciertos.

textFormat

Nullable<TextFormat>

Tipo de marcadores que se van a usar para las decoraciones de texto (vea el parámetro de consulta textDecorations). Los valores posibles son Raw: use caracteres Unicode para marcar el contenido que necesita formato especial. Los caracteres Unicode están en el intervalo E000 a E019. Por ejemplo, Bing usa E000 y E001 para marcar el principio y el final de los términos de consulta para el resaltado de aciertos. HTML: use etiquetas HTML para marcar el contenido que necesita formato especial. Por ejemplo, use <etiquetas b> para resaltar los términos de consulta en cadenas para mostrar. El valor predeterminado es Raw. En el caso de las cadenas de presentación que contienen caracteres HTML ineludibles, como <, >y &, si textFormat está establecido en HTML, Bing escapa de los caracteres según corresponda (por ejemplo, < se escapa a &lt;). Entre los valores posibles se incluyen: "Raw", "Html"

cancellationToken

CancellationToken

Token de cancelación.

Devoluciones

Task<Videos>