AI 替代文本生成器 API 文档 - 自动为图片生成替代文本

概述

AI 替代文本生成器 API 是一项功能强大的服务，旨在自动为图片生成描述性的替代文本。通过利用先进的 AI 技术，该 API 能够分析您的图片并创建有意义、与上下文相关的 alt 文本，这对于网站可访问性（Accessibility）和 SEO 至关重要。使用像这样的图片 alt 文本生成器，可以帮助确保您的视觉内容能被搜索引擎理解。它还能为您节省数小时的人工编写时间，显著提升生产力。

应用场景

AI 替代文本生成器 API 非常适用于各种需要为图片生成替代文本的关键应用场景：

• 网站可访问性： 自动生成替代文本，使您的网站符合无障碍标准，为所有用户提供更佳的浏览体验。
• SEO 优化： 通过为图片提供描述性的alt 文本，帮助搜索引擎理解您的视觉内容，从而提升网站的搜索排名。
• 内容管理系统 (CMS)： 集成此 API，在图片上传时自动生成替代文本，节省时间并确保内容的一致性。
• 电子商务平台： 为商品列表添加描述性的替代文本，从而同时改善 SEO 和视障用户的购物体验。
• 博客和新闻网站： 自动为文章配图添加替代文本，提高内容的可访问性和搜索可见性。

API 密钥

要访问 AI 替代文本生成器 API，您必须首先获取一个有效的 API 密钥。该密钥用于验证您的请求身份，确保对 API 的安全访问。

获取 API 密钥

1. 访问 API 密钥管理页面： 登录系统后，点击右上角的用户头像。在下拉菜单中，点击“申请 API”以打开 API 密钥管理页面。

2. 创建新密钥： 点击“创建新密钥”，在弹出的对话框中为您的密钥输入一个名称，然后点击“创建”。

3. 复制并妥善保管您的密钥： 请注意，密钥只会完整显示一次。 点击复制图标将密钥复制到剪贴板，然后点击“确认”关闭对话框。

重要提示： 请勿与他人分享密钥，或将其暴露在浏览器、客户端代码或任何其他不安全的位置。请妥善保管您的密钥以防未经授权的访问。

API 端点

POST https://api.imagedescriber.app/api/v1/generate_alt_text

请求参数

请求头 (Request Headers)

请求体 (Request Body)

AI 替代文本生成器 API 接受以下请求结构：

{
  "image": "data:image/jpeg;base64,{image_base64_data}",
  "lang": "zh"
}

支持的语言

请求示例 (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_alt_text' \
--header 'content-type: application/json' \
--header 'authorization: Bearer your_api_key' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...",
    "lang":"zh"
}'

请求示例 (Python)

import requests
import base64

def image_to_base64(image_path):
    """将图片转换为 Base64 编码"""
    with open(image_path, "rb") as image_file:
        encoded_string = base64.b64encode(image_file.read()).decode("utf-8")
    return encoded_string

def generate_alt_text(api_key, image_path, lang="zh"):
    """使用 AI 替代文本生成器 API 为图片生成替代文本"""
    url = "https://api.imagedescriber.app/api/v1/generate_alt_text"
    headers = {
        "content-type": "application/json",
        "authorization": f"Bearer {api_key}"
    }

    image_base64_data = image_to_base64(image_path)
    payload = {
        "image": f"data:image/jpeg;base64,{image_base64_data}",
        "lang": lang
    }

    response = requests.post(url, headers=headers, json=payload)

    if response.status_code == 200:
        result = response.json()
        alt_text_data = result["data"]["alt_text"]
        print("生成的描述:", alt_text_data["description"])
        print("生成的替代文本:", alt_text_data["alt"])
        print("剩余积分:", result["data"]["credits"]["remaining"])
    else:
        print(f"错误: {response.status_code}")
        print(response.text)

# 使用示例
api_key = "your_api_key"
image_path = "your_image.jpg"

generate_alt_text(api_key, image_path)

请求示例 (Next.js)

import fs from 'fs';

// 服务端实现
const buffer = await fs.readFileSync("/temp/test.jpg");
const base64Image = buffer.toString('base64');
const imageData = `data:image/jpeg;base64,${base64Image}`;

