Справочник по API проверки орфографии версии 7

Предупреждение

API Поиска Bing будут перенесены из Cognitive Services в службы Поиска Bing. С 30 октября 2020 г. подготовку всех новых экземпляров Поиска Bing необходимо будет выполнять в соответствии с процедурой, описанной здесь. API-интерфейсы Поиска Bing, подготовленные с помощью Cognitive Services, будут поддерживаться в течение следующих трех лет или до завершения срока действия вашего Соглашения Enterprise (в зависимости от того, какой период окончится раньше). Инструкции по миграции см. в статье о службах Поиска Bing.

API проверки орфографии позволяет проверить текстовую строку на наличие орфографических и грамматических ошибок. В этом разделе содержатся технические сведения о параметрах запроса и заголовках, используемых для запроса проверки орфографии, а также объекты ответа JSON, содержащие результаты. Примеры, демонстрирующие выполнение запросов, см. в разделе "Проверка орфографии" текстовой строки.

Сведения о заголовках, которые должны включать запросы, см. в разделе "Заголовки запросов".

Сведения о параметрах запроса, которые должны включаться в запросы, см. в разделе "Параметры запроса".

Сведения об объектах JSON, которые может включать ответ, см. в разделе "Объекты ответа".

Сведения о допустимом использовании и отображении результатов см. в разделе Bing Требования к использованию и отображению API поиска.

Примечание

Так как формат и параметры URL-адресов могут измениться в любой момент без предварительного уведомления, используйте все URL-адреса как есть. Формат и параметры URL-адресов не следует учитывать, если это явно не обозначено.

Конечные точки

Чтобы проверить орфографию и грамматику блока текста, отправьте запрос GET или POST в:

https://api.cognitive.microsoft.com/bing/v7.0/SpellCheck

Для отправки запроса следует использовать протокол HTTPS.

Из-за ограничения длины строки запроса обычно используется запрос POST, если только вы не проверяете только короткие строки.

Для подписок с несколькими службами необходимо включить регион в URL-адрес. Например, westus.api.cognitive.microsoft.com. Просмотрите список поддерживаемых регионов.

Примечание

Максимальный размер URL-адреса составляет 2,048 символов. Чтобы длина вашего URL-адреса не превышала ограничение, максимальная длина ваших параметров запроса должна быть менее 1500 символов. Если длина URL-адреса превышает 2048 символов, сервер возвращает ошибку 404 (страница не найдена).

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

Ниже приведены заголовки, которые могут включать запрос и ответ.

Header Описание
Принять Дополнительный заголовок запроса.

Тип мультимедиа по умолчанию — это приложение или JSON. Чтобы указать, что в ответе используется JSON-LD, задайте для заголовка Accept приложение или JSON+LD в качестве значения.
Accept-Language Дополнительный заголовок запроса.

Список разделенных запятыми языков, используемых для строк пользовательского интерфейса. В этом списке языки указаны в порядке убывания по приоритету. Дополнительные сведения, включая ожидаемый формат, см. в этой статье.

Этот заголовок и параметр запроса setLang являются взаимоисключающими. Не указывайте оба.

Если задать этот заголовок, также необходимо указать параметр запроса cc. Чтобы определить рынок для возврата результатов, Bing использует первый поддерживаемый язык, который он находит в списке, и объединяет его со значением параметра cc. Если в список не включен поддерживаемый язык, Bing находит ближайший язык и рынок, который поддерживает запрос, или использует вычисление или рынок по умолчанию для результатов. Чтобы определить рынок, используемый Bing, см. заголовок BingAPIs-Market.

Используйте этот заголовок и параметр запроса cc, только если указывается несколько языков. В противном случае используйте параметры запроса mkt и setLang.

Строка пользовательского интерфейса — это строка, которая используется как метка в пользовательском интерфейсе. Есть несколько строк пользовательского интерфейса в объектах ответа JSON. Все ссылки на свойства Bing.com в объектах ответа применяют указанный язык.
BingAPIs-Market Заголовок ответа.

Рынок, используемый для запроса. Формат значения — <код_языка>-<код_страны>. Например, en-US.

