com.tencentcloudapi.es.v20250101.models

Class ChatCompletionsResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.common.SSEResponseModel

com.tencentcloudapi.es.v20250101.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

Modifier and Type	Method and Description
Choice[]	getChoices() Get 回复内容
String	getId() Get 此次请求的id
WebContent[]	getOnlineSearchContent() Get 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。
String	getRequestId() Get 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
TokenUsage	getUsage() Get token使用量
void	setChoices(Choice[] Choices) Set 回复内容
void	setId(String Id) Set 此次请求的id
void	setOnlineSearchContent(WebContent[] OnlineSearchContent) Set 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。
void	setRequestId(String RequestId) Set 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
void	setUsage(TokenUsage Usage) Set 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

getId

public String getId()

Get 此次请求的id

Returns:

Id 此次请求的id

setId

public void setId(String Id)

Set 此次请求的id

Parameters:

Id - 此次请求的id

getChoices

public Choice[] getChoices()

Get 回复内容

Returns:

Choices 回复内容

setChoices

public void setChoices(Choice[] Choices)

Set 回复内容

Parameters:

Choices - 回复内容

getUsage

public TokenUsage getUsage()

Get token使用量

Returns:

Usage token使用量

setUsage

public void setUsage(TokenUsage Usage)

Set token使用量

Parameters:

Usage - token使用量

getOnlineSearchContent

public WebContent[] getOnlineSearchContent()

Get 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

OnlineSearchContent 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。

setOnlineSearchContent

public void setOnlineSearchContent(WebContent[] OnlineSearchContent)

Set 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

OnlineSearchContent - 联网搜索结果。 注意：此字段可能返回 null，表示取不到有效值。

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

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.