search

models.search

Search API 返回模型定义.

SongSearch `pydantic-model`

Bases: Song

搜索场景下的歌曲详尽模型.

ATTRIBUTE	DESCRIPTION
`search_title`	搜索命中的标题 (可能包含高亮标签). TYPE: `str`
`title_main`	歌曲主标题. TYPE: `str`
`title_extra`	歌曲附加标题. TYPE: `str`
`fav_show`	收藏数展示文案 (如 "5500w+"). TYPE: `str`
`tag`	标签 ID. TYPE: `str`
`desc`	歌曲描述文案. TYPE: `str`
`desc_icon`	描述文案前的图标链接. TYPE: `str`
`content`	搜索结果内容摘要,当搜索命中歌词或特定评论时,该字段存放命中的文本片段. TYPE: `str`
`hotness`	热度数据对象. TYPE: `dict[str, Any]`
`hotness_desc`	热度描述 (如榜单名). TYPE: `str`
`vec_hotness`	热度榜单详情列表. TYPE: `list[dict[str, Any]]`
`new_status`	新版状态位 (2: 正常). TYPE: `int`
`protect`	是否受到版权保护. TYPE: `int`
`relatedword_group`	相关搜索词推荐组. TYPE: `dict[str, Any]`

Config:

populate_by_name: True
extra: ignore
frozen: True

Fields:

id (int)
mid (str)
name (str)
type (int)
title (str)
subtitle (str)
singer (list[Singer])
album (Album)
mv (MV)
file (File)
pay (Pay)
interval (int)
isonly (int)
language (int)
genre (int)
index_cd (int)
index_album (int)
time_public (str)
status (int)
label (str)
bpm (int)
ov (int)
sa (int)
es (str)
vs (list[str])
vi (list[int])
vf (list[float])
search_title (str)
title_main (str)
title_extra (str)
fav_show (str)
desc (str)
desc_icon (str)
hotness (dict[str, Any])
hotness_desc (str)
vec_hotness (list[dict[str, Any]])
content (str)
new_status (int)
protect (int)
relatedword_group (dict[str, Any])

AlbumSearch `pydantic-model`

Bases: Album

搜索场景下的专辑详尽模型.

ATTRIBUTE	DESCRIPTION
`album_type`	专辑类型标识 (来自 $.core_album_config.album_type).通常 1 代表正规专辑.
`singer`	搜索命中的高亮歌手名称.通常包含 `<em>` 标签. TYPE: `str`
`singer_list`	结构化的歌手对象列表.包含歌手的数字 ID 和标准名称. TYPE: `list[Singer]`
`pic`	专辑封面图片 URL (通常为 180x180 或 300x300 规格). TYPE: `str`
`pic_icon`	封面配套显示的勋章或类型图标链接. TYPE: `str`
`publish_date`	专辑发行日期 (YYYY-MM-DD). TYPE: `str`
`description`	简短描述文案.在搜索结果中常存放发行日期或厂牌. TYPE: `str`
`description2`	备用描述文案. TYPE: `str`
`desc_detail`	详尽描述对象.包含长篇专辑介绍及背景信息. TYPE: `dict[str, Any]`
`hotness`	热度数据对象.包含收藏量、趋势等原始数值. TYPE: `dict[str, Any]`
`hotness_desc`	热度简述文案.如“全网热搜”、“飙升榜前十”. TYPE: `str`
`audio_play`	播放排行信息.包含榜单名称及具体排名. TYPE: `RankingInfo`
`label_new`	专辑关联的特性标签对象. TYPE: `dict[str, Any]`
`tag_list`	专辑标签列表.用于 UI 显示“数字专辑”、“独家”等勋章. TYPE: `list[str]`
`url`	静态元数据下载链接. TYPE: `str`

Fields:

id (int)
mid (str)
name (str)
title (str)
subtitle (str)
time_public (str)
pmid (str)
desc_detail (dict[str, Any])
description (str)
description2 (str)
type (int)
award_label (str)
hotness (dict[str, Any])
hotness_desc (str)
label_new (dict[str, Any])
audio_play (RankingInfo)
pic (str)
pic_icon (str)
singer (str)
singer_list (list[Singer])
tag_list (list[str])
url (str)

RankingInfo `pydantic-model`

Bases: Response

歌曲排行信息.

ATTRIBUTE	DESCRIPTION
`rank`	歌曲或专辑在对应榜单中的具体排名. TYPE: `str`
`toplist`	所属的榜单名称(如“热歌榜”、“流行指数榜”). TYPE: `str`

Fields:

rank (str)
toplist (str)

