星火AI图片理解API文档

图片理解 API 文档 | 讯飞开放平台文档中心

接口说明

• 用户输入一张图片和问题，从而识别出图片中的对象、场景等信息回答用户的问题

• 部分开发语言demo如下，其他开发语言请参照文档进行开发，也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
  图片理解 demo go语言
  图片理解 demo python语言
  图片理解 demo java语言

• 集成图像理解时，需按照以下要求:

#鉴权说明

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。

#鉴权方法

详情请参照下方签名生成

#鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

时钟偏移校验失败示例：

HTTP/1.1 403 Forbidden
Date: Mon, 22 May 2023 05:44:14 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}

#请求参数

在调用业务接口时，都需要在 Http Request Body 中配置以下参数，请求数据均为json字符串。
请求参数示例：

{
    "header": {
        "app_id": "123456",
        "uid": "39769795890"
    },
    "parameter": {
        "chat": {
            "domain": "general",
            "temperature": 0.5,
            "top_k": 4,
            "max_tokens": 2028,
            "auditing": "default"
        }
    },
    "payload": {
        "message": {
            "text": [
                {
                    "role": "user",
                    "content": "base64",
                    "content_type": "image"
                },
                {
                    "role": "user",
                    "content": "这张图片是什么内容",
                    "content_type": "text"
                }
            ]
        }
    }
}

请求参数说明：

• 单轮交互示例说明： 单轮交互只需要传递一个user角色的数据

[
    // 用户的提问
  	{"role": "user", "content": "xxx", "content_type":"image"}, // 首个必须是图片
    {"role": "user", "content": "你会做什么？"}
]

• 多轮交互的格式示例： 多轮交互需要将之前的交互历史按照user(image)->user->assistant->user->assistant规则进行拼接，保证最后一条是user的当前问题

[
    // 拼接对话历史信息:
  	{"role": "user", "content": "xxx", "content_type":"image"}, // 首个必须是图片
    {"role": "user", "content": "图片里面有几个人"},              // 用户第一个问题   role是user,表示是用户的提问
    {"role": "assistant", "content": "有三个人"},        // AI的第一个回复  role是assistant，表示是AI的回复

    // 用户最新的提问
    {"role": "user", "content": "几条腿？"}
]

字段参数说明：

• 图片数据

{
    "role": "user",
    "content": "base64",
    "content_type": "image",
}

字段参数说明：

#返回结果

返回参数示例：
成功

{
    "header": {
        "code": 0,
        "message": "Success",
        "sid": "cht000704fa@dx16ade44e4d87a1c802",
        "status": 0
    },
    "payload": {
        "choices": {
            "status": 2,
            "seq": 0,
            "text": [
                {
                    "content": "这是AI的回复文本",
  	            "content_type": "text",
      	            "content_meta": {
        	            "desc": "xxxx",
        	            "url": false,
    		            },
                    "index": 0,
                    "role": "assistant"
                }
            ]
        },
        "usage": {
            "text": {
                "completion_tokens": 0,
                "question_tokens": 0,
                "prompt_tokens": 0,
                "total_tokens": 0
            }
        }
    }
}

异常

{
    "header": {
        "code": 10110,     
        "message": "xxxx", 
        "sid": "cht00120013@dx181c8172afb0001102",
        "status": 2,
    }
}

返回参数说明:

choices字段参数说明

#结果格式补充说明

模型结果除了普通文本类型，为了满足排版需求，会出现以下的标记语言，建议集成方进行适配：

• markdown（表格、列表等）
• latex（数学公式）

#常见问题

#图片理解的主要功能是什么？

答：用户输入一张图片和问题，从而识别出图片中的对象、场景等信息回答用户的问题。

#图片理解支持什么应用平台？

答：目前支持Web API应用平台。

#图片理解的文本大小限制多少？

答：有效内容不能超过8192Token