自然语言检索图片 | 大装置帮助中心
跳到主要内容

自然语言检索图片

POST /v2/dataSpaces/{data_space_id}/repos/{repo_id}/files:clipSearch

请求头(Request Header)

参考认证(authentication)

请求参数(Request Parameters)

名称类型必须位置默认值取值范围描述
data_space_idstringpath--数据空间ID.
repo_idstringpath--数据集ID.

请求体(Request Body)

名称类型必须位置默认值取值范围描述
repo_idstringpath--数据集ID.
commit_idstring--版本ID.
textstring--检索文本, 为空的时候不过滤.
min_similaritydouble--最小相似度.
page_sizeinteger100-1000本次请求的分页大小.
page_tokenstring--上次请求返回的next_page_token.

请求示例(Request Example)

curl --location 'https://aidmp.cn-sh-01.sensecoreapi.dev/aids/aidmp/data/v2/dataSpaces/ecfcd941-575c-11ee-9d6f-46f164dda338/repos/ec21087e-1c68-4a86-9199-8130e346d183/files:clipSearch' \
--header 'Content-Type: application/json' \
--data 'repo_id":"ec21087e-1c68-4a86-9199-8130e346d183",
"page_size":2,
"page_token":"",
"commit_id":"5a4f997667b1440493e3ec472bb61a05",
"text":"骑自行车的小孩"}'

响应(Response)

名称类型描述
repo_annotation_filesarray[object]文件列表.
next_page_tokenstring请求返回的 next_page_token.

其中,repo_annotation_files的参数如下

名称类型描述
fileobject文件信息.
preview_uristring预览的url.
similaritydouble相似度.
annotationsobject标注数据.

其中,file的参数如下

名称类型描述
file_namestring文件名.
pathstring路径.
hashstring哈希值,目前为 SHA256.
sizeinteger文件大小,以 Byte 为单位.
typeinteger($enum)同 HashNode.type,用于区分大小文件、文件夹.
file_typeinteger($enum)根据后缀判断的文件类型,文件夹没有该字段.
commitobject所属 commit 信息.
presign_uristring文件链接.

其中,type有如下情况

状态数值含义
DIR0文件夹
FILE1文件
TINY_FILE2小文件
LARGE_FILE3大文件

其中,file_type有如下情况

状态数值含义
OTHER0其他
AUDIO1音频
TEXT2文本
IMAGE3图片
VIDEO4视频
PCD5点云

其中,commit的参数如下

名称类型描述
idstring版本ID.
repo_idstring数据集ID.
depthinteger版本深度,第4个提交的深度是4.
branch_idstring分支ID.
pidstring上一个版本节点ID.
merge_fromstring从版本节点合并的版本节点信息.
create_user_idstring创建者ID.
create_user_namestring创建者用户名.
commit_messagestring版本提交信息.
create_timestring($date-time)创建时间.
update_timestring($date-time)最后更新时间.

其中,annotations的参数如下

