AipImageSearch (aip-java-sdk 4.4.1 API)

java.lang.Object
- com.baidu.aip.client.BaseClient
- - com.baidu.aip.imagesearch.AipImageSearch

public class AipImageSearch
extends BaseClient

字段概要
- 从类继承的字段 com.baidu.aip.client.BaseClient
  accessToken, aipKey, aipToken, appId, config, expireDate, isAuthorized, isBceKey, LOGGER, state

构造器概要

构造器
构造器和说明

AipImageSearch(String appId, String apiKey, String secretKey)

构造器
构造器和说明
`AipImageSearch(String appId, String apiKey, String secretKey)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`org.json.JSONObject`	`productAdd(byte[] image, HashMap<String,String> options)` 商品检索—入库接口该请求用于实时检索商品类型图片相同或相似的图片集合，适用于电商平台或商品展示等场景，即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建商品库中相同或相似的图片集合。
`org.json.JSONObject`	`productAdd(String image, HashMap<String,String> options)` 商品检索—入库接口该请求用于实时检索商品类型图片相同或相似的图片集合，适用于电商平台或商品展示等场景，即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建商品库中相同或相似的图片集合。
`org.json.JSONObject`	`productDeleteByImage(byte[] image, HashMap<String,String> options)` 商品检索—删除接口删除商品
`org.json.JSONObject`	`productDeleteByImage(String image, HashMap<String,String> options)` 商品检索—删除接口删除商品
`org.json.JSONObject`	`productDeleteBySign(String contSign, HashMap<String,String> options)` 商品检索—删除接口删除商品
`org.json.JSONObject`	`productSearch(byte[] image, HashMap<String,String> options)` 商品检索—检索接口完成入库后，可使用该接口实现商品检索。
`org.json.JSONObject`	`productSearch(String image, HashMap<String,String> options)` 商品检索—检索接口完成入库后，可使用该接口实现商品检索。
`org.json.JSONObject`	`sameHqAdd(byte[] image, HashMap<String,String> options)` 相同图检索—入库接口相同图检索包含入库、检索、删除三个子接口；在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。
`org.json.JSONObject`	`sameHqAdd(String image, HashMap<String,String> options)` 相同图检索—入库接口相同图检索包含入库、检索、删除三个子接口；在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。
`org.json.JSONObject`	`sameHqDeleteByImage(byte[] image, HashMap<String,String> options)` 相同图检索—删除接口删除相同图
`org.json.JSONObject`	`sameHqDeleteByImage(String image, HashMap<String,String> options)` 相同图检索—删除接口删除相同图
`org.json.JSONObject`	`sameHqDeleteBySign(String contSign, HashMap<String,String> options)` 相同图检索—删除接口删除相同图
`org.json.JSONObject`	`sameHqSearch(byte[] image, HashMap<String,String> options)` 相同图检索—检索接口相同图检索包含入库、检索、删除三个子接口；在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。
`org.json.JSONObject`	`sameHqSearch(String image, HashMap<String,String> options)` 相同图检索—检索接口相同图检索包含入库、检索、删除三个子接口；在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。
`org.json.JSONObject`	`similarAdd(byte[] image, HashMap<String,String> options)` 相似图检索—入库接口该请求用于实时检索相似图片集合。
`org.json.JSONObject`	`similarAdd(String image, HashMap<String,String> options)` 相似图检索—入库接口该请求用于实时检索相似图片集合。
`org.json.JSONObject`	`similarDeleteByImage(byte[] image, HashMap<String,String> options)` 相似图检索—删除接口删除相似图
`org.json.JSONObject`	`similarDeleteByImage(String image, HashMap<String,String> options)` 相似图检索—删除接口删除相似图
`org.json.JSONObject`	`similarDeleteBySign(String contSign, HashMap<String,String> options)` 相似图检索—删除接口删除相似图
`org.json.JSONObject`	`similarSearch(byte[] image, HashMap<String,String> options)` 相似图检索—检索接口相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。
`org.json.JSONObject`	`similarSearch(String image, HashMap<String,String> options)` 相似图检索—检索接口相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。

从类继承的方法 com.baidu.aip.client.BaseClient
getAccessToken, needAuth, postOperation, preOperation, requestServer, setConnectionTimeoutInMillis, setHttpProxy, setSocketProxy, setSocketTimeoutInMillis

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AipImageSearch
```
public AipImageSearch(String appId,
                      String apiKey,
                      String secretKey)