Если указать рынок, который не указан в кодах рынка, это значение может отличаться от рынка, указанного в параметре запроса mkt . То же самое верно при указании значений для cc и Accept-Language , которые не могут быть согласованы.
BingAPIs-TraceId Заголовок ответа.

Идентификатор записи журнала, содержащей сведения о запросе. В случае ошибки запишите этот код. Если вы не можете определить и устранить проблему, укажите этот идентификатор вместе с другой информацией в запросе к группе поддержки.
Ocp-Apim-Subscription-Key Обязательный заголовок запроса.

Ключ подписки, полученный при регистрации для использования этой службы в Cognitive Services.
Pragma Дополнительный заголовок запроса.

По умолчанию Bing возвращает кэшированное содержимое, если оно доступно. Чтобы предотвратить кэширование содержимого, задайте для заголовка Pragma значение no-cache (например, Pragma: no-cache).
Повторная попытка Заголовок ответа.

Ответ включает этот заголовок, если превышено количество запросов, разрешенных в секунду (QPS) или в месяц (QPM). Заголовок содержит количество секунд, которое необходимо дождаться перед отправкой другого запроса.
User-Agent Дополнительный заголовок запроса.

Агент пользователя, отправивший запрос. Bing использует агент пользователя, чтобы обеспечить оптимизированное взаимодействие для мобильных пользователей. Приведенный ниже заголовок является необязательным, но его также рекомендуется указать.

Заголовок User-Agent должен содержать ту же строку, которую отправляет любой широко используемый браузер. Дополнительные сведения об агентах пользователя см. в этой статье.

Ниже приведены примеры использования строк user-agent.
  • Windows Phone — Mozilla/5.0 (совместим; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)

  • Android — Mozilla/5.0 (Linux; U; Android 2.3.5; en-us; Sch-I500 сборки/GINGERBREAD) AppleWebKit/533.1 (KHTML; как Gecko) версии/4.0 Mobile Safari/533.1

  • iPhone — Mozilla/5.0 (iPhone; ЦП 6_1 iPhone ОС, как Mac OS X) AppleWebKit/536.26 (KHTML; как Gecko) iPhone4 Mobile/10B142; 1 BingWeb/3.03.1428.20120423

  • Компьютер — Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; Touch; rv:11.0), как Gecko

  • iPad — Mozilla/5.0 (iPad; ОС ЦП 7_0, как Mac OS X) AppleWebKit/537.51.1 (KHTML, как Gecko) версия/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID Дополнительный заголовок запроса и ответа.

Bing использует этот заголовок для обеспечения согласованного поведения при выполнении разных вызовов Bing API. Bing часто проверяет новые функции и улучшения и использует идентификатор клиента в качестве ключа для назначения тестируемых возможностей. Если вы не используете один и тот же идентификатор клиента для нескольких запросов, Bing может назначить одному пользователю несколько конфликтующих функций. Назначение таких проверяемых возможностей может привести к несогласованному взаимодействию с пользователем. Например, если для второго запроса будет назначена другая проверяемая возможность, результат будет неожиданным для пользователя. Кроме того, Bing может использовать идентификатор клиента для адаптации веб-результатов к журналу поиска этого идентификатора клиента, обеспечивая более широкий интерфейс для пользователя.

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

ВАЖНО! Считайте этот заголовок обязательным, хоть это и не так. Сохранение идентификатора клиента по нескольким запросам для одной и той же комбинации пользователя и устройства позволяет 1) потребителю API получать согласованный пользовательский интерфейс и 2) больше переходов по ссылкам благодаря лучшему качеству результатов от Bing API.

Ниже приведены базовые правила использования, применяемые к этому заголовку.
  • Каждый пользователь, использующий приложение на устройстве, должен иметь уникальный идентификатор клиента Bing.

    Если этот заголовок не включается в запрос, Bing создает идентификатор и возвращает его в заголовке ответа X-MSEdge-ClientID. Этот заголовок не следует включать в запрос, только когда пользователь в первый раз использует приложение на этом устройстве.

  • ВНИМАНИЕ! Нужно убедиться, что этот идентификатор клиента никак не связан с информацией учетной записи пользователя, используемой для аутентификации.

  • Используйте идентификатор клиента при каждом запросе к API Bing от приложения для определенного пользователя на определенном устройстве.

  • Сохраните идентификатор клиента. Чтобы сохранить идентификатор в приложении браузера, нужен постоянный файл cookie HTTP, что гарантирует использование идентификатора во всех сеансах. Не используйте файл cookie сеанса. В других приложениях, таких как мобильные приложения, для хранения идентификатора можно использовать постоянное хранилище устройства.

    В следующий раз, когда пользователь будет использовать приложение на этом устройстве, извлеките сохраненный идентификатор клиента.

Примечание. Ответы Bing могут как включать, так и не включать этот заголовок. Если ответ включает этот заголовок, сохраните идентификатор клиента и используйте его для всех последующих запросов Bing для пользователя на этом устройстве.

Примечание. Если в запрос включен заголовок X-MSEdge-ClientID, этот запрос не должен содержать файлы cookie.
X-MSEdge-ClientIP Дополнительный заголовок запроса.

IPv4-адрес или IPv6-адрес клиентского устройства. IP-адрес используется для обнаружения расположения пользователя. Bing использует сведения о расположении для выбора безопасного поведения поиска.

ПРИМЕЧАНИЕ. Приведенный ниже заголовок является необязательным, однако всегда рекомендуется указывать его и заголовок X-Search-Location.

Не маскируйте адрес (например, изменив последний октет на 0). Маскировка адреса приводит к тому, что определяется расположение, отдаленное от фактического расположения устройства. В результате Bing может выводить ошибочные результаты.
X-Search-Location Дополнительный заголовок запроса.

Список пар "ключ — значение", разделенных точкой с запятой, которые описывают географическое расположение клиента. Bing использует сведения о расположении для определения поведения при безопасном поиске и возвращения релевантного локального содержимого. Укажите пару "ключ-значение" в формате <ключ>:<значение>. Ниже приведены ключи, которые можно использовать для определения расположения пользователя.

  • lat — обязательный параметр. Широта расположения клиента в градусах. Широта должна быть не меньше −90,0 и не больше +90,0. Отрицательные значения указывают южную широту, а положительные значения — северную.

  • long — обязательный параметр. Долгота расположения клиента в градусах. Долгота должна быть не меньше –180.0 и не больше +180.0. Отрицательные значения указывают на западную долготу, а положительные — на восточную.

  • re — обязательный параметр. Радиус в метрах, который определяет горизонтальную точность координат. Передайте значение, возвращенное службой расположения устройства. Типичные значения: 22 м для GPS или Wi-Fi, 380 м для триангуляции базовой станции и 18 000 м для обратного просмотра IP-адресов.

  • ts — необязательный параметр. Метка времени в формате UTC UNIX, когда клиент находился в этом расположении. (Метка времени UNIX — количество секунд, прошедших с 1 января 1970 года.)

  • head — необязательный параметр. Относительное направление движения клиента. Укажите направление движения в градусах от 0 до 360, отсчитывая по часовой стрелке относительно севера. Укажите этот ключ, только если ключ sp имеет ненулевое значение.

  • sp — необязательный параметр. Горизонтальная скорость в метрах в секунду, с которой клиентское устройство перемещается.

  • alt — необязательный параметр. Высота размещения клиентского устройства в метрах.

  • are — необязательный параметр. Радиус, в метрах, который определяет вертикальную точность координат. Укажите этот ключ, только если указан ключ alt.

  • disp — необязательно. Географическое расположение пользователя в форме, disp:<City, State>. Например, disp:Seattle, Washington. Это текстовая версия отображаемого расположения пользователя, указанного с помощью клавиш lat/long. Если это значение конфликтует с координатами lat/long, Bing использует значение disp в качестве расположения пользователя.

ПРИМЕЧАНИЕ. Bing игнорирует этот заголовок, если запрос содержит расположение. Например, если этот заголовок отражает расположение пользователя в Сан-Франциско, но запрос — это рестораны сиэтла, Bing возвращает рестораны, расположенные в Сиэтле, штат Вашингтон.

Примечание. Хотя многие из этих ключей не являются обязательными, чем больше информации вы предоставите, тем точнее будут результаты поиска.

