ChatCompletionsResponse (tencentcloud-sdk-java 3.1.1192 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.common.SSEResponseModel
  - - com.tencentcloudapi.hunyuan.v20230901.models.ChatCompletionsResponse

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<SSEResponseModel.SSE>
```
public class ChatCompletionsResponse
extends SSEResponseModel
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.tencentcloudapi.common.SSEResponseModel
  SSEResponseModel.SSE

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

Constructor Summary

Constructors
Constructor and Description
`ChatCompletionsResponse()`
`ChatCompletionsResponse(ChatCompletionsResponse 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 Deprecated Methods
Modifier and Type	Method and Description
`Choice[]`	`getChoices()` Get 回复内容。
`Long`	`getCreated()` Get Unix 时间戳，单位为秒。
`ErrorMsg`	`getErrorMsg()` Get 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
`String`	`getId()` Get 本次请求的 RequestId。
`String`	`getModerationLevel()` Deprecated.
`String`	`getNote()` Get 免责声明。
`String[]`	`getRecommendedQuestions()` Get 推荐问答。
`Replace[]`	`getReplaces()` Get 多媒体信息。说明： 1.
`String`	`getRequestId()` Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
`SearchInfo`	`getSearchInfo()` Get 搜索结果信息
`Usage`	`getUsage()` Get Token 统计信息。按照总 Token 数量计费。
`void`	`setChoices(Choice[] Choices)` Set 回复内容。
`void`	`setCreated(Long Created)` Set Unix 时间戳，单位为秒。
`void`	`setErrorMsg(ErrorMsg ErrorMsg)` Set 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
`void`	`setId(String Id)` Set 本次请求的 RequestId。
`void`	`setModerationLevel(String ModerationLevel)` Deprecated.
`void`	`setNote(String Note)` Set 免责声明。
`void`	`setRecommendedQuestions(String[] RecommendedQuestions)` Set 推荐问答。
`void`	`setReplaces(Replace[] Replaces)` Set 多媒体信息。说明： 1.
`void`	`setRequestId(String RequestId)` Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
`void`	`setSearchInfo(SearchInfo SearchInfo)` Set 搜索结果信息
`void`	`setUsage(Usage Usage)` Set Token 统计信息。按照总 Token 数量计费。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.SSEResponseModel
close, isStream, iterator, setResponse, setToken

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, 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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - ChatCompletionsResponse
```
public ChatCompletionsResponse()
```
  - ChatCompletionsResponse
```
public ChatCompletionsResponse(ChatCompletionsResponse 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
  - getCreated
```
public Long getCreated()
```
    Get Unix 时间戳，单位为秒。
    
    Returns:
    
    Created Unix 时间戳，单位为秒。
  - setCreated
```
public void setCreated(Long Created)
```
    Set Unix 时间戳，单位为秒。
    
    Parameters:
    
    Created - Unix 时间戳，单位为秒。
  - getUsage
```
public Usage getUsage()
```
    Get Token 统计信息。按照总 Token 数量计费。
    
    Returns:
    
    Usage Token 统计信息。按照总 Token 数量计费。
  - setUsage
```
public void setUsage(Usage Usage)
```
    Set Token 统计信息。按照总 Token 数量计费。
    
    Parameters:
    
    Usage - Token 统计信息。按照总 Token 数量计费。
  - getNote
```
public String getNote()
```
    Get 免责声明。
    
    Returns:
    
    Note 免责声明。
  - setNote
```
public void setNote(String Note)
```
    Set 免责声明。
    
    Parameters:
    
    Note - 免责声明。
  - getId
```
public String getId()
```
    Get 本次请求的 RequestId。
    
    Returns:
    
    Id 本次请求的 RequestId。
  - setId
```
public void setId(String Id)
```
    Set 本次请求的 RequestId。
    
    Parameters:
    
    Id - 本次请求的 RequestId。
  - getChoices
```
public Choice[] getChoices()
```
    Get 回复内容。
    
    Returns:
    
    Choices 回复内容。
  - setChoices
```
public void setChoices(Choice[] Choices)
```
    Set 回复内容。
    
    Parameters:
    
    Choices - 回复内容。
  - getErrorMsg
```
public ErrorMsg getErrorMsg()
```
    Get 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
    
    Returns:
    
    ErrorMsg 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
  - setErrorMsg
```
public void setErrorMsg(ErrorMsg ErrorMsg)
```
    Set 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
    
    Parameters:
    
    ErrorMsg - 错误信息。如果流式返回中服务处理异常，返回该错误信息。注意：此字段可能返回 null，表示取不到有效值。
  - getModerationLevel
```
@Deprecated
public String getModerationLevel()
```
    Deprecated.
    
    Get 多轮会话风险审核，值为1时，表明存在信息安全风险，建议终止客户多轮会话。
    
    Returns:
    
    ModerationLevel 多轮会话风险审核，值为1时，表明存在信息安全风险，建议终止客户多轮会话。
  - setModerationLevel
```
@Deprecated
public void setModerationLevel(String ModerationLevel)
```
    Deprecated.
    
    Set 多轮会话风险审核，值为1时，表明存在信息安全风险，建议终止客户多轮会话。
    
    Parameters:
    
    ModerationLevel - 多轮会话风险审核，值为1时，表明存在信息安全风险，建议终止客户多轮会话。
  - getSearchInfo
```
public SearchInfo getSearchInfo()
```
    Get 搜索结果信息
    
    Returns:
    
    SearchInfo 搜索结果信息
  - setSearchInfo
```
public void setSearchInfo(SearchInfo SearchInfo)
```
    Set 搜索结果信息
    
    Parameters:
    
    SearchInfo - 搜索结果信息
  - getReplaces
```
public Replace[] getReplaces()
```
    Get 多媒体信息。说明： 1. 可以用多媒体信息替换回复内容里的占位符，得到完整的消息。 2. 可能会出现回复内容里存在占位符，但是因为审核等原因没有返回多媒体信息。
    
    Returns:
    
    Replaces 多媒体信息。说明： 1. 可以用多媒体信息替换回复内容里的占位符，得到完整的消息。 2. 可能会出现回复内容里存在占位符，但是因为审核等原因没有返回多媒体信息。
  - setReplaces
```
public void setReplaces(Replace[] Replaces)
```
    Set 多媒体信息。说明： 1. 可以用多媒体信息替换回复内容里的占位符，得到完整的消息。 2. 可能会出现回复内容里存在占位符，但是因为审核等原因没有返回多媒体信息。
    
    Parameters:
    
    Replaces - 多媒体信息。说明： 1. 可以用多媒体信息替换回复内容里的占位符，得到完整的消息。 2. 可能会出现回复内容里存在占位符，但是因为审核等原因没有返回多媒体信息。
  - getRecommendedQuestions
```
public String[] getRecommendedQuestions()
```
    Get 推荐问答。
    
    Returns:
    
    RecommendedQuestions 推荐问答。
  - setRecommendedQuestions
```
public void setRecommendedQuestions(String[] RecommendedQuestions)
```
    Set 推荐问答。
    
    Parameters:
    
    RecommendedQuestions - 推荐问答。
  - getRequestId
```
public String getRequestId()
```
    Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
    
    Specified by:
    
    getRequestId in class SSEResponseModel
    
    Returns:
    
    RequestId 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
  - setRequestId
```
public void setRequestId(String RequestId)
```
    Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
    
    Specified by:
    
    setRequestId in class SSEResponseModel
    
    Parameters:
    
    RequestId - 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Overrides:
    
    toMap in class SSEResponseModel

Class ChatCompletionsResponse

Nested Class Summary

Nested classes/interfaces inherited from class com.tencentcloudapi.common.SSEResponseModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.SSEResponseModel

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

ChatCompletionsResponse

ChatCompletionsResponse

Method Detail

getCreated

setCreated

getUsage

setUsage

getNote

setNote

getId

setId

getChoices

setChoices

getErrorMsg

setErrorMsg

getModerationLevel

setModerationLevel

getSearchInfo

setSearchInfo

getReplaces

setReplaces

getRecommendedQuestions

setRecommendedQuestions

getRequestId

setRequestId

toMap