gallery-dl 实现 Civitai 图片元数据保存的技术方案

在图像下载工具 gallery-dl 中，用户经常需要保存图片的生成参数和元数据信息。本文将详细介绍如何配置 gallery-dl 以从 Civitai 平台下载图片时，同时保存 Stable Diffusion 生成参数等重要元数据到文本文件。

元数据保存原理

gallery-dl 通过 postprocessor（后处理器）机制实现对下载内容的二次处理。对于 Civitai 平台，我们可以利用 metadata 后处理器将图片的生成参数提取并保存为文本文件。

配置方法

基础配置

在 gallery-dl 的配置文件中对 Civitai 提取器添加 postprocessors 配置段：

"civitai": {
    "postprocessors": {
        "name": "metadata",
        "extension": "txt",
        "format": [
            "prompt: {generation[meta][prompt]}",
            "negativePrompt: {generation[meta][negativePrompt]}"
        ]
    }
}

完整配置示例

以下是一个完整的配置示例，包含了更多有用的元数据字段：

"civitai": {
    "directory": [],
    "filename": "{filename[:50]} - {uuid}.{extension}",
    "api": "trpc",
    "files": ["image"],
    "include": ["user-models", "user-posts"],
    "metadata": ["generation"],
    "nsfw": true,
    "quality": "original=true",
    "sleep-request": "0.5-1.5",
    "postprocessors": {
        "name": "metadata",
        "extension": "txt",
        "format": [
            "-------------------",
            "Stable Diffusion checkpoint (aka Model): {generation[meta][Model]}",
            "Model hash: {generation[meta][Model hash]}",
            "Resources: {generation[meta][resources]}",
            "Version: {generation[meta][Version]}",
            "-------------------",
            "prompt: {generation[meta][prompt]}",
            "-------------------",
            "negativePrompt: {generation[meta][negativePrompt]}",
            "-------------------",
            "Sampling Method: {generation[meta][sampler]}",
            "Schedule type: {generation[meta][Schedule type]}",
            "Sampling Steps: {generation[meta][steps]}"
        ]
    }
}

命令行参数

为了确保元数据功能启用，需要在命令行中添加以下参数：

gallery-dl.exe --option metadata=1 [URL]

技术细节

1. metadata 参数：配置中的 "metadata": ["generation"] 表示要获取图片的生成信息。

2. 字段映射：通过 {generation[meta][字段名]} 的格式可以访问各种元数据字段，如模型名称、提示词等。

3. 格式控制：format 数组中的每个字符串都会成为输出文本文件的一行，可以自由添加分隔线等格式化内容。

最佳实践

1. 使用 gallery-dl.exe -K [URL] 命令可以查看所有可用的元数据字段，便于自定义输出内容。

2. 对于批量下载，建议将配置保存在 gallery-dl 的配置文件中，而不是每次都使用命令行参数。

3. 可以根据需要调整 filename 模板，确保生成的文件名既包含足够信息又不会过长。

通过以上配置，gallery-dl 在从 Civitai 下载图片时，会自动生成包含所有重要生成参数的文本文件，方便用户后续查阅和使用这些参数。