Search Response¶
Interpreting a Search Response¶
A search may result in zero or many matches. If one or more assets are matched, the search response conveys the following information:
- Matched Assets - metadata associated with the matched asset(s) such as Title, Artist, and ISRC
- Match Details - the details of the match including match duration, match segments and any modification details
Below is an example of a search response for an audio search that matched to one asset:
{
"lookup_ids": [
"522174538802801153"
],
"query_file_duration_seconds": 158.0,
"matches": [
{
"asset": {
"title": "she's all i wanna be",
"subtitle": "",
"artist": "Tate McRae",
"isrc": "USRC12103120",
"id": "487041776134662145",
"duration_seconds": 207.0,
"album_name": "i used to think i could fly",
"barcode": "196589103154",
"label": "RCA Records",
"distributor": "Sony Music Entertainment",
"release_date": {
"year": 2022,
"month": 5,
"day": 27
},
"dsp": [
{
"name": "spotify",
"url": "https://open.spotify.com/track/0HrbYZ5LQZjIatQdNuvF67"
}
]
},
"match_details": {
"audio": {
"query_match_duration_seconds": 158.0,
"query_match_percentage": 100.0,
"asset_match_duration_seconds": 207.0,
"asset_match_percentage": 100.0,
"segments": [
{
"query_start": 0,
"query_end": 158,
"asset_start": 0,
"asset_end": 207,
"audio_pitch": 450,
"audio_speed": 130,
"melody_transposition": null,
"confidence": 100
}
]
},
"melody": null,
"phonetic": null,
"video": null
}
}
]
}
Below is an example of a search response for a melody search that matched to one asset:
{
"lookup_ids": [
"522174538802801153"
],
"query_file_duration_seconds": 158.0,
"matches": [
{
"asset": {
"title": "she's all i wanna be",
"subtitle": "",
"artist": "Tate McRae",
"isrc": "USRC12103120",
"id": "487041776134662145",
"duration_seconds": 207.0,
"album_name": "i used to think i could fly",
"barcode": "196589103154",
"label": "RCA Records",
"distributor": "Sony Music Entertainment",
"release_date": {
"year": 2022,
"month": 5,
"day": 27
},
"dsp": [
{
"name": "spotify",
"url": "https://open.spotify.com/track/0HrbYZ5LQZjIatQdNuvF67"
}
]
},
"match_details": {
"audio": null,
"melody": {
"query_match_duration_seconds": 158.0,
"query_match_percentage": 100.0,
"asset_match_duration_seconds": 207.0,
"asset_match_percentage": 100.0,
"segments": [
{
"query_start": 0,
"query_end": 158,
"asset_start": 0,
"asset_end": 207,
"audio_pitch": null,
"audio_speed": null,
"melody_transposition": 5,
"confidence": 100
}
]
},
"phonetic": null,
"video": null
}
}
]
}
Below is an example of a search response for a query file in which content classification has been performed on:
{
"lookup_ids": [
"763438765025184769"
],
"query_file_duration_seconds": 241.0,
"matches": null,
"content_classification": {
"silence": [
{
"start": 230,
"end": 240,
"confidence": 100.0,
"subclasses": []
}
],
"music": [
{
"start": 2,
"end": 230,
"confidence": 98.4000015258789,
"subclasses": [
{
"name": "singing",
"confidence": 82.0999984741211
},
{
"name": "pop music",
"confidence": 35.20000076293945
}
]
}
],
"speech": []
}
}
Search Response Glossary¶
Below is a description of the fields provided in a search response:
| Field | Description |
|---|---|
lookup_ids | Unique identifier(s) representing a particular search |
query_file_duration_seconds | Total duration of the file submitted for search |
matches | Match information for assets identified in the search |
.asset | Metadata for identified assets |
..title | Track title of the identified asset |
..subtitle | Track subtitle (if available) of the identified asset |
..artist | Artist name of the identified asset |
..isrc | ISRC of the identified asset |
..id | Internal ID of the identified asset |
..duration_seconds | Total duration of the identified asset |
..album_name | Name of the album the identified asset is associated with |
..barcode | Barcode of the album the identified asset is associated with |
..label | Label of the album the identified asset is associated with |
..distributor | Distributor of the album the identified asset is associated with |
..release_date | Release Date of the album the identified asset is associated with |
...year | Release Date Year of the album the identified asset is associated with |
...month | Release Date Month of the album the identified asset is associated with |
...day | Release Date Day of the album the identified asset is associated with |
..dsp | DSP links for the identified asset |
...name | Name of the DSP for the provided asset link |
...url | DSP url for the identified asset |
.match_details | Match details between the submitted file (query) and the identified asset |
..audio (or ..melody) | Audio or Melody match details between query and identified asset |
...query_match_duration_seconds | Match duration of the query that matched to the identified asset |
...query_match_percentage | Match percentage (query match duration / query duration) of the query that matched to the identified asset |
...asset_match_duration_seconds | Match duration of the identified asset that matched to query |
...asset_match_percentage | Match percentage (asset match duration / asset duration) of the identified asset that matched to query |
...segments | Details about the match segments between the submitted file (query) and the identified asset |
....query_start | Start point of the query's match segment that matched to the identified asset |
....query_end | End point of the query's match segment that matched to the identified asset |
....asset_start | Start point of the asset's match segment that matched to the query |
....asset_end | End point of the asset's match segment that matched to the query |
....audio_pitch | For audio matches only: Difference in pitch (in terms of cents) between the query and the identified asset. For example a value of 0 indicates the pitch of both the query segment and the asset segment is the same. A value of 400 indicates the pitch of the query segment is 400 cents higher (or 4 semitones higher) than the speed of the asset segment |
....audio_speed | For audio matches only: Difference in speed (in terms of %) between the query and the identified asset. For example a value of 100 indicates the speed of both the query segment and the asset segment is the same. A value of 125 indicates the speed of the query segment is 25% faster than the speed of the asset segment |
....melody_transposition | For melody matches only: Pitch transposition (in terms of semitones) between the query and the identified asset. For example a value of 0 indicates the there is no transposition between the query segment and the asset segment. A value of -2 indicates the query segment is 2 semitones lower than the identified asset segment |
....confidence | The confidence score reflects the system's certainty about each segment decision, providing a relative measure of certainty for each match, ranging from 85 to 100. While the score indicates how closely a segment matches, it’s intended to aid in QA prioritization rather than serve as a strict measure of match accuracy or consistency. For more information on how best to use the confidence score, please visit our FAQ |