Image Describer API 文档 - 图像描述生成 API

概述

Image Describer API 是一款强大的图像理解工具，它能够基于您提供的图像和问题，智能地生成准确、详细且富有洞察力的图像描述。这款 基于AI图像识别 API 能够理解和分析图像内容，并根据您的提示（prompt）生成相应的文本描述。它适用于各种图像理解、图像分析和图像内容生成场景，让您轻松实现图像问一问，图像到文本的转换。

应用场景

Image Describer API 可以帮助您在以下领域高效地进行图像理解和内容生成：

• 数据图表分析: 自动解读图表数据，生成统计分析报告。
• 艺术作品评价: 对艺术作品进行专业的评价和解读。
• 博客文章生成: 根据图片生成文章段落或完整文章。
• 物体识别: 识别图像中的物体并提供详细信息，如物体名称、属性和可能的用途。
• 图像问一问: 通过提问的方式获取关于图像内容的详细信息，例如“图片中有什么？”，“这个人正在做什么？”。
• 教育应用: 辅助教学，例如识别动植物图片、讲解历史图片等。
• 电子商务: 自动生成产品描述，提升商品信息丰富度。

API 密钥

要访问 Image Describer API，您必须首先获取一个有效的 API 密钥。密钥用于验证您的请求和确保 API 的安全访问。

获取 API 密钥

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

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

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

   重要提示： 不要与他人共享您的 API 密钥，或将其暴露在浏览器或其他客户端代码中。妥善保管您的密钥以防止未经授权的访问。

API 端点

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

请求（Request）参数

请求头部

请求体

{
  "image": "data:image/jpeg;base64,{image_base64_data}",
  "prompt": "这是什么物体？描述它可能的用途。",
  "lang": "zh"
}

支持的语言

请求示例 (cURL)

curl --location 'https://api.imagedescriber.app/api/v1/generate_content' \
--header 'content-type: application/json' \
--header 'authorization: Bearer your_api_key' \
--data '{
    "image":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAQE...", 
    "prompt":"这是什么物体？描述它可能的用途。",
    "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_image_description(api_key, image_path, prompt, lang="zh"):
  """使用 Image Describer API 生成图像描述"""
  url = "https://api.imagedescriber.app/api/v1/generate_content"
  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}",
      "prompt": prompt,
      "lang": lang
  }

  response = requests.post(url, headers=headers, json=payload, stream=True) # 使用 stream=True 处理流式响应

  if response.status_code == 200:
      for chunk in response.iter_content(chunk_size=None, decode_unicode=True): # 逐块处理响应内容
          if chunk:
              print(chunk, end='')
      print()  # 打印一个换行符以结束输出
  else:
    print(f"Error: {response.status_code}")
    print(response.text)

# 示例用法
api_key = "your_api_key"
image_path = "your_image.jpg"
prompt = "这是什么物体？描述它可能的用途。"

generate_image_description(api_key, image_path, prompt)

请求示例 (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 或 drop 事件的图片 */;
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,
  "prompt": "详细描述一下这张图片",
  "lang": "zh"
};

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

const result = await response.json();
console.log(result);

响应

响应体 (流式响应)

API 返回 JSON 格式的响应数据。data 对象中的 content 字段包含 Markdown 格式的生成图像描述。

{
  "code": 0,
  "message": "success",
  "request_id": "unique_request_id_string",
  "data": {
    "content": "Markdown 格式的生成内容" 
  }
}

请求限制

为了保证服务的稳定性和公平性，每个 API 密钥每分钟最多允许 5 个请求，相当于每小时 300 次请求。超出限制的请求将被拒绝，并返回错误码 1004。

积分系统

• 每次成功的 API 调用将消耗 1 个积分。
• 被安全过滤器阻止的内容不会消耗积分。
• 系统错误不会消耗积分。

如何获取积分？

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

错误处理

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

联系我们

如果您有任何问题或建议，请随时通过以下方式联系我们：

• 电子邮件: [email protected]
• 技术支持: 联系我们

立即开始使用 Image Describer API，解锁图像理解的无限可能！