跳转至

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]

Fields:

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:

RankingInfo pydantic-model

Bases: Response

歌曲排行信息.

ATTRIBUTE DESCRIPTION
rank

歌曲或专辑在对应榜单中的具体排名.

TYPE: str

toplist

所属的榜单名称(如“热歌榜”、“流行指数榜”).

TYPE: str

Fields:

SongListSearch pydantic-model

Bases: SongList

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

ATTRIBUTE DESCRIPTION
nickname

歌单创建者昵称.

TYPE: str

dirtype

歌单目录类型标识.

TYPE: int

Fields:

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:

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:

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:

RelatedSearchWord pydantic-model

Bases: Response

相关搜索词推荐.

ATTRIBUTE DESCRIPTION
display

相关搜索词展示文案.

TYPE: str

search

相关搜索词实际搜索关键词.

TYPE: str

Fields:

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]

Fields:

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: