ReferenceImage (参考图片)

ReferenceImage 模型代表项目中的参考图片，如背景美术、道具设计等。

获取参考图片

for ref_img in project.reference_images():
    print(f"{ref_img.file_name} - {ref_img.category}")

属性

属性	类型	说明
id	str	唯一标识
resource_id	str	资源 ID
category	str	分类
tags	list[str]	标签列表
purpose	str | None	用途说明
license	ReferenceImageLicense	授权状态
is_searchable	bool	是否可搜索
sort_order	int	排序序号
file_name	str	文件名
file_size	int	文件大小（字节）
file_url	str	文件下载 URL
mime_type	str | None	MIME 类型
extra	dict	后端返回的额外字段
created_at	datetime	创建时间
updated_at	datetime	更新时间

分类类型

值	说明
ReferenceImageCategory.BACKGROUND_ART	背景美术
ReferenceImageCategory.PROP_DESIGN	道具设计
ReferenceImageCategory.ILLUSTRATION	插图
ReferenceImageCategory.OTHER	其他

授权状态

值	说明
ReferenceImageLicense.LICENSED	已授权
ReferenceImageLicense.UNLICENSED	未授权
ReferenceImageLicense.UNKNOWN	未知

方法

save(path) -> None

下载并保存参考图片到本地：

ref_img.save("output/background.png")

save_bytes() -> bytes

获取参考图片的字节数据：

data = ref_img.save_bytes()

创建与更新

参考图像的创建、搜索、标签选项、更新和删除由 SearchClient 提供。完整清单见 CRUD 与更新接口 - 参考图像。

reference = client.create_reference_image(
    project.id,
    resource_id="resource_id",
    category="background_art",
    tags=["school", "day"],
    license="licensed",
    is_searchable=True,
)

client.update_reference_image(reference.id, tags=["school", "day", "interior"])

使用示例

# 按分类下载所有参考图片
from aimage.search.models.type import ReferenceImageCategory

for ref_img in project.reference_images():
    if ref_img.category == ReferenceImageCategory.BACKGROUND_ART:
        ref_img.save(f"output/bg/{ref_img.file_name}")
    elif ref_img.category == ReferenceImageCategory.PROP_DESIGN:
        ref_img.save(f"output/props/{ref_img.file_name}")