热门产品
语音合成
人脸实名认证
文字识别
图像内容理解
资讯 社区 文档
控制台
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术
查看全部AI能力
场景应用
千帆大模型服务与开发平台ModelBuilder
    • 帮助文档
    • >
    • 千帆大模型服务与开发平台ModelBuilder

    样本标注

    更新时间：2024-12-23

    接口描述

    用于进行样本标注。

    权限说明

    调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

    • 完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
    • 完全控制千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataFullControlAccessPolicy
    • 运维操作千帆大模型平台数据管理（除数据标注外）的权限：QianfanDataOperateAccessPolicy

    鉴权说明

    调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

    请求结构

    POST /wenxinworkshop/entity/annotate HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "id": "48dc586f7eb63845***865e5a",
    "datasetId": "ds-7pkzh***y10n",
    "content": [{
        "prompt": "请根据下面的新闻生成摘要, 内容如下:一辆小轿车，一名女司机，竟造成9死24伤。日前，深圳市交警局对事故进行通报：从目前证据看，事故系司机超速行驶且操作不当导致。目前24名伤员已有6名治愈出院，其余正接受治疗，预计事故赔偿费或超一千万元。\n生成摘要如下:",
        "response": [
            ["女司机疲劳驾驶导致9死24伤"]
        ]
    }]
}

    请求头域

    除公共头域外，无其它特殊头域。

    请求参数

    • Body参数
    名称 类型 必填 说明
    id string 是 样本ID，通过调用获取样本列表接口，返回的id字段获取样本ID
    datasetId string 是 数据集版本id，说明：
    （1）可以通过以下任一方式获取该字段值：
    · 方式一，通过调用创建数据集接口，返回的datasetId字段获取
    · 方式二，在控制台-数据集管理列表页面，点击详情，在版本信息页查看，如下图所示
    image.png
    （2） 该字段新增支持string类型，如果之前使用的是int类型，建议变更为string类型，后续可能将逐步废弃int类型；例如之前是通过调用创建数据集接口，返回的id字段获取，请替换为接口返回的datasetId字段获取
    content object[] 否 问答对信息，只有在文本对话标注类型时，该字段有效
    labels object[] 否 标签列表，只有在文生图类型时，该字段有效

    content说明

    名称 类型 必填 描述
    prompt string 是 问题
    response string[][] 是 问答对。文本对话不同标注模版，对应content格式不同，说明：
    （1）目前有2种格式，分别为非排序文本对话、排序文本对话格式
    （2）如果为非排序文本对话，注意：
    · 一个样本最多支持十个问答对(content)
    · 非排序文本对话的回答为一个string，放在string[][]中，示例如下："response": [ ["《山水情》作为中国水墨动画的绝唱，折服了无数中外人士。"]]
    image.png
    （3）如果为排序文本对话格式，注意：
    · 一个样本最多支持十个问答对，单个问答对中的排序及回答数量总和最多支持添加5个
    · 外层列表表示不同排序，内层列表表示某个排序的所有回答，示例如下：
    "response": [["国家食药监管总局发布《食品召回管理办法》，明确一级召回，食用后已经或可能导致严重健康损害甚至死亡的食品应在知悉食品安全风险后24小时内启动召回，自公告发布之日起10个工作日内完成召回。", "国家食药监管总局发布《食品召回管理办法》，明确一级召回食品生产者应在知悉食品安全风险后24小时内启动召回，自公告发布之日起10个工作日内完成召回。对于可能导致严重健康损害甚至死亡的食品也明确需要召回。", "国家食药监管总局发布新规定《食品召回管理办法》，对于可能导致严重健康损害甚至死亡的食品，生产者需在知悉风险后的24小时内启动召回，并需在10个工作日内完成。"],["国家食药监管总局发布新规定《食品召回管理办法》，对于可能导致严重健康损害甚至死亡的食品，生产者需在知悉风险后24小时内启动召回，并须在10个工作日内完成召回。"],["国家食药监管总局发布《食品召回管理办法》，明确一级召回的食品应知悉食品安全风险后24小时内启动召回，且自公告发布之日起10个工作日内完成召回。该办法适用于食用后可能导致严重健康损害甚至死亡的食品。"]]}]
    image.png

    labels说明

    名称 类型 必填 描述
    content string 是 图片对应的prompt，说明：
    （1）只有在文生图类型时，该字段有效
    （2）示例：
    image.png

    响应头域

    除公共头域外，无其它特殊头域。

    响应参数

    名称 类型 描述
    log_id string 操作记录id
    result bool 返回结果
    status int 状态码
    success bool 是否操作成功，说明：
    · true：成功
    · false：失败

    请求示例

    非排序文本对话样本标注

    # 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/entity/annotate' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8******3d080016e374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "id": "48dc586f7eb638457b******2865e5a",
    "datasetId": "ds-7pkzh1***y10n",
    "content": [{
        "prompt": "请根据下面的新闻生成摘要, 内容如下:一辆小轿车，一名女司机，竟造成9死24伤。日前，深圳市交警局对事故进行通报：从目前证据看，事故系司机超速行驶且操作不当导致。目前24名伤员已有6名治愈出院，其余正接受治疗，预计事故赔偿费或超一千万元。\n生成摘要如下:",
        "response": [
            ["女司机疲劳驾驶导致9死24伤"]
        ]
    }]
}'

    排序文本对话样本标注

    # 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/entity/annotate' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640xxxxx' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
	"id": "bcb4b259db0046d643f15ec5fxxxxx",
	"datasetId": "ds-7pkzh1exthpuy10n",
	"content": [{
		"prompt": "请根据下面的新闻生成摘要, 内容如下:国家食药监管总局近日发布《食品召回管理办法》，明确：食用后已经或可能导致严重健康损害甚至死亡的，属一级召回，食品生产者应在知悉食品安全风险后24小时内启动召回，且自公告发布之日起10个工作日内完成召回。\n生成摘要如下:",
		"response": [
			["国家食药监管总局发布《食品召回管理办法》，明确一级召回，食用后已经或可能导致严重健康损害甚至死亡的食品应在知悉食品安全风险后24小时内启动召回，自公告发布之日起10个工作日内完成召回。", "国家食药监管总局发布《食品召回管理办法》，明确一级召回食品生产者应在知悉食品安全风险后24小时内启动召回，自公告发布之日起10个工作日内完成召回。对于可能导致严重健康损害甚至死亡的食品也明确需要召回。", "国家食药监管总局发布新规定《食品召回管理办法》，对于可能导致严重健康损害甚至死亡的食品，生产者需在知悉风险后的24小时内启动召回，并需在10个工作日内完成。"],
			["国家食药监管总局发布新规定《食品召回管理办法》，对于可能导致严重健康损害甚至死亡的食品，生产者需在知悉风险后24小时内启动召回，并须在10个工作日内完成召回。"],
			["国家食药监管总局发布《食品召回管理办法》，明确一级召回的食品应知悉食品安全风险后24小时内启动召回，且自公告发布之日起10个工作日内完成召回。该办法适用于食用后可能导致严重健康损害甚至死亡的食品。"]
		]
	}]
}'

    文生图样本标注

    # 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/entity/annotate' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
	"id": "6e426a69ff6e90dd3095d9b3b75bc2b8cf7cd0a5367d163386bb4f362c182cc6",
	"datasetId": "ds-7pkzh1exthpuy10n",
	"specialLabelTypes": [7],
	"labels": [{
		"content": "两只金毛"
	}]
}'

    响应示例

    {
	"log_id": "x7wwxwhykirrt30n",
	"result": true,
	"status": 200,
	"success": true
}

    错误码

    若请求错误，服务器将返回的JSON文本包含以下参数：

    名称 描述
    code 错误码
    message 错误描述信息，帮助理解和解决发生的错误

    例如参数错误返回：

    {
  "code": 500001,
  "message": "param invalid"
}

    更多错误码，请查看错误码说明。

    上一篇
    获取样本列表
    下一篇
    Prompt工程