SongListSearch `pydantic-model`

Bases: SongList

搜索结果中的歌单摘要模型.

ATTRIBUTE	DESCRIPTION
`nickname`	歌单创建者昵称. TYPE: `str`
`dirtype`	歌单目录类型标识. TYPE: `int`

Fields:

id (int)
dirid (int)
title (str)
picurl (str)
desc (str)
songnum (int)
listennum (int)
nickname (str)
dirtype (int)

SingerSearch `pydantic-model`

Bases: Singer

搜索场景下的歌手模型.

ATTRIBUTE	DESCRIPTION
`pic`	歌手头像地址. TYPE: `str`
`song_num`	歌曲数量. TYPE: `int`
`album_num`	专辑数量. TYPE: `int`
`mv_num`	MV 数量. TYPE: `int`
`subtitle`	补充描述文案. TYPE: `str`

Fields:

id (int)
mid (str)
name (str)
title (str)
type (int)
uin (int)
pmid (str)
pic (str)
song_num (int)
album_num (int)
mv_num (int)
subtitle (str)

MvSearch `pydantic-model`

Bases: MV

搜索场景下的 MV 模型.

ATTRIBUTE	DESCRIPTION
`pic`	MV 封面地址. TYPE: `str`
`play_count`	MV 播放量. TYPE: `int`
`duration`	MV 时长. TYPE: `int`
`publish_date`	发布时间. TYPE: `str`
`singer_id`	歌手 ID. TYPE: `int`
`singer_mid`	歌手 MID. TYPE: `str`
`singer_name`	歌手名称. TYPE: `str`

Fields:

id (int)
vid (str)
type (int)
name (str)
title (str)
pic (str)
play_count (int)
duration (int)
publish_date (str)
singer_id (int)
singer_mid (str)
singer_name (str)

GeneralSearchRequestBody `pydantic-model`

Bases: Response, Generic[T]

综合搜索中单个分类桶的结果容器.

ATTRIBUTE	DESCRIPTION
`estimate_sum`	搜索命中的预估总记录数. TYPE: `int`
`total_num`	搜索命中的确切总记录数. TYPE: `int`
`items`	当前分类下已展开的业务实体列表. TYPE: `list[T]`
`more_info`	继续加载该分类结果时需要回传的翻页上下文. TYPE: `dict[str, Any]`

Fields:

estimate_sum (int)
total_num (int)
items (list[T])
more_info (dict[str, Any])

RelatedSearchWord `pydantic-model`

Bases: Response

SearchSelector `pydantic-model`

Bases: Response

搜索筛选器选项.

ATTRIBUTE	DESCRIPTION
`id`	选项 ID. TYPE: `int`
`name`	选项名称. TYPE: `str`
`type`	选项类型. TYPE: `int`

Fields:

id (int)
name (str)
type (int)

SearchByTypeResponse `pydantic-model`

Bases: Response

按指定类型搜索时的响应模型.

它将元信息与对应分类的实体列表放在同一对象中,便于直接消费该类型下的当前页结果.

ATTRIBUTE	DESCRIPTION
`searchid`	搜索会话 ID,用于后续相关请求. TYPE: `str`
`perpage`	每页结果数量. TYPE: `int`
`nextpage`	下一页页码,-1 表示已加载全部结果. TYPE: `int`
`estimate_sum`	搜索命中的预估总记录数. TYPE: `int`
`total_num`	搜索命中的确切总记录数. TYPE: `int`
`song`	单曲、歌词或节目类型下的结果列表. TYPE: `list[SongSearch]`
`singer`	歌手结果列表. TYPE: `list[SingerSearch]`
`album`	专辑结果列表. TYPE: `list[AlbumSearch]`
`songlist`	歌单结果列表. TYPE: `list[SongListSearch]`
`user`	用户结果列表. TYPE: `list[dict[str, Any]]`
`audio_alum`	节目专辑结果列表. TYPE: `list[AlbumSearch]`
`mv`	MV 结果列表. TYPE: `list[MvSearch]`
`selectors`	搜索筛选器列表. TYPE: `list[list[SearchSelector]]`

Fields:

searchid (str)
perpage (int)
nextpage (int)
estimate_sum (int)
total_num (int)
song (list[SongSearch])
singer (list[SingerSearch])
album (list[AlbumSearch])
songlist (list[SongListSearch])
user (list[dict[str, Any]])
audio_alum (list[AlbumSearch])
mv (list[MvSearch])
selectors (list[list[SearchSelector]])

GeneralSearchResponse `pydantic-model`

Bases: Response

综合搜索响应模型.

