Role Template Detail – Tuya MiniApp

getPanelAgentRoleTemplateDetail(params: GetPanelAgentRoleTemplateDetailParams)

Requires:

@tuya-miniapp/cloud-api≥1.0.6

Description

Query role template details.

Parameters

Parameter	Type	Required	Description
		Yes	Request body

Return Value

Type: Promise<PanelAgentRoleDetail>

GetPanelAgentRoleTemplateDetailResult (see type definitions and minituya response parameters for field meanings)

Referenced Types

typePanelAgentRoleDetail

Property	Type	Description
`roleId`	string	Role ID
`roleName`	string	Role name
`roleDesc`	string	Role description
`roleIntroduce`	string	Role description
`roleImgUrl`	string	Role image
`useLangCode`	string	Role language code
`useLangName`	string	Role language name
`useTimbreId`	string	Voice used by the role
`isUserCloneTimbre`	boolean	Whether it is a custom cloned voice
`useTimbreName`	string	Name of the voice used by the role
`useTimbreSupportLangs`	string	Languages supported by the role's voice, separated by commas
`useTimbreSupportLangList`	string[]	List of languages supported by the role's voice
`useTimbreTags`	string[]	Role tags
`useLlmId`	string	Role language model
`useLlmName`	string	Role language model name
`inBind`	boolean	Whether bound
`memoryInfo`	string	Memory
`speed`	number	Voice speed
`tone`	number	Voice tone
`templateId`	string	Template ID
`bindRoleType`	number	Type of bound role
`lastTextAnswer`	string	Most recent reply text
`llmSupportFuncTags`	string	Function tags supported by the language model, separated by commas

Examples

Request example

import { getPanelAgentRoleTemplateDetail } from '@tuya-miniapp/cloud-api';

const params = {
  devId: 'your_device_id',
  roleId: 'template_role_001',
};

getPanelAgentRoleTemplateDetail(params)
  .then(result => {
    console.log('Role template details:', result);
  })
  .catch(error => {
    console.error('Failed to get role template details:', error);
  });

Response example

{
  "roleId": "template_role_001",
  "roleName": "Smart Assistant Template",
  "roleDesc": "Standard smart assistant template",
  "roleIntroduce": "I am a general-purpose smart assistant template",
  "roleImgUrl": "https://example.com/template_avatar.jpg",
  "useLangCode": "zh-CN",
  "useLangName": "Chinese (Simplified)",
  "useTimbreId": "timbre_template_001",
  "isUserCloneTimbre": false,
  "useTimbreName": "Standard female voice",
  "useTimbreSupportLangs": "zh-CN,en-US",
  "useTimbreSupportLangList": ["zh-CN", "en-US"],
  "useTimbreTags": ["Standard", "General"],
  "useLlmId": "1001",
  "useLlmName": "GPT-3.5-turbo",
  "inBind": false,
  "memoryInfo": "Default template memory",
  "speed": 1.0,
  "tone": 0.5,
  "templateId": "template_001",
  "bindRoleType": 1,
  "lastTextAnswer": "",
  "llmSupportFuncTags": "text,voice"
}