开放能力
开发平台
行业应用
生态合作
开发与教学
资讯 社区 控制台
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术
AR与VR
数据智能
场景方案
部署方案
行业应用
智能教育
智能医疗
智能零售
智能工业
企业服务
智能政务
信息服务
智能园区

接口说明

相同图检索—入库

该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**

$image = file_get_contents('example.jpg');
$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用相同图检索—入库, 图片参数为本地图片
$client->sameHqAdd($image, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用相同图检索—入库, 图片参数为本地图片
$client->sameHqAdd($image, $brief, $options);
$url = "http//www.x.com/sample.jpg";

$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用相同图检索—入库, 图片参数为远程url图片
$client->sameHqAddUrl($url, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用相同图检索—入库, 图片参数为远程url图片
$client->sameHqAddUrl($url, $brief, $options);

相同图检索—入库 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
brief string 检索时原样带回,最长256B。
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索

相同图检索—入库 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
cont_sign string 输入图片签名,可用于删除

相同图检索—入库 返回示例

{
    "log_id": 2263663554,
    "cont_sign": "4261577168,501945506"
}

相同图检索—检索

完成入库后,可使用该接口实现相同图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**

$image = file_get_contents('example.jpg');

// 调用相同图检索—检索, 图片参数为本地图片
$client->sameHqSearch($image);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用相同图检索—检索, 图片参数为本地图片
$client->sameHqSearch($image, $options);
$url = "http//www.x.com/sample.jpg";

// 调用相同图检索—检索, 图片参数为远程url图片
$client->sameHqSearchUrl($url);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用相同图检索—检索, 图片参数为远程url图片
$client->sameHqSearchUrl($url, $options);

相同图检索—检索 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索
tag_logic string 检索时tag之间的逻辑, 0:逻辑and,1:逻辑or
pn string 分页功能,起始位置,例:0。未指定分页时,默认返回前300个结果;接口返回数量最大限制1000条,例如:起始位置为900,截取条数500条,接口也只返回第900 - 1000条的结果,共计100条
rn string 分页功能,截取条数,例:250

相同图检索—检索 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
result_num uint32 检索结果数
result object[] 结果数组
+cont_sign string 图片签名,可以用来删除图片或定位问题
+score float 图片相关性,0-1
+brief string 调用add接口添加的brief信息,为保证该结果有效性,请入库是填写有效可关联至本地图片库的有效id信息
has_more bool 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段

相同图检索—检索 返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

相同图检索—更新

更新图库中图片的摘要和分类信息(具体变量为brief、tags)

    $image = file_get_contents('example.jpg');

    // 调用相同图检索—更新, 图片参数为本地图片
    $client->sameHqUpdate($image);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["tags"] = "100,11";

    // 带参数调用相同图检索—更新, 图片参数为本地图片
    $client->sameHqUpdate($image, $options);
    $url = "http//www.x.com/sample.jpg";

    // 调用相同图检索—更新, 图片参数为远程url图片
    $client->sameHqUpdateUrl($url);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["tags"] = "100,11";

    // 带参数调用相同图检索—更新, 图片参数为远程url图片
    $client->sameHqUpdateUrl($url, $options);
    
     // 带参数调用相同图检索—更新, 图片签名
    $cont_sign="g988312421";
    $client->sameHqUpdateContSign($cont_sign, $options);

相同图检索—更新 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
brief string 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"}
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索

相同图检索—更新 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位

相同图检索—更新 返回示例

{
    "log_id": 2263663554
}

相同图检索—删除

删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign

$image = file_get_contents('example.jpg');

// 调用删除相同图,传入参数为图片
$client->sameHqDeleteByImage($image);
$url = "http//www.x.com/sample.jpg";

// 调用删除相同图,图片参数为远程url图片
$client->sameHqDeleteByUrl($url);
$contSign = "8cnn32frvrr2cd901";

// 调用删除相同图,传入参数为图片签名
$client->sameHqDeleteBySign($contSign);

相同图检索—删除 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign string 图片签名

相同图检索—删除 返回数据参数详情

参数 类型 是否必须 说明 示例
log_id number 请求标识码,随机数,唯一 507499361

相同图检索—删除 返回示例

{
  "log_id": 50488417
}

相似图检索—入库

该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**

$image = file_get_contents('example.jpg');
$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用相似图检索—入库, 图片参数为本地图片
$client->similarAdd($image, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用相似图检索—入库, 图片参数为本地图片
$client->similarAdd($image, $brief, $options);
$url = "http//www.x.com/sample.jpg";

$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用相似图检索—入库, 图片参数为远程url图片
$client->similarAddUrl($url, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用相似图检索—入库, 图片参数为远程url图片
$client->similarAddUrl($url, $brief, $options);

相似图检索—入库 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
brief string 检索时原样带回,最长256B。
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索

相似图检索—入库 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
cont_sign string 输入图片签名,可用于删除

相似图检索—入库 返回示例

{
    "log_id": 2263663554,
    "cont_sign": "4261577168,501945506"
}

相似图检索—检索

完成入库后,可使用该接口实现相似图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息。**

$image = file_get_contents('example.jpg');

// 调用相似图检索—检索, 图片参数为本地图片
$client->similarSearch($image);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用相似图检索—检索, 图片参数为本地图片
$client->similarSearch($image, $options);
$url = "http//www.x.com/sample.jpg";

// 调用相似图检索—检索, 图片参数为远程url图片
$client->similarSearchUrl($url);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用相似图检索—检索, 图片参数为远程url图片
$client->similarSearchUrl($url, $options);

相似图检索—检索 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索
tag_logic string 检索时tag之间的逻辑, 0:逻辑and,1:逻辑or
pn string 分页功能,起始位置,例:0。未指定分页时,默认返回前300个结果;接口返回数量最大限制1000条,例如:起始位置为900,截取条数500条,接口也只返回第900 - 1000条的结果,共计100条
rn string 分页功能,截取条数,例:250

相似图检索—检索 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
result_num uint32 检索结果数
result object[] 结果数组
+cont_sign string 图片签名,可以用来删除图片或定位问题
+score float 图片相关性,0-1
+brief string add是添加的brief信息
has_more bool 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段

相似图检索—检索 返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

相似图检索—更新

更新图库中图片的摘要和分类信息(具体变量为brief、tags)

    $image = file_get_contents('example.jpg');

    // 调用相似图检索—更新, 图片参数为本地图片
    $client->similarUpdate($image);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["tags"] = "100,11";

    // 带参数调用相似图检索—更新, 图片参数为本地图片
    $client->similarUpdate($image, $options);
    $url = "http//www.x.com/sample.jpg";

    // 调用相似图检索—更新, 图片参数为远程url图片
    $client->similarUpdateUrl($url);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["tags"] = "100,11";

    // 带参数调用相似图检索—更新, 图片参数为远程url图片
    $client->similarUpdateUrl($url, $options);
    
    // 带参数调用相似图检索—更新, 图片签名
    $cont_sign="g988312421";
    $client->similarUpdateContSign($cont_sign, $options);

相似图检索—更新 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
brief string 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"}
tags string 1 - 65535范围内的整数,tag间以逗号分隔,最多2个tag。样例:"100,11" ;检索时可圈定分类维度进行检索

相似图检索—更新 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位

相似图检索—更新 返回示例

{
    "log_id": 2263663554
}

相似图检索—删除

删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign

$image = file_get_contents('example.jpg');

// 调用删除相似图,传入参数为图片
$client->similarDeleteByImage($image);
$url = "http//www.x.com/sample.jpg";

// 调用删除相似图,图片参数为远程url图片
$client->similarDeleteByUrl($url);
$contSign = "8cnn32frvrr2cd901";

// 调用删除相似图,传入参数为图片签名
$client->similarDeleteBySign($contSign);

相似图检索—删除 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少50px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign string 图片签名

相似图检索—删除 返回数据参数详情

参数 类型 是否必须 说明 示例
log_id number 请求标识码,随机数,唯一 507499361

相似图检索—删除 返回示例

{
  "log_id": 50488417
}

商品检索—入库

该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等)。同时可提交分类维度信息(具体变量为class_id1、class_id2),方便对图库中的图片进行管理、分类检索。**注:重复添加完全相同的图片会返回错误。**

$image = file_get_contents('example.jpg');
$brief = "{\"name\":\"手机\", \"id\":\"666\"}";

// 调用商品检索—入库, 图片参数为本地图片
$client->productAdd($image, $brief);

// 如果有可选参数
$options = array();
$options["class_id1"] = 1;
$options["class_id2"] = 1;

// 带参数调用商品检索—入库, 图片参数为本地图片
$client->productAdd($image, $brief, $options);
$url = "http//www.x.com/sample.jpg";

$brief = "{\"name\":\"手机\", \"id\":\"666\"}";

// 调用商品检索—入库, 图片参数为远程url图片
$client->productAddUrl($url, $brief);

// 如果有可选参数
$options = array();
$options["class_id1"] = 1;
$options["class_id2"] = 1;

// 带参数调用商品检索—入库, 图片参数为远程url图片
$client->productAddUrl($url, $brief, $options);

商品检索—入库 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
brief string 检索时原样带回,最长256B。请注意,检索接口不返回原图,仅反馈当前填写的brief信息,所以调用该入库接口时,brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息
class_id1 string 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索
class_id2 string 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索

商品检索—入库 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
cont_sign string 输入图片签名,可用于删除

商品检索—入库 返回示例

{
    "log_id": 2263663554,
    "cont_sign": "4261577168,501945506"
}

商品检索—检索

完成入库后,可使用该接口实现商品检索。支持传入指定分类维度(具体变量class_id1、class_id2)进行检索,返回结果支持翻页(具体变量pn、rn)。**请注意,检索接口不返回原图,仅反馈当前填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息**

$image = file_get_contents('example.jpg');

// 调用商品检索—检索, 图片参数为本地图片
$client->productSearch($image);

// 如果有可选参数
$options = array();
$options["class_id1"] = 1;
$options["class_id2"] = 1;
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用商品检索—检索, 图片参数为本地图片
$client->productSearch($image, $options);
$url = "http//www.x.com/sample.jpg";

// 调用商品检索—检索, 图片参数为远程url图片
$client->productSearchUrl($url);

// 如果有可选参数
$options = array();
$options["class_id1"] = 1;
$options["class_id2"] = 1;
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用商品检索—检索, 图片参数为远程url图片
$client->productSearchUrl($url, $options);

商品检索—检索 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
class_id1 string 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索
class_id2 string 商品分类维度1,支持1-60范围内的整数。检索时可圈定该分类维度进行检索
pn string 分页功能,起始位置,例:0。未指定分页时,默认返回前300个结果;接口返回数量最大限制1000条,例如:起始位置为900,截取条数500条,接口也只返回第900 - 1000条的结果,共计100条
rn string 分页功能,截取条数,例:250

商品检索—检索 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
result_num uint32 检索结果数
result object[] 结果数组
+cont_sign string 图片签名,可以用来删除图片或定位问题
+score float 图片相关性,0-1
+brief string add是添加的brief信息
has_more bool 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段

商品检索—检索 返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/mobile.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
    "log_id": 1968648150
}

商品检索—更新

更新图库中图片的摘要和分类信息(具体变量为brief、class_id1/class_id2)

    $image = file_get_contents('example.jpg');

    // 调用商品检索—更新, 图片参数为本地图片
    $client->productUpdate($image);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["class_id1"] = 1;
    $options["class_id2"] = 1;

    // 带参数调用商品检索—更新, 图片参数为本地图片
    $client->productUpdate($image, $options);
    $url = "http//www.x.com/sample.jpg";

    // 调用商品检索—更新, 图片参数为远程url图片
    $client->productUpdateUrl($url);

    // 如果有可选参数
    $options = array();
    $options["brief"] = "{\"name\":\"周杰伦\", \"id\":\"666\"}";
    $options["class_id1"] = 1;
    $options["class_id2"] = 1;

    // 带参数调用商品检索—更新, 图片参数为远程url图片
    $client->productUpdateUrl($url, $options);
     // 带参数调用商品检索—更新, 图片签名
     $cont_sign="g988312421";
    $client->productUpdateContSign($cont_sign, $options);

商品检索—更新 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign 三选一,优先级:image > url > cont_sign** ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
brief string 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"}
class_id1 string 更新的商品分类1,支持1-60范围内的整数。
class_id2 string 更新的商品分类2,支持1-60范围内的整数。

商品检索—更新 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位

商品检索—更新 返回示例

{
    "log_id": 2263663554
}

商品检索—删除

删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image,最多支持1000个cont_sign

$image = file_get_contents('example.jpg');

// 调用删除商品,传入参数为图片
$client->productDeleteByImage($image);
$url = "http//www.x.com/sample.jpg";

// 调用删除商品,图片参数为远程url图片
$client->productDeleteByUrl($url);
$contSign = "8cnn32frvrr2cd901";

// 调用删除商品,传入参数为图片签名
$client->productDeleteBySign($contSign);

商品检索—删除 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式
url string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少300px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
cont_sign string 图片签名

商品检索—删除 返回数据参数详情

参数 类型 是否必须 说明 示例
log_id number 请求标识码,随机数,唯一 507499361

商品检索—删除 返回示例

{
  "log_id": 50488417
}

绘本图片搜索—入库

该接口实现单张图片入库,入库时需要同步提交图片及可关联至本地图库的摘要信息(具体变量为brief,具体可传入图片在本地标记id、图片url、图片名称等);同时可提交分类维度信息(具体变量为tags,最多可传入2个tag),方便对图库中的图片进行管理、分类检索。

注:重复添加完全相同的图片会返回错误

// 如果有可选参数
$options = array("tags"=> "100,11")

$image = file_get_contents('example.jpg');
$brief = array("name"=>"周杰伦", "id"=>"666")

// 调用绘本图片搜索—入库, 图片参数为本地图片
$client->pictureBookAddImage($image, $brief, options);

// 调用绘本图片搜索—入库, 图片参数为远程url图片
$url = "http//www.x.com/sample.jpg";
$client->pictureBookAddUrl($url, $brief, options);

绘本图片搜索—入库 请求参数详情

参数 是否必选 类型 可选值范围 说明
image string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M。(和url二选一,image优先级更高),注意要去掉图片头部,如(data:image/jpg;base64,);最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式。重复添加完全相同的图片会返回错误,提示不能重复入库。
url string - 图片URL,和image二选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
brief string - 检索时原样带回,最长256B。样例:{"name":"周杰伦", "id":"666"} 。请注意,检索接口不返回原图,仅返回入库时填写的brief信息,所以调用入库接口时,brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息
tags string 1 - 65535范围内的整数 tag间以逗号分隔,最多2个tag,2个tag无层级关系,检索时支持逻辑运算。样例:"100,11" ;检索时可圈定分类维度进行检索

绘本图片搜索—入库 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,无实际意义,用于问题定位
cont_sign string 入库图片的签名信息,请务必保存至本地,以便后续用作批量删除、查询某张图是否已经入过库等用途

绘本图片搜索—入库 返回示例

{
    "log_id": 2263663554,
    "cont_sign": "4261577168,501945506"
}

绘本图片搜索—检索

完成入库后,可使用该接口实现绘本图检索。支持传入指定分类维度(具体变量tags)进行检索,返回结果支持翻页(具体变量pn、rn)

请注意,检索接口不返回原图,仅反馈入库时填写的brief信息,请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息

// 如果有可选参数
$options = array("tags"=> "100,11", "tag_logic"=>"0", "pn"=>"100", "rn"=>"250")

// 带参数调用绘本图片搜索—检索, 图片参数为本地图片 
client.pictureBookSearchImage($image, $options)

// 调用绘本图片搜索—入库, 图片参数为本地图片
$image = file_get_contents('example.jpg');
$client->pictureBookSearchUrl($image, $options);

绘本图片搜索—检索 请求参数详情

参数 是否必选 类型 可选值范围 说明
image string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M。(和url二选一,image优先级更高),注意要去掉图片头部,如(data:image/jpg;base64,);最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式
url string - 图片URL,和image二选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
tags string 1 - 65535范围内的整数 分类维度信息,tag间以逗号分隔,最多可传入2个tag,tag间无层级关系,示例:"100,11"
tag_logic string 0,1 检索时tag之间的逻辑, 0:逻辑and,1:逻辑or
pn string 0 - 999范围内的整数 分页功能,起始位置,例:0,代表从第1个结果开始。注:未指定分页时,默认返回前300个结果;接口返回数量最大限制1000个,例如:起始位置为900,截取条数500条,接口也只返回第901 - 1000条的结果,共计100条
rn string 1 - 1000范围内的整数 分页功能,截取条数,例:250

绘本图片搜索—检索 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,无实际含义,用于问题定位
result_num uint32 检索结果数
result object[] 结果数组
+cont_sign string 入库图片签名,可以用来删除图片或定位问题
+score float 图片相关性,取值范围0-1,越接近1表示越相关
+brief string 调用入库add接口时添加的brief信息,为保证该结果有效性,请入库时填写可关联至本地图片库的有效id信息
has_more bool 是否还有下一页,返回值:true、false;如果不分页,不用关注该字段

绘本图片搜索—检索 返回示例

{
    "result_num": 1,
    "result": [
        {
            "score": 0.97976700290421,
            "brief": "./data/jay1.jpg",
            "cont_sign": "475124309,1080176642"
        }
    ],
	"has_more": "false",
    "log_id": 1968648150
}

绘本图片搜索—更新

更新图库中图片的摘要和分类信息(具体变量为brief、tags)

// 如果有可选参数
$options = array("brief"=> array("name"=>"周杰伦", "id"=>"6666"), "tags"=>"100,11")

// 带参数调用绘本图片搜索—更新, 图片参数为本地图片
$image = file_get_contents('example.jpg');
$client->pictureBookUpdate($image, $options)

// 调用绘本图片搜索—入库, 图片参数为远程url图片
$url = "http//www.x.com/sample.jpg";
$client->pictureBookUpdateUrl($url, $options);

// 带参数调用绘本图片搜索—更新, 图片参数为图片签名
$contSign = "8cnn32frvrr2cd901"
$client.pictureBookUpdateContSign($contSign, $options)

绘本图片搜索—更新 请求参数详情

参数 是否必选 类型 可选值范围 说明
image string - 图片数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,和url、cont_sign三选一,优先级:image > url > cont_sign,注意要去掉图片头部,如(data:image/jpg;base64,),最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式
url string - 图片URL,和image、cont_sign三选一,优先级:image > url > cont_sign ,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign string - 图片签名,和image、url三选一,优先级:image > url > cont_sign;不支持批量传入签名,样例:"932301884,10680062193"
brief string - 更新的摘要信息,最长256B。样例:{"name":"周杰伦", "id":"666"}
tags string 1 - 65535范围内的整数 更新的分类信息,tag间以逗号分隔,最多2个tag。样例:"100,11"

绘本图片搜索—更新 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位

绘本图片搜索—更新 返回示例

{
    "log_id": 2263663554
}

绘本图片搜索—删除

删除图库中的图片,支持批量删除,批量删除时请传cont_sign参数,勿传image、url,最多支持100个cont_sign。

图片删除延时生效,每天数据库定时更新进行物理删除,刚删除时仍然可以在图库中检索到(但图库管理后台是同步清除),请过一段时间再验证,一般最多延时4小时左右

// 如果有可选参数
$options = array("brief"=> array("name"=>"周杰伦", "id"=>"6666"), "tags"=>"100,11")

// 带参数调用绘本图片搜索—更新, 图片参数为本地图片
$image = file_get_contents('example.jpg');
$client->pictureBookDeleteByImage($image, $options)

// 调用绘本图片搜索—入库, 图片参数为远程url图片
$url = "http//www.x.com/sample.jpg";
$client->pictureBookDeleteByUrl($url, $options);

// 带参数调用绘本图片搜索—更新, 图片参数为图片签名
$contSign = "8cnn32frvrr2cd901"
$client.pictureBookDeleteBySign($contSign, $options)

绘本图片搜索—删除 请求参数详情

参数 是否必选 类型 可选值范围 说明
image string - 图片数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,(和url、cont_sign三选一,优先级:image > url > cont_sign),注意要去掉图片头部,如(data:image/jpg;base64,)。最短边至少150px,最长边最大4096px,长宽比在1:10-10:1之间。支持jpg/png/bmp格式
url string - 图片URL,和image、cont_sign三选一,image优先级更高,由于图床的差异性,抓图服务无法适配所有的图床,部分URL可能抓不到图,或者图片下载超时,遇到上述情况时请更换图片URL、或者将图片下载到本地转码后上传
cont_sign string - 图片签名(和image、url三选一),支持批量删除,批量删除时请勿传image、url,最多支持100个cont_sign列表,样例:"932301884,1068006219;316336521,553141152;2491030726,1352091083"

绘本图片搜索—删除 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位

绘本图片搜索—删除 返回示例

{
  "log_id": 50488417
}

面料图片搜索—入库

SDK 调用示例

$image = file_get_contents('example.jpg');
$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用面料图片搜索—入库, 图片参数为本地图片
$client->materielAdd($image, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用面料图片搜索—入库, 图片参数为本地图片
$client->materielAdd($image, $brief, $options);
$url = "http//www.x.com/sample.jpg";

$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

// 调用面料图片搜索—入库, 图片参数为远程url图片
$client->materielAddUrl($url, $brief);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";

// 带参数调用面料图片搜索—入库, 图片参数为远程url图片
$client->materielAddUrl($url, $brief, $options);

接口详情

可参考API文档:面料图片搜索—入库

面料图片搜索—检索

SDK 调用示例

$image = file_get_contents('example.jpg');

// 调用面料图片搜索检索, 图片参数为本地图片
$client->materielSearch($image);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用面料图片搜索—检索, 图片参数为本地图片
$client->materielSearch($image, $options);
$url = "http//www.x.com/sample.jpg";

// 调用面料图片搜索—检索, 图片参数为远程url图片
$client->materielSearchUrl($url);

// 如果有可选参数
$options = array();
$options["tags"] = "100,11";
$options["tag_logic"] = "0";
$options["pn"] = "100";
$options["rn"] = "250";

// 带参数调用面料图片搜索—检索, 图片参数为远程url图片
$client->materielSearchUrl($url, $options);

接口详情

可参考API文档:面料图片搜索—检索

面料图片搜索—更新

SDK 调用示例

    $image = file_get_contents('example.jpg');

	$brief = "{\"name\":\"周杰伦\", \"id\":\"666\"}";

    // 调用面料图片搜索—更新, 图片参数为本地图片
    $client->materielUpdate($image, $brief);

    // 如果有可选参数
    $options = array();  
    $options["tags"] = "100,11";

    // 带参数调用面料图片搜索—更新, 图片参数为本地图片
    $client->materielUpdate($image, $brief, $options);
    $url = "http//www.x.com/sample.jpg";

    // 调用面料图片搜索—更新, 图片参数为远程url图片
    $client->materielUpdateUrl($url, $brief);

    // 如果有可选参数
    $options = array();    
    $options["tags"] = "100,11";

    // 带参数调用面料图片搜索—更新, 图片参数为远程url图片
    $client->materielUpdateUrl($url, $brief, $options);
    
     // 带参数调用面料图片搜索—更新, 图片签名
    $cont_sign="g988312421";
    $client->materielUpdateContSign($cont_sign, $brief, $options);

接口详情

可参考API文档:面料图片搜索—更新

面料图片搜索—删除

SDK 调用示例

$image = file_get_contents('example.jpg');

// 调用删除面料图片,传入参数为图片
$client->materielDeleteByImage($image);
$url = "http//www.x.com/sample.jpg";

// 调用删除面料图片,图片参数为远程url图片
$client->materielDeleteByUrl($url);
$contSign = "8cnn32frvrr2cd901";

// 调用删除面料图片,传入参数为图片签名
$client->materielDeleteBySign($contSign);

接口详情

可参考API文档:面料图片搜索—删除

上一篇
快速入门
下一篇
错误信息