Примечание. Хотя это необязательно, рекомендуется всегда указывать географическое расположение пользователя. Это особенно важно, если IP-адрес клиента не точно отражает физическое расположение пользователя (например, если клиент использует VPN). Для получения оптимальных результатов следует включить этот заголовок и заголовок X-Search-ClientIP, но как минимум следует включить этот заголовок.

Примечание

Помните, что условия использования требуют соблюдения всех применимых законов, в том числе в отношении использования этих заголовков. Например, в некоторых юрисдикциях, например европейской, есть требования на получение согласия пользователя перед размещением определенных устройств отслеживания на пользовательских устройствах.

Параметры запроса

Ниже приведены параметры, которые может содержать запрос. Столбец Обязательно содержит информацию о том, необходимо ли указывать значение параметра. Значения параметров запроса необходимо включить в URL-адрес.

Имя Значение Тип Обязательно
actionType Строка, используемая в журнале для определения того, поступает ли запрос из интерактивного сеанса или загрузки страницы. Допустимы следующие значения:
  • Изменение— запрос выполняется из интерактивного сеанса.
  • Загрузка— запрос выполняется из загрузки страницы
Строка нет
appName Уникальное имя приложения.

Имя должно быть известно Bing. Не включайте этот параметр, если вы ранее не связались с Bing, чтобы получить уникальное имя приложения. Чтобы получить уникальное имя, обратитесь к своему менеджеру по развитию бизнеса Bing.
Строка Нет
cc Двухзначный код страны, откуда получены результаты. Список возможных значений см. в разделе "Коды рынка".

Если задать этот параметр, также необходимо указать заголовок Accept-Language. Bing использует первый поддерживаемый язык, который он находит на указанных языках, и объединяет его с кодом страны, чтобы определить рынок для возврата результатов. Если в список не включен поддерживаемый язык, Bing находит ближайший язык и рынок, поддерживаемые для запроса. Кроме того, Bing может использовать агрегированный или стандартный рынок для результатов.

Используйте этот параметр запроса и Accept-Language заголовок только при указании нескольких языков. В противном случае следует использовать mkt параметры и setLang параметры запроса.

Этот параметр и параметр запроса mkt являются взаимоисключающими. Не указывайте оба.
Строка нет
clientMachineName Уникальное имя устройства, из которой выполняется запрос. Создайте уникальное значение для каждого устройства (значение не имеет значения).

Служба использует идентификатор для отладки проблем и улучшения качества исправлений.
Строка нет
Docid Уникальный идентификатор, идентифицирующий документ, к которому принадлежит текст. Создайте уникальное значение для каждого документа (значение не имеет значения).

Служба использует идентификатор для отладки проблем и улучшения качества исправлений.
Строка Нет
mkt Рынок, по которому возвращаются результаты. Как правило, это страна, mkt из которой пользователь выполняет запрос. Однако это может быть другая страна, если пользователь не находится в стране, где Bing предоставляет результаты. Рынок должен находиться в коде><> страны языка формы.< Например, en-US. Строка не учитывает регистр. Список возможных рыночных значений см. в разделе "Коды рынка".

ПРИМЕЧАНИЕ: Если известно, рекомендуется всегда указывать рынок. Таким образом Bing может направить запрос и вернуть соответствующий и оптимальный ответ. Если указать рынок, который не указан в рыночных кодах, Bing использует код рынка в соответствии с внутренним сопоставлением, которое может быть изменено.

Этот параметр и параметр запроса cc являются взаимоисключающими. Не указывайте оба.
Строка нет
Режим Тип проверки орфографии и грамматики для выполнения. Ниже приведены возможные значения (значения не учитывают регистр). Значение по умолчанию — Proof.
  • Подтверждение — для сценария с документами—
    • Режим проверки орфографии Proof предусматривает наиболее комплексные проверки (проверка капитализации, основной пунктуации) и другие возможности, которые помогают в создании документа. но он доступен только на рынках en-US (английский-США), es-ES(испанский), pt-BR(португальский) (примечание: только бета-версия для испанского и португальского языков). Для других языковых стандартов (рынков) установите для параметра запроса mode значение Spell.

      ПРИМЕЧАНИЕ: Если длина текста запроса превышает 4096, она будет усечена до 4096 символов, а затем будет обработана.


  • Орфография — для сценария поиска в Интернете и запросов—
    • "Заклинание" является более агрессивным, чтобы вернуть лучшие результаты поиска. Режим орфографии находит большинство орфографических ошибок, но не находит некоторые из грамматических ошибок, которые перехватывает правописание, например прописные буквы и повторяющиеся слова.

      Примечание. Поддерживаемая максимальная длина запроса описана ниже. Если запрос превышает границы, в результате указывается, что запрос не изменен.
      • 65 символов для языкового кода en, de, es, fr, pl, pt, sv, ru, nl, nb, tr-tr, it, zh, ko.
      • 65 символов для других кодов языков.
