InvokeAISearchServiceRequest (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.iotexplorer.v20190423.models.InvokeAISearchServiceRequest

public class InvokeAISearchServiceRequest
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`InvokeAISearchServiceRequest()`
`InvokeAISearchServiceRequest(InvokeAISearchServiceRequest 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`	`getChannelId()` Get 通道ID
`String`	`getDeviceName()` Get 设备名称
`Boolean`	`getEnableSummary()` Get 是否需要返回总结，默认为True；开启后会加大接口响应时长
`Long`	`getEndTimeMs()` Get 结束时间。注： 1.
`Long`	`getLimit()` Get 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
`String`	`getProductId()` Get 产品ID
`String`	`getQuery()` Get 自然语言查询
`Long`	`getSearchMode()` Get 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
`Long`	`getStartTimeMs()` Get 开始时间。注： 1.
`String`	`getSummaryLang()` Get 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
`String`	`getTimeZone()` Get 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
`Float`	`getVectorSearchRadius()` Get 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
`Long`	`getVectorSearchTopK()` Get 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
`void`	`setChannelId(Long ChannelId)` Set 通道ID
`void`	`setDeviceName(String DeviceName)` Set 设备名称
`void`	`setEnableSummary(Boolean EnableSummary)` Set 是否需要返回总结，默认为True；开启后会加大接口响应时长
`void`	`setEndTimeMs(Long EndTimeMs)` Set 结束时间。注： 1.
`void`	`setLimit(Long Limit)` Set 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
`void`	`setProductId(String ProductId)` Set 产品ID
`void`	`setQuery(String Query)` Set 自然语言查询
`void`	`setSearchMode(Long SearchMode)` Set 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
`void`	`setStartTimeMs(Long StartTimeMs)` Set 开始时间。注： 1.
`void`	`setSummaryLang(String SummaryLang)` Set 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
`void`	`setTimeZone(String TimeZone)` Set 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
`void`	`setVectorSearchRadius(Float VectorSearchRadius)` Set 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
`void`	`setVectorSearchTopK(Long VectorSearchTopK)` Set 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
`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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

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

- Constructor Detail
  - InvokeAISearchServiceRequest
```
public InvokeAISearchServiceRequest()
```
  - InvokeAISearchServiceRequest
```
public InvokeAISearchServiceRequest(InvokeAISearchServiceRequest 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
  - getProductId
```
public String getProductId()
```
    Get 产品ID
    
    Returns:
    
    ProductId 产品ID
  - setProductId
```
public void setProductId(String ProductId)
```
    Set 产品ID
    
    Parameters:
    
    ProductId - 产品ID
  - getDeviceName
```
public String getDeviceName()
```
    Get 设备名称
    
    Returns:
    
    DeviceName 设备名称
  - setDeviceName
```
public void setDeviceName(String DeviceName)
```
    Set 设备名称
    
    Parameters:
    
    DeviceName - 设备名称
  - getQuery
```
public String getQuery()
```
    Get 自然语言查询
    
    Returns:
    
    Query 自然语言查询
  - setQuery
```
public void setQuery(String Query)
```
    Set 自然语言查询
    
    Parameters:
    
    Query - 自然语言查询
  - getSummaryLang
```
public String getSummaryLang()
```
    Get 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
    
    Returns:
    
    SummaryLang 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
  - setSummaryLang
```
public void setSummaryLang(String SummaryLang)
```
    Set 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
    
    Parameters:
    
    SummaryLang - 搜索结果总结的语言类型，支持的类型有：en-US、zh-CN、id-ID、th-TH
  - getChannelId
```
public Long getChannelId()
```
    Get 通道ID
    
    Returns:
    
    ChannelId 通道ID
  - setChannelId
```
public void setChannelId(Long ChannelId)
```
    Set 通道ID
    
    Parameters:
    
    ChannelId - 通道ID
  - getEnableSummary
```
public Boolean getEnableSummary()
```
    Get 是否需要返回总结，默认为True；开启后会加大接口响应时长
    
    Returns:
    
    EnableSummary 是否需要返回总结，默认为True；开启后会加大接口响应时长
  - setEnableSummary
```
public void setEnableSummary(Boolean EnableSummary)
```
    Set 是否需要返回总结，默认为True；开启后会加大接口响应时长
    
    Parameters:
    
    EnableSummary - 是否需要返回总结，默认为True；开启后会加大接口响应时长
  - getStartTimeMs
```
public Long getStartTimeMs()
```
    Get 开始时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
    
    Returns:
    
    StartTimeMs 开始时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
  - setStartTimeMs
```
public void setStartTimeMs(Long StartTimeMs)
```
    Set 开始时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
    
    Parameters:
    
    StartTimeMs - 开始时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
  - getEndTimeMs
```
public Long getEndTimeMs()
```
    Get 结束时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
    
    Returns:
    
    EndTimeMs 结束时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
  - setEndTimeMs
```
public void setEndTimeMs(Long EndTimeMs)
```
    Set 结束时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
    
    Parameters:
    
    EndTimeMs - 结束时间。注： 1. 单位为毫秒（ms） 2. 如果同时指定了StartTimeMs与EndTimeMs，时间区间不能大于7天；如果只指定其中一个（例如只指定StartTimeMs，则查询自StartTimeMs后1天内的数据，反之EndTimeMs也一样） 3. 只要指定了其中一个参数，接口则会忽略Query参数中关于时间的描述；（例如Query为"过去三天关于猫咪的视频"，则会将"过去三天忽略"）
  - getTimeZone
```
public String getTimeZone()
```
    Get 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
    
    Returns:
    
    TimeZone 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
  - setTimeZone
```
public void setTimeZone(String TimeZone)
```
    Set 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
    
    Parameters:
    
    TimeZone - 时区。默认值：Asia/Shanghai 注：符合iana标准 https://www.iana.org/time-zones，例如Asia/Shanghai、Asia/Bangkok
  - getSearchMode
```
public Long getSearchMode()
```
    Get 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
    
    Returns:
    
    SearchMode 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
  - setSearchMode
```
public void setSearchMode(Long SearchMode)
```
    Set 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
    
    Parameters:
    
    SearchMode - 取值为1表示高级搜索，取值为2表示简单搜索，默认为1
  - getLimit
```
public Long getLimit()
```
    Get 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
    
    Returns:
    
    Limit 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
  - setLimit
```
public void setLimit(Long Limit)
```
    Set 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
    
    Parameters:
    
    Limit - 最终输出的条数；仅当SearchMode为2时支持自定义设置，默认为50
  - getVectorSearchRadius
```
public Float getVectorSearchRadius()
```
    Get 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
    
    Returns:
    
    VectorSearchRadius 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
  - setVectorSearchRadius
```
public void setVectorSearchRadius(Float VectorSearchRadius)
```
    Set 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
    
    Parameters:
    
    VectorSearchRadius - 向量搜索的相似度搜索半径，取值范围[-1, 1]；仅当SearchMode为2时支持自定义设置，默认为0.5
  - getVectorSearchTopK
```
public Long getVectorSearchTopK()
```
    Get 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
    
    Returns:
    
    VectorSearchTopK 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
  - setVectorSearchTopK
```
public void setVectorSearchTopK(Long VectorSearchTopK)
```
    Set 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
    
    Parameters:
    
    VectorSearchTopK - 指定向量搜索最相似的 Top K；仅当SearchMode为2时支持自定义设置，默认为100
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class InvokeAISearchServiceRequest

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

InvokeAISearchServiceRequest

InvokeAISearchServiceRequest

Method Detail

getProductId

setProductId

getDeviceName

setDeviceName

getQuery

setQuery

getSummaryLang

setSummaryLang

getChannelId

setChannelId

getEnableSummary

setEnableSummary

getStartTimeMs

setStartTimeMs

getEndTimeMs

setEndTimeMs

getTimeZone

setTimeZone

getSearchMode

setSearchMode

getLimit

setLimit

getVectorSearchRadius

setVectorSearchRadius

getVectorSearchTopK

setVectorSearchTopK

toMap