```
- 方法详细资料
  - sameHqAdd
```
public org.json.JSONObject sameHqAdd(byte[] image,
                                     HashMap<String,String> options)
```
    相同图检索—入库接口相同图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。 tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索
    
    返回:
    
    JSONObject
  - sameHqAdd
```
public org.json.JSONObject sameHqAdd(String image,
                                     HashMap<String,String> options)
```
    相同图检索—入库接口相同图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。 tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索
    
    返回:
    
    JSONObject
  - sameHqSearch
```
public org.json.JSONObject sameHqSearch(byte[] image,
                                        HashMap<String,String> options)
```
    相同图检索—检索接口相同图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索 tag_logic 检索时tag之间的逻辑， 0：逻辑and，1：逻辑or pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - sameHqSearch
```
public org.json.JSONObject sameHqSearch(String image,
                                        HashMap<String,String> options)
```
    相同图检索—检索接口相同图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索 tag_logic 检索时tag之间的逻辑， 0：逻辑and，1：逻辑or pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - sameHqDeleteByImage
```
public org.json.JSONObject sameHqDeleteByImage(byte[] image,
                                               HashMap<String,String> options)
```
    相同图检索—删除接口删除相同图
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - sameHqDeleteByImage
```
public org.json.JSONObject sameHqDeleteByImage(String image,
                                               HashMap<String,String> options)
```
    相同图检索—删除接口删除相同图
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - sameHqDeleteBySign
```
public org.json.JSONObject sameHqDeleteBySign(String contSign,
                                              HashMap<String,String> options)
```
    相同图检索—删除接口删除相同图
    
    参数:
    
    contSign - - 图片签名（和image二选一，image优先级更高）
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - similarAdd
```
public org.json.JSONObject similarAdd(byte[] image,
                                      HashMap<String,String> options)
```
    相似图检索—入库接口该请求用于实时检索相似图片集合。即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建图库中相似的图片集合。相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。**
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。 tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索
    
    返回:
    
    JSONObject
  - similarAdd
```
public org.json.JSONObject similarAdd(String image,
                                      HashMap<String,String> options)
```
    相似图检索—入库接口该请求用于实时检索相似图片集合。即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建图库中相似的图片集合。相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。**
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。 tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索
    
    返回:
    
    JSONObject
  - similarSearch
```
public org.json.JSONObject similarSearch(byte[] image,
                                         HashMap<String,String> options)
```
    相似图检索—检索接口相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。**
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索 tag_logic 检索时tag之间的逻辑， 0：逻辑and，1：逻辑or pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - similarSearch
```
public org.json.JSONObject similarSearch(String image,
                                         HashMap<String,String> options)
```
    相似图检索—检索接口相似图检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口。**
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: tags 1 - 65535范围内的整数，tag间以逗号分隔，最多2个tag。样例："100,11" ；检索时可圈定分类维度进行检索 tag_logic 检索时tag之间的逻辑， 0：逻辑and，1：逻辑or pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - similarDeleteByImage
```
public org.json.JSONObject similarDeleteByImage(byte[] image,
                                                HashMap<String,String> options)
```
    相似图检索—删除接口删除相似图
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - similarDeleteByImage
```
public org.json.JSONObject similarDeleteByImage(String image,
                                                HashMap<String,String> options)
```
    相似图检索—删除接口删除相似图
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - similarDeleteBySign
```
public org.json.JSONObject similarDeleteBySign(String contSign,
                                               HashMap<String,String> options)
```
    相似图检索—删除接口删除相似图
    
    参数:
    
    contSign - - 图片签名（和image二选一，image优先级更高）
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - productAdd
```
public org.json.JSONObject productAdd(byte[] image,
                                      HashMap<String,String> options)
```
    商品检索—入库接口该请求用于实时检索商品类型图片相同或相似的图片集合，适用于电商平台或商品展示等场景，即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建商品库中相同或相似的图片集合。商品检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，所以调用该入库接口时，brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息** class_id1 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 class_id2 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索
    
    返回:
    
    JSONObject
  - productAdd
```
public org.json.JSONObject productAdd(String image,
                                      HashMap<String,String> options)
```
    商品检索—入库接口该请求用于实时检索商品类型图片相同或相似的图片集合，适用于电商平台或商品展示等场景，即对于输入的一张图片（可正常解码，且长宽比适宜），返回自建商品库中相同或相似的图片集合。商品检索包含入库、检索、删除三个子接口；**在正式使用之前请在[控制台](https://console.bce.baidu.com/ai/#/ai/imagesearch/overview/index)创建应用后，在应用详情页申请建库，建库成功后方可正常使用入库、检索、删除三个接口**。
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: brief 检索时原样带回,最长256B。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，所以调用该入库接口时，brief信息请尽量填写可关联至本地图库的图片id或者图片url、图片名称等信息** class_id1 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 class_id2 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索
    
    返回:
    
    JSONObject
  - productSearch
```
public org.json.JSONObject productSearch(byte[] image,
                                         HashMap<String,String> options)
```
    商品检索—检索接口完成入库后，可使用该接口实现商品检索。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息**
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: class_id1 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 class_id2 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - productSearch
```
public org.json.JSONObject productSearch(String image,
                                         HashMap<String,String> options)
```
    商品检索—检索接口完成入库后，可使用该接口实现商品检索。**请注意，检索接口不返回原图，仅反馈当前填写的brief信息，请调用入库接口时尽量填写可关联至本地图库的图片id或者图片url等信息**
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表: class_id1 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 class_id2 商品分类维度1，支持1-60范围内的整数。检索时可圈定该分类维度进行检索 pn 分页功能，起始位置，例：0。未指定分页时，默认返回前300个结果；接口返回数量最大限制1000条，例如：起始位置为900，截取条数500条，接口也只返回第900 - 1000条的结果，共计100条 rn 分页功能，截取条数，例：250
    
    返回:
    
    JSONObject
  - productDeleteByImage
```
public org.json.JSONObject productDeleteByImage(byte[] image,
                                                HashMap<String,String> options)
```
    商品检索—删除接口删除商品
    
    参数:
    
    image - - 二进制图像数据
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - productDeleteByImage
```
public org.json.JSONObject productDeleteByImage(String image,
                                                HashMap<String,String> options)
```
    商品检索—删除接口删除商品
    
    参数:
    
    image - - 本地图片路径
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject
  - productDeleteBySign
```
public org.json.JSONObject productDeleteBySign(String contSign,
                                               HashMap<String,String> options)
```
    商品检索—删除接口删除商品
    
    参数:
    
    contSign - - 图片签名（和image二选一，image优先级更高）
    
    options - - 可选参数对象，key: value都为string类型 options - options列表:
    
    返回:
    
    JSONObject

类 AipImageSearch

字段概要

从类继承的字段 com.baidu.aip.client.BaseClient

构造器概要

方法概要

从类继承的方法 com.baidu.aip.client.BaseClient

从类继承的方法 java.lang.Object

构造器详细资料

AipImageSearch

方法详细资料

sameHqAdd

sameHqAdd

sameHqSearch

sameHqSearch

sameHqDeleteByImage

sameHqDeleteByImage

sameHqDeleteBySign

similarAdd

similarAdd

similarSearch

similarSearch

similarDeleteByImage

similarDeleteByImage

similarDeleteBySign

productAdd

productAdd

productSearch

productSearch

productDeleteByImage

productDeleteByImage

productDeleteBySign