Строка нет
preContextText Строка, которая предоставляет контекст текстовой строке. Например, textстроковый лепесток допустим. Однако если задано значение preContextText bike, контекст изменяется и текстовая строка становится недопустимой. В этом случае API предлагает изменить лепесток на педаль (как в педали велосипеда).

Этот текст не проверяется на наличие орфографических или орфографических ошибок.

Объединенная длина text строки, preContextText строки и postContextText строки не может превышать 10 000 символов.

Этот параметр можно указать в строке запроса GET или в тексте запроса POST.
Строка нет
postContextText Строка, которая предоставляет контекст текстовой строке. Например, textчтение строки является допустимым. Однако если задано postContextTextзначение "Ковер", контекст изменяется и текстовая строка становится недопустимой. В этом случае API предлагает изменить чтение на красный (как в красной ковровой дорожке).

Этот текст не проверяется на наличие орфографических или орфографических ошибок.

Объединенная длина text строки, preContextText строки и postContextText строки не может превышать 10 000 символов.

Этот параметр можно указать в строке запроса GET или в тексте запроса POST.
Строка нет
Sessionid Уникальный идентификатор, идентифицирующий этот сеанс пользователя. Создайте уникальное значение для каждого сеанса пользователя (значение не имеет значения).

Служба использует идентификатор для отладки проблем и улучшения качества исправлений.
Строка Нет
setLang Язык, используемый для строк пользовательского интерфейса. Вы можете указать язык, используя 2-буквенный или 4-буквенный код. Рекомендуется использовать 4-буквенный код.

Список поддерживаемых кодов языков см. в Bing поддерживаемых языках и рынках.

Bing загружает локализованные строки, если setlang содержит допустимый 2-буквенный нейтральный код языка и региональных параметров (fr) или допустимый код языка и региональных параметров (fr-ca). Например, для fr-ca Bing загружает строки кода кода fr neutral и региональных параметров.

Если setlang недопустимый (например, zh) или Bing не поддерживает язык (например, af, af, af-na), Bing по умолчанию используется en (английский).

Чтобы указать 2-буквенный код, задайте для этого параметра код языка ISO 639-1.

Чтобы указать 4-буквенный код, используйте язык-страну<> или регион> формы<, где <языком> является код языка ISO 639-1 (нейтральный язык и региональные параметры) и <страной или регионом является код ISO 3166 страна или регион> (конкретный язык и региональные параметры). Например, используйте en-US для США английского языка.

Хотя это необязательно, всегда следует указывать язык. Обычно для setLang задается язык, указанный в параметре mkt, если только пользователь не хочет, чтобы строки пользовательского интерфейса отображались на другом языке.

Этот параметр и заголовок Accept-Language являются взаимоисключающими. Не указывайте оба.

Строка пользовательского интерфейса — это строка, которая используется как метка в пользовательском интерфейсе. Есть несколько строк пользовательского интерфейса в объектах ответа JSON. Кроме того, все ссылки на свойства Bing.com в объектах ответа применяют указанный язык.
Строка нет
текст Текстовая строка для проверки орфографии и грамматики.

Объединенная длина text строки, preContextText строки и postContextText строки не может превышать 10 000 символов.

Этот параметр можно указать в строке запроса GET или в тексте запроса POST. Из-за ограничения длины строки запроса обычно используется запрос POST, если только вы не проверяете только короткие строки.
Строка Да
Userid Уникальный идентификатор, определяющий пользователя. Создайте уникальное значение для каждого пользователя (значение не имеет значения).

