跳转至

快速开始

本章将引导您完成 AIMage SDK 的安装、配置和第一次 API 调用。

安装

从源码安装（开发模式）

git clone https://github.com/aimagexyz/aimage-sdk
cd aimage-sdk
pip install -e .

依赖项

SDK 会自动安装以下依赖：

包名 版本要求 用途
httpx >= 0.28.1 HTTP 客户端
pydantic >= 2.12.5 数据验证及模型定义
python-dotenv >= 1.2.1 .env 文件加载

配置 Token

使用 AIMage SDK 需要有效的 API Token。推荐使用 .env 文件管理：

创建 .env 文件

在项目根目录创建 .env 文件：

AIMAGE_SEARCH_TOKEN=your_token_here

在代码中加载

import os
import dotenv

dotenv.load_dotenv()

token = os.getenv("AIMAGE_SEARCH_TOKEN")

安全提示

请勿将 .env 文件提交到版本控制系统。确保 .gitignore 中包含 .env。

SDK 结构

AIMage SDK 按服务模块组织，每个服务独立提供客户端：

from aimage import search      # 搜索服务
# from aimage import review    # 监修服务（开发中）
# from aimage import generation  # 生成服务（计划中）

以下是一个完整的示例，展示使用 Search 服务从创建客户端到搜索片段的流程：

import os
import dotenv
from aimage import search  # 搜索服务
from aimage.search.settings import SearchService  # 搜索服务端点枚举，如果您使用生产环境，可以不导入此项

# 加载环境变量
dotenv.load_dotenv()

# 创建搜索客户端
with search.client(
    token=os.getenv("AIMAGE_SEARCH_TOKEN"),
    service=SearchService.DEV,
) as client:
    # 健康检查
    assert client.health()

    # 获取所有项目
    for project in client.projects():
        print(f"项目: {project.name} (ID: {project.id})")

        # 获取项目下的视频
        for video in project.videos():
            print(f"  视频: {video.name} - S{video.season_number}E{video.episode_number}")

        # 搜索片段
        for clip in project.search(query="桜"):
            print(f"  片段: [{clip.start_time:.1f}s - {clip.end_time:.1f}s]")
            if clip.subtitle:
                print(f"    台词: {clip.subtitle}")

下一步