Поля результатов распознавания

Источник: AudD•

Поля результатов распознавания

Поля объекта результата, возвращаемого стандартной точкой входа распознавания AudD (api.audd.io), включая таймкод, song_link, audio_id и блоки метаданных провайдеров.

Если есть совпадение, стандартная точка входа (POST https://api.audd.io/) возвращает результат с наилучшим совпадением для отправленного фрагмента: единую структуру с полями artist, title, album, release_date, label, timecode и song_link для песен из публичной базы данных (см. ниже информацию о совпадениях в пользовательском каталоге). Кроме того, она содержит данные, запрошенные в параметре return, в полях, названных в честь идентификаторов (см. Блоки метаданных провайдеров ниже). Если совпадений нет, result равен null. На этой странице описываются поля result. Корпоративная точка входа возвращает другую структуру; ее описание см. в справочнике по полям корпоративного ответа и совпадений.

Объект результата

Если есть совпадение, result представляет собой объект со следующими полями. Обратите внимание, что result: null вместе с status: "success" не является ошибкой. Это означает, что запрос прошел успешно и мы не нашли никаких совпадений. Поэтому проверяйте значение на null перед чтением полей.

Вот минимальное совпадение, которое можно использовать в качестве справочника:

timecode

timecode — это время в распознанной песне, когда звучит отправленный вами фрагмент, а не время в самом фрагменте. Таким образом, 00:56 означает, что отправленный вами фрагмент совпал с частью песни, которая начинается через 56 секунд.

Совпадения в пользовательском каталоге

Песни, которые вы загружаете в свой пользовательский каталог, доступны для распознавания только вам. Если совпадение приходится на одну из них, результат содержит audio_id, а поля публичных метаданных (artist, title и другие) могут отсутствовать или быть равны null, поскольку метаданные ваших песен находятся на вашей стороне: нам известен только audio_id. Поэтому используйте audio_id в качестве ключа для таких совпадений.

Параметр return предназначен для разделенных запятыми идентификаторов дополнительных метаданных, которые вы хотите получить. Идентификаторы, которые можно отправлять: apple_music, spotify, deezer — данные и ссылки для Apple Music, Spotify и Deezer соответственно; musicbrainz — метаданные MusicBrainz. Пример: apple_music,spotify,deezer,musicbrainz. Если вы его отправите, в результате также появится поле для каждого идентификатора:

Данные в этих полях поступают из API провайдеров в исходном виде: обложки и превью из Apple Music, данные об альбоме и external_ids из Spotify, список релизов MusicBrainz и т. д. Мы не описываем их структуры на этой странице, вместо этого см. справочник по метаданным провайдеров.

Примечания

  • Обратите внимание, что в API есть поля, типы которых еще не определены в SDK (бета-версии или недавно добавленные). SDK помещают их в поле extras для каждого типизированного результата и для каждого блока провайдера (в Python SDK это model_extra). Поэтому просто читайте новые поля оттуда.
  • Вы не получаете ISRC и UPC из стандартной точки входа. Вам необходимы корпоративная точка входа и тарифный план Startup или выше, чтобы получать ISRC и UPC вместе с результатами. См. справочник по полям корпоративного ответа и совпадений.
  • Справочник метаданных провайдеров
  • Корпоративный ответ и поля совпадений
  • Пороговые значения оценки
  • Глоссарий
  • Справочник по API

О чём эта статья