Служба использует идентификатор для отладки проблем и улучшения качества исправлений.
Строка Нет

Объекты ответа

Ниже приведены объекты ответа JSON, которые ответ может включать. Если запрос выполнен успешно, объект верхнего уровня в ответе является объектом SpellCheck . Если запрос завершается сбоем, объект верхнего уровня — ErrorResponse.

Объект Описание
Ошибка Возникшая ошибка.
ErrorResponse Объект верхнего уровня, который включается ответ при сбое обработки запроса.
FlaggedToken Слово, которое может быть грамматично неправильным или неправильным.
Проверка орфографии Объект верхнего уровня, который ответ включает в себя при успешном выполнении запроса.
TokenSuggestion Предлагаемое исправление орфографии или грамматики.

Ошибка

Определяет возникшую ошибку.

Элемент Описание Тип
code Код ошибки, определяющий ее категорию. Список возможных кодов см. в разделе Коды ошибок. Строка
message Текстовое описание ошибки. Строка
moreDetails Подробное описание, которое предоставляет дополнительную информацию об ошибке. Строка
parameter Параметр запроса, который вызвал эту ошибку. Строка
subCode Код ошибки, по которому определяется ошибка. Например, если code имеет значение InvalidRequest, то subCode может иметь значение ParameterInvalid или ParameterInvalidValue. Строка
value Недопустимое значение параметра запроса. Строка

ErrorResponse

Объект верхнего уровня, который включается ответ при сбое обработки запроса.

Имя Значение Тип
_type Указание типа. Строка
errors Список ошибок, описывающих причины сбоя запроса. Error[]

FlaggedToken

Слово, неправильно написанное или грамматически неправильное.

Имя Значение Тип
offset Отсчитываемое от нуля смещение от начала строки текстового запроса к слову, которое было отмечено. Целое число
Предложения Список слов, исправляющих ошибку орфографии или грамматики. В этом списке языки указаны в порядке убывания по приоритету. TokenSuggestion[]
token Слово в строке text запроса, неправильно написанное или грамматически неправильное. Строка
Тип Тип ошибки, вызвавшей пометку слова. Допустимы следующие значения:
  • RepeatedToken — слово повторялось в последовательности (например, теплой теплой погоды)

  • UnknownToken — все другие ошибки орфографии или грамматики
Строка

Проверка орфографии

Объект верхнего уровня, который ответ включает в себя при успешном выполнении запроса.

Если служба подозревает атаку типа "отказ в обслуживании", запрос завершается успешно (код состояния HTTP равен 200 ОК), но текст ответа пуст.

Имя Значение Тип
_type Указание типа, для которого задано значение SpellCheck. Строка
flaggedTokens Список слов в тексте , помеченных как неправильно написанные или грамматически неправильные.

Если ошибки орфографии или грамматики не найдены или указанный рынок не поддерживается, массив пуст.
FlaggedToken[]

TokenSuggestion

Предлагаемое исправление орфографии или грамматики.

Имя Значение Тип
Оценка по Значение, указывающее уровень достоверности, что предлагаемое исправление является правильным. modeЕсли для параметра запроса задано значение Spell, это поле имеет значение 1.0. Double
Предложение Предлагаемое слово для замены помеченного слова.

Если помеченное слово является повторяющееся словом (см. тип), эта строка пуста.
Строка

Коды ошибок

Ниже приведены возможные коды состояния HTTP, которые возвращает запрос.

Код состояния Описание
200 Успешно.
400 Один из параметров запроса отсутствует или является недопустимым.
401 Ключ подписки отсутствует или является недопустимым.
403 Пользователь прошел проверку подлинности (например, с допустимым ключом подписки), но не имеет разрешений для обращения к запрошенному ресурсу.

Bing также может вернуть это состояние, если для вызывающего объекта превышены месячные квоты.
410 В запросе использовался протокол HTTP вместо HTTPS. HTTPS является единственным поддерживаемым протоколом.
429 Вызывающий превысил свою квоту на число запросов в секунду.
500 Непредвиденная ошибка сервера.