每个分类字段都是独立的结果容器,既给出当前已返回的数据,也保留该分类继续翻页所需的上下文.

ATTRIBUTE	DESCRIPTION
`searchid`	搜索会话 ID,用于后续相关请求. TYPE: `str`
`perpage`	每页结果数量. TYPE: `int`
`nextpage`	下一页页码,-1 表示已加载全部结果. TYPE: `int`
`nextpage_start`	综合搜索继续翻页的关键参数. TYPE: `dict[str, Any]`
`song`	单曲结果容器. TYPE: `GeneralSearchRequestBody[SongSearch]`
`singer`	歌手结果容器. TYPE: `GeneralSearchRequestBody[SingerSearch]`
`album`	专辑结果容器. TYPE: `GeneralSearchRequestBody[AlbumSearch]`
`mv`	MV 结果容器. TYPE: `GeneralSearchRequestBody[MvSearch]`
`songlist`	歌单结果容器. TYPE: `GeneralSearchRequestBody[SongListSearch]`
`audio`	节目结果容器. TYPE: `GeneralSearchRequestBody[AlbumSearch]`
`direct`	直接命中结果分组. TYPE: `list[dict[str, Any]]`
`related`	相关搜索词推荐结果容器. TYPE: `GeneralSearchRequestBody[RelatedSearchWord]`

Fields:

searchid (str)
perpage (int)
nextpage (int)
nextpage_start (dict[str, Any])
song (GeneralSearchRequestBody[SongSearch])
singer (GeneralSearchRequestBody[SingerSearch])
mv (GeneralSearchRequestBody[MvSearch])
album (GeneralSearchRequestBody[AlbumSearch])
songlist (GeneralSearchRequestBody[SongListSearch])
audio (GeneralSearchRequestBody[AlbumSearch])
direct (list[dict[str, Any]])
related (GeneralSearchRequestBody[RelatedSearchWord])

QuickSearchItem `pydantic-model`

Bases: Response

快速搜索条目.

ATTRIBUTE	DESCRIPTION
`docid`	docid. TYPE: `str`
`id`	id. TYPE: `str`
`mid`	mid. TYPE: `str`
`name`	名称. TYPE: `str`
`singer`	歌手名称. TYPE: `str`
`pic`	封面图片地址. TYPE: `str`
`vid`	MV ID. TYPE: `str`

Fields:

docid (str)
id (str)
mid (str)
name (str)
singer (str)
pic (str)
vid (str)

QuickSearchCategory `pydantic-model`

Bases: Response

快速搜索分类.

ATTRIBUTE	DESCRIPTION
`count`	命中数量. TYPE: `int`
`itemlist`	条目列表. TYPE: `list[QuickSearchItem]`
`name`	分类名称. TYPE: `str`
`order`	排序权重. TYPE: `int`
`type`	分类类型. TYPE: `int`

Fields:

count (int)
itemlist (list[QuickSearchItem])
name (str)
order (int)
type (int)

QuickSearchResponse `pydantic-model`

Bases: Response

快速搜索响应.

ATTRIBUTE	DESCRIPTION
`song`	单曲结果. TYPE: `QuickSearchCategory`
`singer`	歌手结果. TYPE: `QuickSearchCategory`
`album`	专辑结果. TYPE: `QuickSearchCategory`
`mv`	MV 结果. TYPE: `QuickSearchCategory`

Fields:

song (QuickSearchCategory)
singer (QuickSearchCategory)
album (QuickSearchCategory)
mv (QuickSearchCategory)

Hotkey `pydantic-model`

Bases: Response

热搜词条目.

ATTRIBUTE	DESCRIPTION
`hotkey_id`	热搜词唯一标识. TYPE: `str`
`query`	热搜关键词. TYPE: `str`
`title`	热搜展示标题. TYPE: `str`
`score`	热度得分. TYPE: `str`
`kind`	条目类别. TYPE: `int`
`type`	条目类型. TYPE: `int`
`source`	数据来源. TYPE: `int`
`need_top`	是否置顶. TYPE: `int`
`subpos`	排序位置. TYPE: `int`
`song_type`	关联歌曲类型. TYPE: `int`
`direct_id`	直接关联的歌曲 ID. TYPE: `int`
`jump_tab`	跳转标签页. TYPE: `str`
`jump_url`	跳转链接. TYPE: `str`
`cover_pic_url`	封面图片地址. TYPE: `str`
`pic_url`	图片地址. TYPE: `str`
`description`	描述文案. TYPE: `str`

Fields:

hotkey_id (str)
query (str)
title (str)
score (str)
kind (int)
type (int)
source (int)
need_top (int)
subpos (int)
song_type (int)
direct_id (int)
jump_tab (str)
jump_url (str)
cover_pic_url (str)
pic_url (str)
description (str)

HotkeyResponse `pydantic-model`

Bases: Response

热搜词列表响应.

ATTRIBUTE	DESCRIPTION
`ret_code`	返回码. TYPE: `int`
`hotkey_time`	热搜时间戳. TYPE: `str`
`track_list_id`	歌单 ID. TYPE: `str`
`vec_hotkey`	热搜词列表. TYPE: `list[Hotkey]`
`vec_reckey`	推荐搜索词列表. TYPE: `list[dict[str, Any]]`

Fields:

ret_code (int)
hotkey_time (str)
track_list_id (str)
vec_hotkey (list[Hotkey])
vec_reckey (list[dict[str, Any]])

CompleteItem `pydantic-model`

Bases: Response

搜索补全建议条目.

ATTRIBUTE	DESCRIPTION
`hint`	补全提示文本. TYPE: `str`
`hint_hilight`	高亮后的提示文本 (含 `<em>` 标签). TYPE: `str`
`docid`	docid. TYPE: `str`
`type`	条目类型. TYPE: `int`
`res_type`	结果类型. TYPE: `str`
`score`	匹配得分. TYPE: `float`
`pre_search`	是否直接发起搜索. TYPE: `bool`
`icon`	图标地址. TYPE: `str`
`icon_type`	图标类型. TYPE: `int`
`jumptab`	跳转标签页. TYPE: `int`
`jump_type`	跳转类型. TYPE: `int`
`jump_url`	跳转链接. TYPE: `str`
`pic_url`	图片地址. TYPE: `str`

Fields:

hint (str)
hint_hilight (str)
docid (str)
type (int)
res_type (str)
score (float)
pre_search (bool)
icon (str)
icon_type (int)
jumptab (int)
jump_type (int)
jump_url (str)
pic_url (str)

CompleteResponse `pydantic-model`

Bases: Response

搜索词补全响应.

ATTRIBUTE	DESCRIPTION
`items`	补全建议条目列表. TYPE: `list[CompleteItem]`
`total_num`	补全结果总数. TYPE: `int`
`search_id`	搜索会话 ID. TYPE: `str`
`expire_time`	过期时间戳. TYPE: `int`
`use_default_search`	是否使用默认搜索词. TYPE: `int`
`vec_direct_items`	直达结果列表. TYPE: `list[dict[str, Any]]`
`vec_related_items`	相关搜索词列表. TYPE: `list[dict[str, Any]]`
`history_items`	历史搜索词列表. TYPE: `list[dict[str, Any]]`

Fields:

items (list[CompleteItem])
total_num (int)
search_id (str)
expire_time (int)
use_default_search (int)
debug_info (str)
expid (str)
history_items (list[dict[str, Any]])
vec_direct_items (list[dict[str, Any]])
vec_related_items (list[dict[str, Any]])

ATTRIBUTE	DESCRIPTION
`display`	相关搜索词展示文案. TYPE: `str`
`search`	相关搜索词实际搜索关键词. TYPE: `str`

search

models.search

SongSearch pydantic-model

AlbumSearch pydantic-model

RankingInfo pydantic-model

SongListSearch pydantic-model

SingerSearch pydantic-model

MvSearch pydantic-model

GeneralSearchRequestBody pydantic-model

RelatedSearchWord pydantic-model

SearchSelector pydantic-model

SearchByTypeResponse pydantic-model

GeneralSearchResponse pydantic-model

QuickSearchItem pydantic-model

QuickSearchCategory pydantic-model

QuickSearchResponse pydantic-model

Hotkey pydantic-model

HotkeyResponse pydantic-model

CompleteItem pydantic-model

CompleteResponse pydantic-model

SongSearch `pydantic-model`

AlbumSearch `pydantic-model`

RankingInfo `pydantic-model`

SongListSearch `pydantic-model`

SingerSearch `pydantic-model`

MvSearch `pydantic-model`

GeneralSearchRequestBody `pydantic-model`

RelatedSearchWord `pydantic-model`

SearchSelector `pydantic-model`

SearchByTypeResponse `pydantic-model`

GeneralSearchResponse `pydantic-model`

QuickSearchItem `pydantic-model`

QuickSearchCategory `pydantic-model`

QuickSearchResponse `pydantic-model`

Hotkey `pydantic-model`

HotkeyResponse `pydantic-model`

CompleteItem `pydantic-model`

CompleteResponse `pydantic-model`