名称类型描述
task_namestring任务名称.
annotation_pathstring标注路径.
typeinteger($enum)标注任务类型.
is_predictionboolean是否是算法预测的.
confidencestring置信度.
categorystring物品类型 type=0|1|2的时候有值.
segmentationstring标注数据array[float] type=0|1|2的时候有值。
areastring标注面积,多少个像素点;type=0|1|2的时候有值。
annotation_file_uristring标注图片url;type=3
key_pointsarray[float]关键点的位置,每个关键点由三个数字组成:x, y, 标注状态(0 = 未标注,1 = 标注了但被遮挡,2 = 标注了也未被遮挡, 所以数组长度=len(categories)*3
category_infoarray[object]图片中物品类型信息,和annotation_file_url一起使用.
labelsstring标签信息,json格式,例如{"a":"b","aa":"bb"}.
annotation_infostring标注文件内容,senseBee标注类型的时候有值.

其中,type有如下情况

状态数值含义
CV_RLE_OBJECT_DETECTION0cv物品标注RLE模式
CV_POLYGON_OBJECT_DETECTION1cv物品多边形标注
CV_KEYPOINT_DETECTION2cv关键点标注
CV_SEMANTIC_SEGMENTATION3cv语义分割
CV_INSTANCE_SEGMENTATION4cv实例分割
CV_PANOPTIC_SEGMENTATION5cv全景分割

其中,category_info的参数如下

名称类型描述
namestring类别名称
super_categorystring超类名称
is_thinginteger($int32)全景分割/语义分割/实例分割的名词,false代表这个东西是有复数形式的人、车等物体,true是无复数形式的草地、天空
colorarray[integer($int32)]颜色[R,G,B]
key_pointarray[string]关键点
skeletonarray[object]骨骼数据

其中,skeleton的参数如下

名称类型描述
single_skeletonarray[integer($int32)]一个骨骼数据是一个数组

响应示例(Response Example)

{
"repo_annotation_files": [
{
"file": {
"file_name": "000000210299.jpg",
"path": "val2017",
"hash": "dbdcbb432c918d11747928a3eb0d80498b9cc52087b5fe515e17b3cffb7e8240",
"size": "236945",
"type": 2,
"file_type": 3,
"commit": {
"id": "2f2f468c1f794adc902dd33914529a3c",
"repo_id": "d4bada70-469c-4066-b0a2-9451a5215fd8",
"depth": 2,
"branch_id": "da6eeefa-8201-4a07-99bf-9a9a0f210d77",
"pid": "539d203631e1404c85720155a97d5c9b",
"merge_from": "",
"create_user_id": "",
"create_user_name": "adimpklz1202",
"commit_message": "add files",
"create_time": "2023-01-03T10:37:52.676Z",
"update_time": "2023-01-03T10:48:15.644Z"
}
},
"preview_uri": "https://aoss.cn-sh-01.sensecoreapi-oss.cn/aidmpsys2/graviton/repo/d4bada70-469c-4066-b0a2-9451a5215fd8/cache/db/dcbb432c918d11747928a3eb0d80498b9cc52087b5fe515e17b3cffb7e8240?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=4A645E96D7694929AFB41472D565A5E7%2F20231007%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20231007T094435Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=2dfe52a644122437260670a1059a1673107129eb75e36b3057d55f2a36d86127",
"similarity": 0.28564101457595825,
"annotations": []
},
{
"file": {
"file_name": "COCO_val2014_000000210299.jpg",
"path": "val2014",
"hash": "dbdcbb432c918d11747928a3eb0d80498b9cc52087b5fe515e17b3cffb7e8240",
"size": "236945",
"type": 2,
"file_type": 3,
"commit": {
"id": "2f2f468c1f794adc902dd33914529a3c",
"repo_id": "d4bada70-469c-4066-b0a2-9451a5215fd8",
"depth": 2,
"branch_id": "da6eeefa-8201-4a07-99bf-9a9a0f210d77",
"pid": "539d203631e1404c85720155a97d5c9b",
"merge_from": "",
"create_user_id": "",
"create_user_name": "adimpklz1202",
"commit_message": "add files",
"create_time": "2023-01-03T10:37:52.676Z",
"update_time": "2023-01-03T10:48:15.644Z"
}
},
"preview_uri": "https://aoss.cn-sh-01.sensecoreapi-oss.cn/aidmpsys2/graviton/repo/d4bada70-469c-4066-b0a2-9451a5215fd8/cache/db/dcbb432c918d11747928a3eb0d80498b9cc52087b5fe515e17b3cffb7e8240?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=4A645E96D7694929AFB41472D565A5E7%2F20231007%2Fdefault%2Fs3%2Faws4_request&X-Amz-Date=20231007T094435Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=2dfe52a644122437260670a1059a1673107129eb75e36b3057d55f2a36d86127",
"similarity": 0.28564101457595825,
"annotations": []
}
],
"next_page_token": "eyI2MzAwMjciOjIwfQ=="
}