Если запрос завершается с ошибкой, ответ будет содержать объект ErrorResponse, который содержит список объектов Error, описывающих причину ошибки. Если ошибка связана с параметром, поле parameter идентифицирует параметр, который является причиной проблемы. Если ошибка связана со значением параметра, поле value идентифицирует недопустимое значение.

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidRequest", 
      "subCode": "ParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidAuthorization", 
      "subCode": "AuthorizationMissing", 
      "message": "Authorization is required.", 
      "moreDetails": "Subscription key is not recognized."
    }
  ]
}

Ниже приведены возможные коды ошибок и кодовые значения вложенных ошибок.

Код SubCode (дополнительный код) Описание
ServerError UnexpectedError
ResourceError
NotImplemented
Код состояния HTTP — 500.
InvalidRequest ParameterMissing
ParameterInvalidValue
HttpNotAllowed
Блокировано
Bing возвращает ошибку InvalidRequest (недопустимый запрос) всякий раз, когда любая часть запроса недопустима. Например, отсутствует обязательный параметр или значение параметра недопустимо.

В случае ошибки ParameterMissing или ParameterInvalidValue возвращается код состояния HTTP 400.

Если вместо HTTPS используется протокол HTTP, Bing возвращает HttpNotAllowed и код состояния HTTP 410.
RateLimitExceeded Дополнительные коды не используются Bing возвращает ошибку RateLimitExceeded всякий раз при превышении квоты запросов в секунду (QPS) или запросов в месяц (QPM).

При превышении QPS Bing возвращает код состояния HTTP 429, а если превысить QPM, Bing вернет код 403.
InvalidAuthorization AuthorizationMissing
AuthorizationRedundancy
Bing возвращает InvalidAuthorization, когда Bing не может проверить подлинность вызывающего объекта. Например, когда заголовок Ocp-Apim-Subscription-Key отсутствует или при недопустимом ключе подписки.

Избыточность возникает, если указать более одного способа проверки подлинности.

При ошибке InvalidAuthorization кодом состояния HTTP будет 401.
InsufficientAuthorization AuthorizationDisabled
AuthorizationExpired
Bing возвращает InsufficientAuthorization, когда вызывающая сторона не имеет разрешений на доступ к ресурсу. Это может произойти, если ключ подписки отключен или срок его действия истек.

При ошибке InsufficientAuthorization возвращается код состояния HTTP 403.

Коды рынка

В следующей таблице перечислены значения кода рынка, которые можно использовать для указания mkt параметра запроса. Bing возвращает содержимое только для этих рынков. Со временем этот список может измениться.

Список кодов стран, которые можно указать в параметре cc запроса, см. в разделе "Коды страны".

Страна или регион Язык Код рынка
Аргентина Испанский es-AR
Австралия Английский en-AU
Австрия Немецкий de-AT
Бельгия Нидерландский nl-BE
Бельгия Французский fr-BE
Бразилия Португальский pt-BR
Канада Английский en-CA
Канада Французский fr-CA
Чили Испанский es-CL
Дания Датский da-DK
Финляндия Финский fi-FI
Франция Французский fr-FR
Германия Немецкий de-DE
Гонконг (САР) Китайский (традиционный) zh-HK
Индия Английский en-IN
Индонезия Английский en-ID
Италия Итальянский it-IT
Япония Японский ja-JP
Корея Корейский ko-KR
Малайзия Английский en-MY
Мексика Испанский es-MX
Нидерланды Нидерландский nl-NL
Новая Зеландия Английский en-NZ
Норвегия Норвежский no-NO
Китайская Народная Республика Китайский zh-CN
Польша Польский pl-PL
Республика Филиппины Английский en-PH
Россия русском языке ru-RU
Южно-Африканская Республика Английский en-ZA
Испания Испанский es-ES
Швеция Шведский sv-SE
Швейцария Французский fr-CH
Швейцария Немецкий de-CH
Тайвань Китайский (традиционный) zh-TW
Турция Турецкий tr-TR
Соединенное Королевство Английский en-GB
США Английский en-US
США Испанский es-US

Коды стран

Ниже приведены коды стран, которые можно указать в параметре запроса cc. Со временем этот список может измениться.

