Справочник по REST API поиска новостей

Конечная точка:POST https://api.microsoft.ai/v3/search/news

Пример запроса:

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

Parameter Required Type Default Description
query Yes string - Запрос поиска результатов новостей. Максимальная длина — 1000 символов.
максимальноеКоличествоРезультатов No integer 10 Максимальное количество возвращаемых результатов. Значение по умолчанию — 10. Максимальное значение равно 20.
language No string "en" 2-буквенный код ЯЗЫКА ISO 639-1 для языка интерфейса в результатах поиска. Полный список см. на поддерживаемых языках .
region No string "US" 2-буквенный код страны или региона, из которого должны поступать результаты (например, "US", "JP", "GB", и т. д.). Полный список см. в поддерживаемых регионах .
location No string - Сведения о расположении в формате "lat:<float>; long:float>, например "lat:<40.753250; long:-74.003807".
contentFormat No string "проход" ("text" с полным доступом к документу) passage возвращает части каждого результата, наиболее релевантного к запросу (рекомендуется для приземления). textи html возвращает полный документ и markdown применяется только к приложениям с полным доступом к документам; см. раздел "Проходы и форматы содержимого". Задайте его для каждого запроса.
максимальная длина No integer 3000 (10000 с полным доступом к документам) Максимальное число символов в content результатах — от 1 до 500000. Без полного доступа к документам не content более 3000 символов. См. значения по умолчанию и ограничения. Задайте его для каждого запроса.

Форматы содержимого

Задайте contentFormat = passage для получения частей каждого результата, наиболее релевантного к запросу, до maxLength символов (3000 — это хорошая отправная точка). Рекомендуемый формат для приземления; См . раздел "Что такое passage" и почему он используется? В разделе часто задаваемых вопросов. Приложения с полным доступом к документам также могут запрашивать полный документ как texthtml или markdownдля других приложений, эти форматы возвращают HTTP 403. См. фрагменты и форматы содержимого.

Заголовки запроса

Field Type Description
host string Узел для API Microsoft ИИ: api.microsoft.ai
x-apikey или authorization string Ключ API или маркер доступа Entra ID для проверки подлинности.
тип контента string Тип MIME текста запроса. Используйте application/json.

Response

Ответ новостей

Field Type Description
newsResults массив новостейResult Список результатов статьи новостей.
инструментированиеClickBase string Базовый URL-адрес для запросов на связь. instrumentationSuffix Добавьте значение из элемента результата, чтобы сформировать полный URL-адрес связи. Только для приложений с флагом профиля EnableInstrumentationPing. Примечание. Щелчки пользователей также могут быть зарегистрированы с помощью перенаправления URL-адресов. Если перенаправление включено, действие не требуется для регистрации щелчков пользователей и instrumentationClickBase не будет включено в ответ. Инструкции по настройке см. в руководстве по инструментированию .
инструментированиеCitationBase string Базовый URL-адрес для запросов ping журнала LLM. Добавьте полезные данные DATA, чтобы сформировать полный URL-адрес ping. Только для приложений с флагом профиля EnableInstrumentationPing.
traceId string Идентификатор трассировки для отладки.

newsResult

Field Type Description
title string Название новости.
url string Исходный URL-адрес новостной статьи. Для пользователей Китая с включенным перенаправлением URL-адресов это поле содержит тот же URL-адрес перенаправления, что clickUrlи .
domain string Узел назначения для результата. Возвращается только для пользователей Китая с включенным перенаправлением URL-адресов.
содержимое string Подробное содержимое веб-страницы (ака заземление) результата новостей.
эскиз Объект эскиза Эскиз новостной статьи.
lastUpdatedAt string Последняя обновленная дата новостей в формате UTC ISO8601.
обход контента string Последняя дата обхода новостей следует ISO8601 формате.
language string Язык новостной статьи использует код языка ISO 639-1.
source string Publisher имя, например "USA TODAY | MSN", "CNN" и т. д.
isAdult boolean Указывает, является ли содержимое взрослым.
clickUrl string URL-адрес перенаправления, который прокси-сервер щелкает Bing. Присутствует только при включении перенаправления щелчка.
инструментированиеSuffix string Суффикс для добавления к базе URL-адреса проверки связи инструментирования для этого элемента результата. Используется как значение K для URL-адреса проверки ping инструментирования, так и перенаправления clickUrl . Присутствует при включении проверки пинга инструментирования.

Note

lastUpdatedAt поле является необязательным— то есть может отображаться пустое значение для этого поля.

эскиз

Field Type Description
url string URL миниатюры.
width integer Ширина эскиза в пикселях.
height integer Высота эскиза в пикселях.

Note

thumbnail также является необязательным объектом ответа. Он может быть недоступен для определенных результатов новостей.

Коды ошибок

Код состояния Категория ошибки Description Распространенные причины
200 Success Запрос был выполнен успешно. -
400 ошибка запроса Недопустимые параметры запроса. Отсутствующие обязательные поля, недопустимые значения параметров, некорректный JSON
401 Unauthorized Сбой проверки подлинности или отсутствие. Недопустимый ключ API, отсутствующий заголовок x-apikey
403 Forbidden Допустимые учетные данные, но недостаточно разрешений. Ключ API не имеет необходимых разрешений
410 Отсутствует (Gone) Требуется ПРОТОКОЛ HTTPS. Запрос, сделанный по протоколу HTTP вместо HTTPS
415 Неподдерживаемый тип носителя Тип контента не поддерживается. Отсутствует или неправильный заголовок типа контента
429 Слишком много запросов Превышено ограничение скорости. Слишком много запросов в период времени
500 Внутренняя ошибка сервера Непредвиденная ошибка сервера. Проблема с временным сервером
503 Служба недоступна Служба временно недоступна. Обслуживание или временный сбой
504 Тайм-аут шлюза Истекло время ожидания для запроса. Время ожидания вышестоящей службы

Подробные инструкции по обработке ошибок см. в разделе "Обработка ошибок".

См. также:Поисквидео | в Интернете | обзор | поискаизображений | MCP

  • Последнее обновление: