跳转至

Search (搜索服务)

aimage.search 模块提供对 AI-Mage Search API 的完整访问能力,是 AIMage SDK 中最核心的服务模块。

功能概览

功能 说明
项目管理 访问和遍历制作项目
视频与片段 获取视频信息、浏览所有片段(Clip)及其 AI 标签
AI 搜索 文本搜索、多模态(文本 + 图像)搜索,支持丰富的过滤器
角色管理 查询角色信息、下载角色图片和参考图
资源下载 保存视频、片段、缩略图、参考图到本地
结构化数据 解析剧本(Script)和香盘表(Koubanhyou)数据

快速开始

from aimage import search

with search.client(token="your_token_here") as client:
    for project in client.projects():
        print(project.name)

        # 文本搜索
        for clip in project.search(query="夕焼け"):
            print(f"  [{clip.start_time:.1f}s - {clip.end_time:.1f}s] {clip.subtitle}")

数据模型关系

SearchClient
└── Project
    ├── Video[]
    │   ├── Clip[]              # 视频片段
    │   ├── VideoResource[]     # 附属资源(剧本、香盘表等)
    │   ├── PredictCreator[]    # 预测创作者
    │   └── PredictCharacter[]  # 预测角色
    ├── Character[]             # 角色列表
    ├── ReferenceImage[]        # 参考图片列表
    ├── Manga[]                 # 漫画列表
    └── Novel[]                 # 小说列表

文档导航

章节 说明
客户端 SearchClient 的创建、配置与 API 参考
搜索 文本搜索、多模态搜索、过滤器完整参数
数据模型
Project (项目) 项目模型与方法
Video (视频) 视频模型、懒加载属性、辅助模型
Clip (片段) 片段模型、AI 标签、剧本对齐
Character (角色) 角色模型与图片下载
ReferenceImage (参考图片) 参考图片模型
Resource (资源) 视频资源、漫画、小说
枚举与类型 所有枚举值和结构化数据模型
高级用法 ImageLike 类型、惰性加载、批量下载