// 客户端实现
const file: File = /* 来自 input 或拖放事件的文件 */;
const arrayBuffer = await file.arrayBuffer();
const bytes = new Uint8Array(arrayBuffer);
const base64Image = btoa(String.fromCharCode.apply(null, bytes as any));
const imageData = `data:${file.type};base64,${base64Image}`;

const body = {
  "image": imageData,
  "lang": "zh"
};

const response = await fetch('https://api.imagedescriber.app/api/v1/generate_alt_text', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {your_api_key}'
  },
  body: JSON.stringify(body),
});

const result = await response.json();
console.log('生成的描述:', result.data.alt_text.description);
console.log('生成的替代文本:', result.data.alt_text.alt);

响应

响应体 (JSON Response)

图片 alt 文本生成器 返回的响应中包含详细的描述和一个替代文本选项数组。

{
  "code": 0,
  "message": "success",
  "request_id": "unique_request_id_string",
  "data": {
    "alt_text": {
      "description": "详细的图片描述",
      "alt": [
        "alt1",
        "alt2",
        "..."
      ]
    },
    "credits": {
      "amount": "本次调用消耗的积分",
      "remaining": "本次调用后剩余的总积分"
    }
  }
}

请求限制

为保证服务的稳定和公平，每个 API 密钥的请求频率限制为每分钟 30 次（每小时 1800 次）。超过此限制的请求将被拒绝，并返回错误码 1004。

积分系统

• 每次成功调用 API 为图片生成替代文本将消耗 1 点积分。
• 被安全过滤器拦截的内容不消耗积分。
• 系统错误不消耗积分。

如何获取更多积分？

您可以访问积分充值页面购买积分包，以支持更多的 API 调用。我们提供多种套餐以满足不同用户的需求。

错误处理

下表列出了常见的错误码、其含义及解决方案：

用例与集成示例

SEO 增强

使用 AI 替代文本生成器 API 自动为您的网站图片生成替代文本：

// 使用 AI 生成的替代文本增强图片 SEO
const enhanceImageSEO = async (imageElement, apiKey) => {
  const canvas = document.createElement('canvas');
  const ctx = canvas.getContext('2d');
  canvas.width = imageElement.width;
  canvas.height = imageElement.height;
  ctx.drawImage(imageElement, 0, 0);

  const base64Image = canvas.toDataURL('image/jpeg');

  const response = await fetch('/api/v1/generate_alt_text', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    },
    body: JSON.stringify({ image: base64Image })
  });

  const result = await response.json();
  const { alt } = result.data.alt_text;

  // 更新图片的 alt 属性以优化 SEO 和可访问性
  if (alt && alt.length > 0) {
    imageElement.alt = alt[0];
  }
};

内容管理集成

将图片 alt 文本生成器集成到您的 CMS 工作流中：

# 在内容管理系统中批量处理图片
import os
import requests
from pathlib import Path

def bulk_generate_alt_text(directory_path, api_key):
    """处理目录中的所有图片以生成替代文本"""
    image_extensions = ['.jpg', '.jpeg', '.png', '.webp']

    for image_path in Path(directory_path).iterdir():
        if image_path.suffix.lower() in image_extensions:
            try:
                # 为每张图片生成替代文本
                result = generate_alt_text(api_key, str(image_path))

                # 将元数据保存到附属文件中
                metadata_path = image_path.with_suffix('.json')
                with open(metadata_path, 'w') as f:
                    json.dump(result['data']['alt_text'], f, indent=2)

                print(f"已处理: {image_path.name}")

            except Exception as e:
                print(f"处理 {image_path.name} 时出错: {e}")

# 用法
bulk_generate_alt_text("/path/to/images", "your_api_key")

联系我们

如果您对我们的 AI 替代文本生成器 API 有任何疑问或建议，请随时通过以下方式与我们联系：

• 电子邮件: [email protected]
• 技术支持: 客户支持团队
• Discord: 加入我们的 Discord 社区

立即开始使用 AI 替代文本生成器 API，释放自动化图片可访问性与 SEO 的强大力量！