com.tencentcloudapi.trtc.v20190722.models

Class StartAIConversationRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.StartAIConversationRequest

public class StartAIConversationRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartAIConversationRequest()
StartAIConversationRequest(StartAIConversationRequest 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
AgentConfig	getAgentConfig() Get Robot parameters
String	getLLMConfig() Get LLM configuration.
String	getRoomId() Get TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.
Long	getRoomIdType() Get The type of TRTC room number.
Long	getSdkAppId() Get TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.
String	getSessionId() Get The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.
STTConfig	getSTTConfig() Get Speech recognition configuration.
String	getTTSConfig() Get TTS configuration, which is a JSON string.
void	setAgentConfig(AgentConfig AgentConfig) Set Robot parameters
void	setLLMConfig(String LLMConfig) Set LLM configuration.
void	setRoomId(String RoomId) Set TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.
void	setRoomIdType(Long RoomIdType) Set The type of TRTC room number.
void	setSdkAppId(Long SdkAppId) Set TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.
void	setSessionId(String SessionId) Set The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.
void	setSTTConfig(STTConfig STTConfig) Set Speech recognition configuration.
void	setTTSConfig(String TTSConfig) Set TTS configuration, which is a JSON string.
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

StartAIConversationRequest

public StartAIConversationRequest()

StartAIConversationRequest

public StartAIConversationRequest(StartAIConversationRequest 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

getSdkAppId

public Long getSdkAppId()

Get TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.

Returns:

SdkAppId TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.

Parameters:

SdkAppId - TRTC's [SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid) is the same as the SdkAppId used by the room that starts the conversation task.

getRoomId

public String getRoomId()

Get TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.

Returns:

RoomId TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.

setRoomId

public void setRoomId(String RoomId)

Set TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.

Parameters:

RoomId - TRTC's [RoomId](https://cloud.tencent.com/document/product/647/46351#roomid), which indicates the room number where the conversation task is started.

getAgentConfig

public AgentConfig getAgentConfig()

Get Robot parameters

Returns:

AgentConfig Robot parameters

setAgentConfig

public void setAgentConfig(AgentConfig AgentConfig)

Set Robot parameters

Parameters:

AgentConfig - Robot parameters

getSessionId

public String getSessionId()

Get The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.

Returns:

SessionId The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.

setSessionId

public void setSessionId(String SessionId)

Set The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.

Parameters:

SessionId - The unique ID passed in by the caller can be used by the client to prevent repeated task initiation and to query the task status through this field.

getRoomIdType

public Long getRoomIdType()

Get The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.

Returns:

RoomIdType The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.

setRoomIdType

public void setRoomIdType(Long RoomIdType)

Set The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.

Parameters:

RoomIdType - The type of TRTC room number. 0 represents a numeric room number, and 1 represents a string room number. If not filled in, the default is a numeric room number.

getSTTConfig

public STTConfig getSTTConfig()

Get Speech recognition configuration.

Returns:

STTConfig Speech recognition configuration.

setSTTConfig

public void setSTTConfig(STTConfig STTConfig)

Set Speech recognition configuration.

Parameters:

STTConfig - Speech recognition configuration.

getLLMConfig

public String getLLMConfig()

Get LLM configuration. It must comply with the openai specification and be a JSON string. The example is as follows:

 { 
   "LLMType": "Large model type", // String required, such as: "openai" 
   "Model": "Your model name", // String required, specify the model to be used
 "APIKey": "Your LLM API key", // String required 
   "APIUrl": "https://api.xxx.com/chat/completions", // String required, URL for LLM API access
   "Streaming": true // Boolean optional, specify whether to use streaming
  } 

Returns:

LLMConfig LLM configuration. It must comply with the openai specification and be a JSON string. The example is as follows:

 { 
   "LLMType": "Large model type", // String required, such as: "openai" 
   "Model": "Your model name", // String required, specify the model to be used
 "APIKey": "Your LLM API key", // String required 
   "APIUrl": "https://api.xxx.com/chat/completions", // String required, URL for LLM API access
   "Streaming": true // Boolean optional, specify whether to use streaming
  } 

setLLMConfig

public void setLLMConfig(String LLMConfig)

Set LLM configuration. It must comply with the openai specification and be a JSON string. The example is as follows:

 { 
   "LLMType": "Large model type", // String required, such as: "openai" 
   "Model": "Your model name", // String required, specify the model to be used
 "APIKey": "Your LLM API key", // String required 
   "APIUrl": "https://api.xxx.com/chat/completions", // String required, URL for LLM API access
   "Streaming": true // Boolean optional, specify whether to use streaming
  } 

Parameters:

LLMConfig - LLM configuration. It must comply with the openai specification and be a JSON string. The example is as follows:

 { 
   "LLMType": "Large model type", // String required, such as: "openai" 
   "Model": "Your model name", // String required, specify the model to be used
 "APIKey": "Your LLM API key", // String required 
   "APIUrl": "https://api.xxx.com/chat/completions", // String required, URL for LLM API access
   "Streaming": true // Boolean optional, specify whether to use streaming
  } 

getTTSConfig

public String getTTSConfig()

Get TTS configuration, which is a JSON string. The Tencent Cloud TTS example is as follows:

{ 
   "AppId": your application ID, // Integer Required
   "TTSType": "TTS type", // String TTS type, fixed to "tencent"
   "SecretId": "Your key ID", // String Required
   "SecretKey": "Your keyKey", // String Required
   "VoiceType": 101001, // Integer Required, voice ID, including standard voice and premium voice. Premium voice has higher fidelity and different price from standard voice. For details, please refer to Overview of Speech Synthesis Billing. For a complete list of timbre IDs, see List of speech synthesis timbre IDs. 
   "Speed": 1.25, // Integer Optional, speaking speed, range: [-2, 6], corresponding to different speaking speeds: -2: 0.6 times -1: 0.8 times 0: 1.0 times (default) 1: 1.2 times 2: 1.5 times 6: 2.5 times If a more detailed speaking speed is required, 2 decimal places can be retained, such as 0.5/1.25/2.81, etc. For the conversion between parameter value and actual speech speed, please refer to Speed Conversion
   "Volume": 5, // Integer Optional, volume size, range: [0, 10], corresponding to 11 levels of volume, the default value is 0, representing normal volume. 
   "PrimaryLanguage": "zh-CN" // String Optional, primary language
  }

Returns:

TTSConfig TTS configuration, which is a JSON string. The Tencent Cloud TTS example is as follows:

{ 
   "AppId": your application ID, // Integer Required
   "TTSType": "TTS type", // String TTS type, fixed to "tencent"
   "SecretId": "Your key ID", // String Required
   "SecretKey": "Your keyKey", // String Required
   "VoiceType": 101001, // Integer Required, voice ID, including standard voice and premium voice. Premium voice has higher fidelity and different price from standard voice. For details, please refer to Overview of Speech Synthesis Billing. For a complete list of timbre IDs, see List of speech synthesis timbre IDs. 
   "Speed": 1.25, // Integer Optional, speaking speed, range: [-2, 6], corresponding to different speaking speeds: -2: 0.6 times -1: 0.8 times 0: 1.0 times (default) 1: 1.2 times 2: 1.5 times 6: 2.5 times If a more detailed speaking speed is required, 2 decimal places can be retained, such as 0.5/1.25/2.81, etc. For the conversion between parameter value and actual speech speed, please refer to Speed Conversion
   "Volume": 5, // Integer Optional, volume size, range: [0, 10], corresponding to 11 levels of volume, the default value is 0, representing normal volume. 
   "PrimaryLanguage": "zh-CN" // String Optional, primary language
  }

setTTSConfig

public void setTTSConfig(String TTSConfig)

Set TTS configuration, which is a JSON string. The Tencent Cloud TTS example is as follows:

{ 
   "AppId": your application ID, // Integer Required
   "TTSType": "TTS type", // String TTS type, fixed to "tencent"
   "SecretId": "Your key ID", // String Required
   "SecretKey": "Your keyKey", // String Required
   "VoiceType": 101001, // Integer Required, voice ID, including standard voice and premium voice. Premium voice has higher fidelity and different price from standard voice. For details, please refer to Overview of Speech Synthesis Billing. For a complete list of timbre IDs, see List of speech synthesis timbre IDs. 
   "Speed": 1.25, // Integer Optional, speaking speed, range: [-2, 6], corresponding to different speaking speeds: -2: 0.6 times -1: 0.8 times 0: 1.0 times (default) 1: 1.2 times 2: 1.5 times 6: 2.5 times If a more detailed speaking speed is required, 2 decimal places can be retained, such as 0.5/1.25/2.81, etc. For the conversion between parameter value and actual speech speed, please refer to Speed Conversion
   "Volume": 5, // Integer Optional, volume size, range: [0, 10], corresponding to 11 levels of volume, the default value is 0, representing normal volume. 
   "PrimaryLanguage": "zh-CN" // String Optional, primary language
  }

Parameters:

TTSConfig - TTS configuration, which is a JSON string. The Tencent Cloud TTS example is as follows:

{ 
   "AppId": your application ID, // Integer Required
   "TTSType": "TTS type", // String TTS type, fixed to "tencent"
   "SecretId": "Your key ID", // String Required
   "SecretKey": "Your keyKey", // String Required
   "VoiceType": 101001, // Integer Required, voice ID, including standard voice and premium voice. Premium voice has higher fidelity and different price from standard voice. For details, please refer to Overview of Speech Synthesis Billing. For a complete list of timbre IDs, see List of speech synthesis timbre IDs. 
   "Speed": 1.25, // Integer Optional, speaking speed, range: [-2, 6], corresponding to different speaking speeds: -2: 0.6 times -1: 0.8 times 0: 1.0 times (default) 1: 1.2 times 2: 1.5 times 6: 2.5 times If a more detailed speaking speed is required, 2 decimal places can be retained, such as 0.5/1.25/2.81, etc. For the conversion between parameter value and actual speech speed, please refer to Speed Conversion
   "Volume": 5, // Integer Optional, volume size, range: [0, 10], corresponding to 11 levels of volume, the default value is 0, representing normal volume. 
   "PrimaryLanguage": "zh-CN" // String Optional, primary language
  }

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.