Referencia de la API rest de News Search

Punto final:POST https://api.microsoft.ai/v3/search/news

Solicitud de ejemplo:

curl -X POST "https://api.microsoft.ai/v3/search/news" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "latest VC funding in tech",
    "maxResults": 10,
    "language": "en",
    "region": "US",
    "maxLength": 3000,
    "contentFormat": "passage"
  }'

Parameters

Parámetro Required Tipo Default Description
consulta Sí string - Una consulta de búsqueda de los resultados de las noticias. La longitud máxima es de 1000 caracteres.
maxResults No integer 10 Número máximo de resultados que se van a devolver. El valor predeterminado es 10. El valor máximo es 20.
idioma No string "en" Código de idioma ISO 639-1 de 2 letras para el idioma de la interfaz en los resultados de la búsqueda. Consulte Idiomas admitidos para obtener la lista completa.
region No string "US" Código de país o región de 2 letras para el que deben proceder los resultados (por ejemplo, "US", "JP", "GB", etc.). Consulte Regiones admitidas para obtener la lista completa.
location No string - Información de ubicación con el formato "lat:<float>; long:<float>", por ejemplo, "lat:40.753250; long:-74.003807".
contentFormat No string "passage" ("text" con acceso completo al documento) passage devuelve las partes de cada resultado más relevantes para la consulta (recomendado para la puesta a tierra). texty htmlmarkdown devuelven el documento completo y solo se aplican a las aplicaciones con acceso completo a documentos; vea Pasajes y formatos de contenido. Establézcalo en cada solicitud.
longitud máxima No integer 3000 (10000 con acceso completo a documentos) Número máximo de caracteres por content resultado, de 1 a 500000. Sin acceso completo a documentos, content tiene como máximo 3000 caracteres. Consulte Valores predeterminados y límites. Establézcalo en cada solicitud.

Formatos de contenido

Establézcalo contentFormatpassage = para obtener las partes de cada resultado más relevantes para la consulta, hasta maxLength caracteres (3000 es un buen punto de partida). Es el formato recomendado para la puesta a tierra; consulte ¿Qué es passagey por qué usarlo? en las preguntas más frecuentes. Las aplicaciones con acceso completo a documentos también pueden solicitar el documento completo como text, html o markdown; para otras aplicaciones, esos formatos devuelven HTTP 403. Consulte Pasajes y formatos de contenido.

Encabezados de solicitud

Field Tipo Description
host string Host para las API de IA de Microsoft: api.microsoft.ai.
x-apikey o Authorization string La clave de API o Entra ID token de acceso para la autenticación.
content-type (tipo de contenido) string Tipo MIME del cuerpo de la solicitud. Utilice application/json.

Respuesta

Respuesta de noticias

Field Tipo Description
newsResults matriz de newsResult Lista de resultados de artículos de noticias.
instrumentationClickBase string Dirección URL base para hacer clic en solicitudes de ping. Anexe un instrumentationSuffix valor de un elemento de resultado para formar la dirección URL de ping completa. Solo está presente para las aplicaciones con la marca de perfil EnableInstrumentationPing. Nota: Los clics de usuario también se pueden registrar mediante el redireccionamiento de direcciones URL. Cuando la redirección está habilitada, no se requiere ninguna acción para registrar los clics del usuario y instrumentationClickBase no se incluirá en la respuesta. Consulte la guía de instrumentación para obtener instrucciones de configuración.
instrumentationCitationBase string Dirección URL base para las solicitudes de ping de registro de LLM. Anexe una carga DE DATOS para formar la dirección URL de ping completa. Solo está presente para las aplicaciones con la marca de perfil EnableInstrumentationPing.
traceId string Identificador de seguimiento para la depuración.

newsResult

Field Tipo Description
title string Título de las noticias.
url string Dirección URL de origen del artículo de noticias. Para los usuarios de China con redirección de direcciones URL habilitadas, este campo contiene la misma dirección URL de redireccionamiento que clickUrl.
domain string Host de destino para el resultado. Solo se devuelve para los usuarios de China con el redireccionamiento de direcciones URL habilitado.
contenido string El contenido detallado de la página web (también conocido como tierra) del resultado de las noticias.
vista en miniatura thumbnail (objeto) Miniatura del artículo de noticias.
lastUpdatedAt string La última fecha actualizada de las noticias, en formato UTC ISO8601.
crawledAt string La última fecha rastreada de las noticias sigue ISO8601 formato.
idioma string El idioma del artículo de noticias usa el código de idioma ISO 639-1.
source string Publisher nombre, como "USA TODAY | MSN", "CNN", etc.
isAdult booleano Indica si el contenido es adulto.
clickUrl string Url de redirección que proxie el clic a través de Bing. Solo está presente cuando el redireccionamiento de clics está habilitado.
instrumentationSuffix string Sufijo que se va a anexar a la base de dirección URL de ping de instrumentación para este elemento de resultado. Se usa como valor K para la dirección URL de ping de instrumentación y el clickUrl redireccionamiento. Presente cuando el ping de instrumentación está habilitado.

Note

lastUpdatedAt field es opcional: es decir, es posible que vea un valor vacío para este campo.

vista en miniatura

Field Tipo Description
url string La URL de la miniatura.
width integer Ancho de la miniatura, en píxeles.
height integer Alto de la miniatura, en píxeles.

Note

thumbnail es también un objeto de respuesta opcional: es posible que no esté disponible para determinados resultados de noticias.

Códigos de error

Código de estado Categoría de error Description Causas comunes
200 Success La solicitud tuvo éxito. -
400 Solicitud incorrecta Parámetros de solicitud no válidos. Faltan campos obligatorios, valores de parámetro no válidos, JSON con formato incorrecto
401 Unauthorized Error de autenticación o falta. Clave de API no válida, falta el encabezado x-apikey
403 Prohibida Credenciales válidas pero permisos insuficientes. La clave de API carece de permisos necesarios
410 Pasado (Gone) SE requiere HTTPS. Solicitud realizada a través de HTTP en lugar de HTTPS
415 Tipo de medio no admitido No se admite el tipo de contenido. Falta o falta un encabezado de tipo de contenido incorrecto
429 Demasiadas solicitudes Se superó el límite de velocidad. Demasiadas solicitudes en el período de tiempo
500 Error interno del servidor Error inesperado del servidor. Problema de servidor temporal
503 Servicio no disponible El servicio no está disponible temporalmente. Interrupción temporal o mantenimiento
504 Tiempo de espera de puerta de enlace Se ha agotado el tiempo de espera para la solicitud. Tiempo de espera del servicio ascendente

Para obtener instrucciones detalladas sobre el control de errores, consulte Control de errores.

Consulte también:Web Search | Videos Search | | | MCP

  • Se actualizó por última vez el