实体标注
更新时间:2024-01-22
功能介绍
用于进行实体标注。
注意事项
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan.resources import Data
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
resp = Data.annotate_an_entity(
dataset_id="ds-7pkzh1exthpuy10n",
entity_id="f9bc93825e856358886bbc6ad28c7032955b54d171ae8b47587a0346c604139f_7951870f3cd747b497d32f3814b8fxxx",
content = [{
"prompt": "请根据下面的新闻生成摘要, 内容如下:一辆小轿车,一名女司机,竟造成9死24伤。日前,深圳市交警局对事故进行通报:从目前证据看,事故系司机超速行驶且操作不当导致。目前24名伤员已有6名治愈出院,其余正接受治疗,预计事故赔偿费或超一千万元。\n生成摘要如下:",
"response": [
["女司机疲劳驾驶导致9死24伤"]
]
}]
)
print(resp)
返回示例
QfResponse(
code=200,
headers={...},
body={
"log_id": "a15d0g5z8gqgx6uw",
"result": True,
"status": 200,
"success": True
},
)
参数说明
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
entity_id | string | 是 | 实体ID,通过调用获取实体列表接口,返回的id字段获取实体ID |
dataset_id | string | 是 | 数据集版本id,说明: (1)可以通过以下任一方式获取该字段值: · 方式一,通过调用创建数据集接口,返回的datasetId字段获取 · 方式二,在千帆控制台-数据集管理列表页面,点击详情,在版本信息页查看,如下图所示 (2) 该字段新增支持string类型,如果之前使用的是int类型,建议变更为string类型,后续可能将逐步废弃int类型;例如之前是通过调用创建数据集接口,返回的id字段获取,请替换为接口返回的datasetId字段获取 |
content | Optional[List[Dict[str, Any]]] | 否 | 问答对信息,只有在文本对话标注类型时,该字段有效 |
labels | Optional[List[Dict[str, Any]]] | 否 | 标签列表,只有在文生图类型时,该字段有效 |
content说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
prompt | string | 是 | 问题 |
response | string[][] | 是 | 问答对。文本对话不同标注模版,对应content格式不同,说明: (1)目前有2种格式,分别为非排序文本对话、排序文本对话格式 (2)如果为非排序文本对话,注意: · 一个实体最多支持十个问答对(content) · 非排序文本对话的回答为一个string,放在string[][]中,示例如下: "response": [ ["《山水情》作为中国水墨动画的绝唱,折服了无数中外人士。"]] (3)如果为排序文本对话格式,注意: · 一个实体最多支持十个问答对,单个问答对中的排序及回答数量总和最多支持添加5个 · 外层列表表示不同排序,内层列表表示某个排序的所有回答,示例如下: "response": [["国家食药监管总局发布《食品召回管理办法》,明确一级召回,食用后已经或可能导致严重健康损害甚至死亡的食品应在知悉食品安全风险后24小时内启动召回,自公告发布之日起10个工作日内完成召回。", "国家食药监管总局发布《食品召回管理办法》,明确一级召回食品生产者应在知悉食品安全风险后24小时内启动召回,自公告发布之日起10个工作日内完成召回。对于可能导致严重健康损害甚至死亡的食品也明确需要召回。", "国家食药监管总局发布新规定《食品召回管理办法》,对于可能导致严重健康损害甚至死亡的食品,生产者需在知悉风险后的24小时内启动召回,并需在10个工作日内完成。"],["国家食药监管总局发布新规定《食品召回管理办法》,对于可能导致严重健康损害甚至死亡的食品,生产者需在知悉风险后24小时内启动召回,并须在10个工作日内完成召回。"],["国家食药监管总局发布《食品召回管理办法》,明确一级召回的食品应知悉食品安全风险后24小时内启动召回,且自公告发布之日起10个工作日内完成召回。该办法适用于食用后可能导致严重健康损害甚至死亡的食品。"]]}] |
labels说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
content | string | 是 | 图片对应的prompt,说明: (1)只有在文生图类型时,该字段有效 (2)示例: |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | bool | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |