Справочник по AUTO REST API (бета-версия)

Note

Авто доступно в бета-версии для внешних партнеров, профиль приложения которых включен для автоматического использования. Область API и контракт могут измениться.

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

Для всех запросов требуется ключ API или маркер доступа Microsoft Entra ID. Инструкции по настройке см. в разделе "Проверка подлинности ".

Образец запроса

curl -X POST "https://api.microsoft.ai/v3/auto" \
  -H "x-apikey: <Your API key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "Microsoft AI announcements",
    "language": "en",
    "region": "US",
    "location": "lat:47.6062;long:-122.3321",
    "mode": "fast",
    "maxResponseLength": 30000,
    "responseFilter": ["web", "news"]
  }'

Parameters

Parameter Required Type Default Description
query Yes string - Поисковый запрос от 1 до 1000 символов. Поддерживает site: и -site: операторы.
language No string en Двухбуквенный язык интерфейса ISO 639-1.
region No string US Двухбуквенный рынок или код страны или региона.
mode No string fast fast приоритеты скорости; advanced приоритеты комплексности.
maxResponseLength No integer 30000 Максимальная общая длина ответа. Значения ниже 1500 зажаты до 1500; Значения выше 500000 зажаты до 500000.
location No string - Географический контекст в lat:<latitude>;long:<longitude> формате, например lat:47.6062;long:-122.3321.
responseFilter No массив строк - Допустимые типы ответов: , , timezone, , imagesvideos. weathernewsweb

Response

Успешный ответ на доказательства возвращается 200 OK. Каждый результат содержит один типизированный объект доказательства и ссылки, поддерживающие его. Неподдерживаемые или неправильные доказательства опущены вместе со своими цитатами. Если каждый предоставленный результат доказательства опущен, results пуст.

AutoEvidenceResponse

Field Type Description
results массив AutoEvidenceResult Элементы доказательств, связанные с ссылкой, объединяемой с этим результатом.
traceId string Идентификатор корреляции для отладки и поддержки.

AutoEvidenceResult

Field Type Description
evidence AutoEvidence Сформированные типизированные доказательства.
citations Массив autoEvidenceCitation Ссылки, поддерживающие только этот результат доказательства.

AutoEvidence

Собственный type дискриминатор объекта доказательства выбирает схему content.

type content
text Строковые доказательства, возвращаемые для результатов Web и News.
media/image Объект результата изображения.
media/video Объект результата видео.
structured/weather Объект Погоды.
structured/timeZone Объект часового пояса.

Текстовые thumbnail доказательства новостей также могут включать в себя , urlwidthи height. Структурированное содержимое следует тем же правилам видимости открытого поля, что и соответствующий ответ поиска.

AutoEvidenceCitation

Field Type Description
contentSource string Источник ссылок.
title string Заголовок ссылки.
url string URL-адрес ссылки.
lastUpdatedAt string Последняя обновленная метка времени.
crawledAt string Метка времени обхода контента.
language string Язык содержимого.
isAdult boolean Содержит ли ссылка содержимое для взрослых.

Пример ответа

{
  "results": [
    {
      "evidence": {
        "type": "text",
        "content": "Microsoft announced a new set of AI capabilities."
      },
      "citations": [
        {
          "contentSource": "web",
          "url": "https://www.microsoft.com/en-us/ai",
          "title": "Microsoft AI",
          "language": "en",
          "isAdult": false
        }
      ]
    }
  ],
  "traceId": "00000000000000000000000000000000"
}

Коды ошибок

Код состояния Description
200 Запрос выполнен успешно, включая допустимый поиск без результатов.
400 Недопустимые параметры или неправильно сформированные JSON.
401 Отсутствующие или недопустимые учетные данные проверки подлинности.
403 Профиль, прошедший проверку подлинности, не включен для автоматического доступа.
429 Превышено ограничение скорости или квоты.
500 Внутренний сбой службы.
503 Требуемая служба недоступна.
504 Запрос превысил время ожидания.

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

Связанные материалы

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