Страна или регион код страны;
Аргентина AR
Австралия AU
Австрия AT
Бельгия BE
Бразилия BR
Canada CA
Чили CL
Дания DK
Финляндия FI
Франция СВ
Германия DE
Гонконг, САР HK
Индия IN
Индонезия ID
Италия IT
Япония JP
Корея KR
Малайзия MY
Мексика MX
Нидерланды NL
Новая Зеландия NZ
Норвегия NO
Китайская Народная Республика CN
Польша PL
Португалия PT
Республика Филиппины PH
Россия RU
Саудовская Аравия SA
ЮАР ZA
Испания ES
Швеция SE
Швейцария CH
Тайвань TW
Турция TR
United Kingdom ГБ
США США

Bing поддерживаемых языков и рынков

В следующей таблице перечислены Bing поддерживаемые языки, которые можно указать в параметре setLang запроса, коды стран, которые можно указать в параметре cc запроса, и значения кода рынка, которые можно использовать для указания mkt параметра запроса. Демонстрационное текстовое и демонстрационное исправление можно использовать для проверки правильности работы API.

Поддерживаемый язык Страна или регион Код рынка Демонстрационный текст Демонстрация за исключением исправления
Арабский ОАЭ ar-AE مرحبا , يوم عسيد لك مرحبا , يوم سعيد لك
ulgarian Болгария bg-BG Българсик език Български език
Каталонский Испания ca-ES Клауди риера claudia riera
Чешский Чешский cs-CZ Češtian Čeština
Датский Дания da-DK Welokm Велком
Немецкий Германия de-DE zdf fussballspiel zdf fußballspiel
Английский Австралия en-AU идеальное всплывающее окно идеальное зелье
Английский Канада en-CA декафенция декаффинация
Английский Соединенное Королевство en-GB топогапичное значение значение топологии
Английский Индия en-IN dainik jagaran dainik jagran
Английский США en-US битва айсиаго битва за азиго
Испанский Испания es-ES cordillera de lows cárpatos cordillera de los cárpatos
Испанский Мексика es-MX carsel de cananea cárcel de cananea
Испанский США es-US carsel de cananea cárcel de cananea
Финский Финляндия fi-FI hälyt yskeskuks hälytyskeskus
Французский Канада fr-CA les meilleuresadditif les meilleures additif
Французский Франция fr-FR letre en fromage lettre en fromage
Иврит Израиль he-IL ברךו הבא ברוך הבא
Хорватский Хорватия hr-HR suze svetog lovra suze svetog lovre
Итальянский Италия it-IT orologio svarowsky orologio swarovski
Японский Япония ja-JP ありがととう ありがとう
Корейский Корея ko-KR 미안니합다 미안합니다
Латышский Латвия lv-LV ложь izmeri.lv lielieizmeri.lv
Малайский Малайзия ms-MY Месир Бахеса месир бахаса
Норвежский (Букмол) Норвегия nb-NO næpe suppe nepesuppe
Нидерландский Бельгия nl-BE electriteid electriteit
Нидерландский Нидерланды nl-NL electriteid electriteit
Польский Польша pl-PL naduzywaniie alkoholu naduzywanie alkoholu
Португальский Бразилия pt-BR curso de serralheiro prensisal curso de serralheiro presencial
Португальский (Португалия) Португальский pt-PT suzy quatro suzi quatro
Румынский Румыния ro-RO T3xt despre dulciuri text despre dulciuri
Русский Россия ru-RU Превет. Как дела? Какии планны на выхадные? привет. как дела? какие планы на выходные?
Словацкий Словацкий sk-SK slúchadlá mediatech mt3589 slúchadlá media tech mt3589
Словенский Сьерра-Леоне sl-SI ogresnovads ogres novads
Шведский Швеция sv-SE förjuden frukt förbjuden frukt
Тайский Таиланд th-TH สวัสดีะค สวัสดีค
Турецкий Турция tr-TR atatürk foto lari atatürk fotoları
Украинский Украина uk-UA юьуб ютуб
Вьетнамский Вьетнам vi-VN Hoan nhgênh hoan nghênh
Китайский (упрощенное письмо) Китайская Народная Республика zh-CN 南京长江大乔 南京长江大桥
Китайский (традиционное письмо) Гонконг (САР) zh-HK 維利多亞港 維多利亞港