tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-12-11 15:15:52

KeyWordResult

Keyword recognition result.

Used by actions: DescribeTaskStatus.

Name Type Description
KeyWordLibID String Keyword library ID.
Note: This field may return null, indicating that no valid values can be obtained.
KeyWordLibName String Keyword library name.
Note: This field may return null, indicating that no valid values can be obtained.
KeyWords Array of String Matching keywords.
Note: This field may return null, indicating that no valid values can be obtained.

SentenceDetail

Detailed recognition result of a sentence, including the time offset of individual words. This parameter generally applies to subtitle generation scenarios.

Used by actions: DescribeTaskStatus.

Name Type Description
FinalSentence String Final recognition result of a sentence.
Note: This field may return null, indicating that no valid values can be obtained.
SliceSentence String Intermediate recognition result of a sentence. The sentence is split into multiple phrases by spaces.
Note: This field may return null, indicating that no valid values can be obtained.
WrittenText String Oral-to-written transcription result. This parameter has a value only if the corresponding feature is enabled.
Note: This field may return null, indicating that no valid values can be obtained.
StartMs Integer Start time of a sentence (ms).
Note: This field may return null, indicating that no valid values can be obtained.
EndMs Integer End time of a sentence (ms).
Note: This field may return null, indicating that no valid values can be obtained.
WordsNum Integer Number of words in a sentence.
Note: This field may return null, indicating that no valid values can be obtained.
Words Array of SentenceWords Word details of a sentence.
Note: This field may return null, indicating that no valid values can be obtained.
SpeechSpeed Float Speech speed of a sentence. Unit: Number of words per second.
Note: This field may return null, indicating that no valid values can be obtained.
SpeakerId Integer Channel or speaker ID. (If speaker_diarization is specified or ChannelNum is set to 2 (stereo) in the request, speakers or channels can be distinguished.)
Different values represent different speakers in mono mode. For the speakerId values, 0 represents the left channel, and 1 represents the right channel in stereo mode if an 8k engine is used.
Note: This field may return null, indicating that no valid values can be obtained.
EmotionalEnergy Float Emotional energy value. This value is the result of dividing the sound volume in dB by 10. Value range: [1,10]. The higher the value, the stronger the emotion.
Note: This field may return null, indicating that no valid values can be obtained.
SilenceTime Integer Silent duration between the current sentence and the last sentence.
Note: This field may return null, indicating that no valid values can be obtained.
EmotionType Array of String Emotion type. (This parameter may be left blank in two scenarios: 1. No corresponding resource package exists; 2. The emotion is not recognized because it is not strong enough, which is related to the emotional energy.)
Note: This field may return null, indicating that no valid values can be obtained.
KeyWordResults Array of KeyWordResult List of recognized keywords.
Note: This field may return null, indicating that no valid values can be obtained.

SentenceWords

Word text in the recognition result and the corresponding time offset.

Used by actions: DescribeTaskStatus.

Name Type Description
Word String Word text.
Note: This field may return null, indicating that no valid values can be obtained.
OffsetStartMs Integer Start time offset in the sentence.
Note: This field may return null, indicating that no valid values can be obtained.
OffsetEndMs Integer End time offset in the sentence.
Note: This field may return null, indicating that no valid values can be obtained.

Task

Returned data of the [recording recognition] (https://www.tencentcloud.com/document/product/1093/37823?from_cn_redirect=1#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0) or [asynchronous real-time audio recognition] (https://www.tencentcloud.com/document/product/1093/52061?from_cn_redirect=1#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0) request.

Used by actions: CreateRecTask.

Name Type Description
TaskId Integer Task ID. This ID can be used to obtain the recognition status and results through polling. The data type of TaskId is ** uint64 .
 Note: The task ID is valid for 24 hours, and duplicate task IDs of different dates may exist. Do not use task ID as the unique ID in your business system. **

TaskStatus

[Response parameters for obtaining recording recognition results] (https://www.tencentcloud.com/document/product/1093/37822?from_cn_redirect=1#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0)

Used by actions: DescribeTaskStatus.

Name Type Description
TaskId Integer Task ID. Note: The data type of TaskId is uint64.
Status Integer Task status code. 0: waiting; 1: in process; 2: success; 3: failed.
StatusStr String Task status. Valid values: waiting, in process, success, and failed.
Result String Recognition result.
ErrorMsg String Failure cause.
ResultDetail Array of SentenceDetail Recognition result details, including word time offsets for each sentence, which is generally used in subtitle generation scenarios. (This field is not left blank when ResTextFormat in the recording recognition request is set to 1.)
Note: This field may return null, indicating that no valid values can be obtained.
AudioDuration Float Audio duration (seconds).
Note: This field may return null, indicating that no valid values can be obtained.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy