SearchImageRequest (tencentcloud-sdk-java 3.1.566 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.tiia.v20190529.models.SearchImageRequest

public class SearchImageRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`SearchImageRequest()`
`SearchImageRequest(SearchImageRequest source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getCategoryId()` Get 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
`Boolean`	`getEnableDetect()` Get 是否需要启用主体识别，默认为TRUE 。 1.
`String`	`getFilter()` Get 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
`String`	`getGroupId()` Get 图库名称。
`String`	`getImageBase64()` Get 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\2000，图片长宽比小于10（长/短 < 10）。
`ImageRect`	`getImageRect()` Get 图像主体区域。若设置主体区域，提取指定的区域进行检索。
`String`	`getImageUrl()` Get 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\2000，图片长宽比小于10（长/短 < 10）。
`Long`	`getLimit()` Get 返回数量，默认值为10，最大值为100。
`Long`	`getMatchThreshold()` Get 出参Score中，只有超过MatchThreshold值的结果才会返回。默认为0
`Long`	`getOffset()` Get 起始序号，默认值为0。
`void`	`setCategoryId(Long CategoryId)` Set 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
`void`	`setEnableDetect(Boolean EnableDetect)` Set 是否需要启用主体识别，默认为TRUE 。 1.
`void`	`setFilter(String Filter)` Set 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
`void`	`setGroupId(String GroupId)` Set 图库名称。
`void`	`setImageBase64(String ImageBase64)` Set 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\2000，图片长宽比小于10（长/短 < 10）。
`void`	`setImageRect(ImageRect ImageRect)` Set 图像主体区域。若设置主体区域，提取指定的区域进行检索。
`void`	`setImageUrl(String ImageUrl)` Set 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\2000，图片长宽比小于10（长/短 < 10）。
`void`	`setLimit(Long Limit)` Set 返回数量，默认值为10，最大值为100。
`void`	`setMatchThreshold(Long MatchThreshold)` Set 出参Score中，只有超过MatchThreshold值的结果才会返回。默认为0
`void`	`setOffset(Long Offset)` Set 起始序号，默认值为0。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SearchImageRequest
```
public SearchImageRequest()
```
  - SearchImageRequest
```
public SearchImageRequest(SearchImageRequest source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getGroupId
```
public String getGroupId()
```
    Get 图库名称。
    
    Returns:
    
    GroupId 图库名称。
  - setGroupId
```
public void setGroupId(String GroupId)
```
    Set 图库名称。
    
    Parameters:
    
    GroupId - 图库名称。
  - getImageUrl
```
public String getImageUrl()
```
    Get 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\*4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
    
    Returns:
    
    ImageUrl 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\*4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
  - setImageUrl
```
public void setImageUrl(String ImageUrl)
```
    Set 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\*4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
    
    Parameters:
    
    ImageUrl - 图片的 Url 。对应图片 base64 编码后大小不可超过5M。图片分辨率不超4096\*4096。 Url、Image必须提供一个，如果都提供，只使用 Url。图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
  - getImageBase64
```
public String getImageBase64()
```
    Get 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
    
    Returns:
    
    ImageBase64 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
  - setImageBase64
```
public void setImageBase64(String ImageBase64)
```
    Set 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
    
    Parameters:
    
    ImageBase64 - 图片 base64 数据，base64 编码后大小不可超过5M。图片分辨率不超过4096\*4096。支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。注意：开启主体识别分辨率不超过2000\*2000，图片长宽比小于10（长/短 < 10）。
  - getLimit
```
public Long getLimit()
```
    Get 返回数量，默认值为10，最大值为100。
    
    Returns:
    
    Limit 返回数量，默认值为10，最大值为100。
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 返回数量，默认值为10，最大值为100。
    
    Parameters:
    
    Limit - 返回数量，默认值为10，最大值为100。
  - getOffset
```
public Long getOffset()
```
    Get 起始序号，默认值为0。
    
    Returns:
    
    Offset 起始序号，默认值为0。
  - setOffset
```
public void setOffset(Long Offset)
```
    Set 起始序号，默认值为0。
    
    Parameters:
    
    Offset - 起始序号，默认值为0。
  - getMatchThreshold
```
public Long getMatchThreshold()
```
    Get 出参Score中，只有超过**MatchThreshold**值的结果才会返回。默认为0
    
    Returns:
    
    MatchThreshold 出参Score中，只有超过**MatchThreshold**值的结果才会返回。默认为0
  - setMatchThreshold
```
public void setMatchThreshold(Long MatchThreshold)
```
    Set 出参Score中，只有超过**MatchThreshold**值的结果才会返回。默认为0
    
    Parameters:
    
    MatchThreshold - 出参Score中，只有超过**MatchThreshold**值的结果才会返回。默认为0
  - getFilter
```
public String getFilter()
```
    Get 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
    
    Returns:
    
    Filter 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
  - setFilter
```
public void setFilter(String Filter)
```
    Set 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
    
    Parameters:
    
    Filter - 针对入库时提交的Tags信息进行条件过滤。支持>、>=、 <、 <=、=，!=，多个条件之间支持AND和OR进行连接。
  - getImageRect
```
public ImageRect getImageRect()
```
    Get 图像主体区域。若设置主体区域，提取指定的区域进行检索。
    
    Returns:
    
    ImageRect 图像主体区域。若设置主体区域，提取指定的区域进行检索。
  - setImageRect
```
public void setImageRect(ImageRect ImageRect)
```
    Set 图像主体区域。若设置主体区域，提取指定的区域进行检索。
    
    Parameters:
    
    ImageRect - 图像主体区域。若设置主体区域，提取指定的区域进行检索。
  - getEnableDetect
```
public Boolean getEnableDetect()
```
    Get 是否需要启用主体识别，默认为**TRUE** 。 1. 为**TRUE**时，启用主体识别，返回主体信息。若没有指定**ImageRect**，自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。 2. 为**FALSE**时，不启用主体识别，不返回主体信息。若没有指定**ImageRect**，以整张图检索图片。注意：服务类型为商品图像搜索时生效。
    
    Returns:
    
    EnableDetect 是否需要启用主体识别，默认为**TRUE** 。 1. 为**TRUE**时，启用主体识别，返回主体信息。若没有指定**ImageRect**，自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。 2. 为**FALSE**时，不启用主体识别，不返回主体信息。若没有指定**ImageRect**，以整张图检索图片。注意：服务类型为商品图像搜索时生效。
  - setEnableDetect
```
public void setEnableDetect(Boolean EnableDetect)
```
    Set 是否需要启用主体识别，默认为**TRUE** 。 1. 为**TRUE**时，启用主体识别，返回主体信息。若没有指定**ImageRect**，自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。 2. 为**FALSE**时，不启用主体识别，不返回主体信息。若没有指定**ImageRect**，以整张图检索图片。注意：服务类型为商品图像搜索时生效。
    
    Parameters:
    
    EnableDetect - 是否需要启用主体识别，默认为**TRUE** 。 1. 为**TRUE**时，启用主体识别，返回主体信息。若没有指定**ImageRect**，自动提取最大面积主体进行检索并进行主体识别。主体识别结果可在**Response中**获取。 2. 为**FALSE**时，不启用主体识别，不返回主体信息。若没有指定**ImageRect**，以整张图检索图片。注意：服务类型为商品图像搜索时生效。
  - getCategoryId
```
public Long getCategoryId()
```
    Get 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
    
    Returns:
    
    CategoryId 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
  - setCategoryId
```
public void setCategoryId(Long CategoryId)
```
    Set 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
    
    Parameters:
    
    CategoryId - 图像类目ID。若设置类目ID，提取对应类目的主体进行检索。注意：服务类型为商品图像搜索时生效。类目信息： 0：上衣。 1：裙装。 2：下装。 3：包。 4：鞋。 5：配饰。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class SearchImageRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

SearchImageRequest

SearchImageRequest

Method Detail

getGroupId

setGroupId

getImageUrl

setImageUrl

getImageBase64

setImageBase64

getLimit

setLimit

getOffset

setOffset

getMatchThreshold

setMatchThreshold

getFilter

setFilter

getImageRect

setImageRect

getEnableDetect

setEnableDetect

getCategoryId

setCategoryId

toMap