tencent cloud

Tencent Cloud AI Digital Human

Product Overview
Overview
Product Features
Product Advantage
Purchase Guide
Pricing Guide
Purchase Guide
Process for Purchasing with Vouchers
Refund Instructions
Introduction of Avatar
Introduction to Image Categories
Basic Image Library
Guide on Avatar and Voice Clone
Digital Human Platform Operation Guide
Accessing Platform
Avatar Production and Asset Management
Digital Human Conversation Interaction Application and Management
Broadcast Digital Human Video Generation and Management
Operations Management and Analysis
Server API Integration
Digital Human API Access Mode Overview
Avatar aPaas API Calling Methods
Avatar Image Customization and Voice Clone API Documentation
Video Generation Service API Documentation
Interactive Digital Human Service API Documentation
Personal Asset Management API Documentation
Client SDK Integration
Overall Introduction
3D Client-Side Rendering SDK Integration
2D Client-Side Rendering SDK Integration
Digital Human SSML Markup Language Specification
Related Agreement
Privacy Policy
DSA (Data Sharing Agreement)
FAQs
DocumentationTencent Cloud AI Digital HumanServer API IntegrationInteractive Digital Human Service API DocumentationCloud Rendering Conversation Interaction Integration APIInstruction-drivenText-driven Instructions

Text-driven Instructions

PDF
Focus Mode
Font Size
Last updated: 2024-07-19 10:06:40
After you Create Long Connection Channel, you can use a websocket persistent connection to send the text to drive the digital human.

Request Parameters

Parameter name
Type
Required
Description
ReqId
String
Yes
Unique identifier for a single drive session.
SessionId
String
Yes
Unique identifier for the session.
Command
String
Yes
SEND_TEXT: Send text.
Data
Yes
Data Object
Data
(Send text.)
Name
Type
Required
Description
Text
String
No
The text content to be broadcasted, default value: maximum length of 4000 bytes.
Interrupt
Boolean
No
Forced interruption flag. The default value is false. If forced interruption is not used and the text is marked as non-interruptible on the digital human platform, you will receive feedback indicating that interruption is not possible. If forced interruption is used, the system will ignore the non-interruptible setting on the digital human platform and execute the forced interruption directly.
ChatCommand
String
No
Dialogue instruction type, effective when the digital human project is bound to a customer service chatbot.
NotUseChat: The Q&A knowledge library configured for the customer service bot is not effective, and the digital human broadcasts the content sent.
Pass empty or do not pass: The Q&A knowledge library configured for the customer service bot becomes effective, and the digital human broadcasts the answers from the Q&A knowledge library.
ChatRoundId
String
No
Conversation round ID, recommended to use UUID. Default value: "". For digital human projects using Tencent's industry large model conversation service, this field needs to be provided to distinguish between multiple rounds of dialogue.
CloudAiVisitorBizId
String (64)
No
Visitor ID for Tencent's large model knowledge engine.
Warning:
The interval between sending texts must be greater than 1 second.

Parameter example


{
    "Header": {},
    "Payload": {
        "ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
        "SessionId": "m123adfafvbadsafd",
        "Command": "SEND_TEXT",
        "Data": {
            "Text": "Hello, I am an artificially synthesized digital human",
            "ChatCommand": "NotUseChat"//Using the text-driven stream built for the digital human project; this drive is purely text-driven and does not involve dialogue.
        }
    }
}

Previous Topic: Creating a Long Connection ChannelNext Topic: Voice-driven Instructions

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback