@alicloud/aimiaobi20230801 1.45.0 → 1.45.2

package/src/models/SubmitSmartClipTaskRequest.ts

@@ -3,8 +3,24 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SubmitSmartClipTaskRequestEditingConfigBackgroundMusicConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Background music style. Default value: empty. If background music is already configured in InputConfig, this field does not take effect.
+   * Valid values:
+   * bgm-beauty: Fashion
+   * bgm-chinese-style: Chinese style
+   * bgm-cuisine: Food
+   * bgm-dynamic: Dynamic
+   * bgm-quirky: Quirky
+   * bgm-relaxing: Relaxing
+   * bgm-romantic: Romantic
+   * bgm-upbeat: Upbeat
+   */
   style?: string;
   /**
+   * @remarks
+   * Volume of the background music. Valid values: 0 to 10.0.
+   * 
    * @example
    * 0.2
    */
@@ -33,6 +49,10 @@ export class SubmitSmartClipTaskRequestEditingConfigBackgroundMusicConfig extend
 }
 
 export class SubmitSmartClipTaskRequestEditingConfigMediaConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Volume of the video material. 0 means mute.
+   */
   volume?: number;
   static names(): { [key: string]: string } {
     return {
@@ -56,28 +76,61 @@ export class SubmitSmartClipTaskRequestEditingConfigMediaConfig extends $dara.Mo
 }
 
 export class SubmitSmartClipTaskRequestEditingConfigSpeechConfigAsrConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Caption alignment.
+   * TopLeft: Top-left corner of the video.
+   * TopCenter: Top center of the vertical axis of the video.
+   * TopRight: Top-right corner of the video.
+   * CenterLeft: Left side of the horizontal center line of the video.
+   * CenterCenter: Center of the video.
+   * CenterRight: Right side of the horizontal center line of the video.
+   * BottomLeft: Bottom-left corner of the video.
+   * BottomCenter: Bottom center of the vertical axis of the video.
+   * BottomRight: Bottom-right corner of the video.
+   */
   alignment?: string;
   /**
+   * @remarks
+   * Font of the caption text. For supported fonts, see the font list. Default font: SimSun.
+   * 
    * @example
    * SimSun
    */
   font?: string;
   /**
+   * @remarks
+   * Color of the caption text. Format: # followed by a hexadecimal value. Example: #ffffff.
+   * 
    * @example
    * #ffffff
    */
   fontColor?: string;
   /**
+   * @remarks
+   * Font size of the caption text. This size scales based on the source material size and the final output size. Default value: 0. Maximum value: 5000.
+   * 
    * @example
    * 0
    */
   fontSize?: string;
   /**
+   * @remarks
+   * Letter spacing of the caption text, in pixels.
+   * 
    * @example
    * 0
    */
   spacing?: string;
+  /**
+   * @remarks
+   * Horizontal distance from the top-left corner of the caption text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video width. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.
+   */
   x?: number;
+  /**
+   * @remarks
+   * Vertical distance from the top-left corner of the caption text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video height. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.
+   */
   y?: number;
   static names(): { [key: string]: string } {
     return {
@@ -113,15 +166,51 @@ export class SubmitSmartClipTaskRequestEditingConfigSpeechConfigAsrConfig extend
 }
 
 export class SubmitSmartClipTaskRequestEditingConfigSpeechConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Caption parameter configuration.
+   */
   asrConfig?: SubmitSmartClipTaskRequestEditingConfigSpeechConfigAsrConfig;
   /**
+   * @remarks
+   * Speech rate of the voiceover script.
+   * Valid values: -500 to 500. Default value: 0.
+   * The corresponding playback speed multipliers for [-500, 0, 500] are [0.5, 1.0, 2.0].
+   * Calculation method:
+   * For 0.8× speed: (1 - 1/0.8) / 0.002 = -125
+   * For 1.2× speed: (1 - 1/1.2) / 0.001 = 166
+   * Use coefficient 0.002 for speeds less than 1×.
+   * Use coefficient 0.001 for speeds greater than 1×.
+   * Round the result to the nearest integer.
+   * 
+   * The calculation method is as follows:<br>
+   * 0.8× speed: (1 − 1/0.8)/0.002 = −125<br>
+   * 1.2× speed: (1 − 1/1.2)/0.001 = 166<br>
+   * When the speed is less than 1×, use a coefficient of 0.002.<br>
+   * When the speed is greater than 1×, use a coefficient of 0.001.<br>
+   * The actual algorithm result is approximated.<br><br><br><br><br>
+   * 
    * @example
    * 0
    */
   speechRate?: number;
+  /**
+   * @remarks
+   * Voiceover style. Default value: empty. If both Voice and Style are specified, Voice takes precedence.
+   * Gentle: Gentle
+   * Serious: Serious
+   * Entertainment: Entertainment
+   */
   style?: string;
+  /**
+   * @remarks
+   * Specify one or more voice styles for the voiceover, separated by commas. When multiple voices are specified, one is randomly selected for synthesis. For available voice styles, see [Smart Voice Effect Examples](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz). Example: "zhimiao_emo,zhilun".
+   */
   voice?: string;
   /**
+   * @remarks
+   * Volume of the voiceover audio. Default value: 1. Valid values: 0 to 10.0. Decimal values are supported. Example: 0.5.
+   * 
    * @example
    * 0.5
    */
@@ -160,26 +249,49 @@ export class SubmitSmartClipTaskRequestEditingConfigSpeechConfig extends $dara.M
 
 export class SubmitSmartClipTaskRequestEditingConfigTitleConfig extends $dara.Model {
   /**
+   * @remarks
+   * TopLeft: Top-left corner of the video.
+   * TopCenter: Top center of the vertical axis of the video.
+   * TopRight: Top-right corner of the video.
+   * CenterLeft: Left side of the horizontal center line of the video.
+   * CenterCenter: Center of the video.
+   * CenterRight: Right side of the horizontal center line of the video.
+   * BottomLeft: Bottom-left corner of the video.
+   * BottomCenter: Bottom center of the vertical axis of the video.
+   * BottomRight: Bottom-right corner of the video.
+   * 
    * @example
    * TopLeft
    */
   alignment?: string;
   /**
+   * @remarks
+   * Time when the title appears.
+   * 
    * @example
    * 2
    */
   timelineIn?: number;
   /**
+   * @remarks
+   * Time when the title disappears.
+   * 
    * @example
    * 3
    */
   timelineOut?: number;
   /**
+   * @remarks
+   * Horizontal distance from the top-left corner of the banner text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video width. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.
+   * 
    * @example
    * 100
    */
   x?: number;
   /**
+   * @remarks
+   * Vertical distance from the top-left corner of the banner text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video height. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.
+   * 
    * @example
    * 100
    */
@@ -214,9 +326,25 @@ export class SubmitSmartClipTaskRequestEditingConfigTitleConfig extends $dara.Mo
 }
 
 export class SubmitSmartClipTaskRequestEditingConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Background music configuration.
+   */
   backgroundMusicConfig?: SubmitSmartClipTaskRequestEditingConfigBackgroundMusicConfig;
+  /**
+   * @remarks
+   * Media configuration.
+   */
   mediaConfig?: SubmitSmartClipTaskRequestEditingConfigMediaConfig;
+  /**
+   * @remarks
+   * Voiceover configuration.
+   */
   speechConfig?: SubmitSmartClipTaskRequestEditingConfigSpeechConfig;
+  /**
+   * @remarks
+   * Title configuration.
+   */
   titleConfig?: SubmitSmartClipTaskRequestEditingConfigTitleConfig;
   static names(): { [key: string]: string } {
     return {
@@ -260,6 +388,8 @@ export class SubmitSmartClipTaskRequestEditingConfig extends $dara.Model {
 export class SubmitSmartClipTaskRequestInputConfigBackgroundMusics extends $dara.Model {
   /**
    * @remarks
+   * Background music ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -268,6 +398,11 @@ export class SubmitSmartClipTaskRequestInputConfigBackgroundMusics extends $dara
   id?: string;
   /**
    * @remarks
+   * ID type:
+   * materialId: Material Library reference ID
+   * fileKey: FileKey in Alibaba Cloud Model Studio
+   * url: Publicly accessible URL
+   * 
    * This parameter is required.
    * 
    * @example
@@ -300,6 +435,8 @@ export class SubmitSmartClipTaskRequestInputConfigBackgroundMusics extends $dara
 export class SubmitSmartClipTaskRequestInputConfigStickersStickerId extends $dara.Model {
   /**
    * @remarks
+   * Sticker ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -308,6 +445,11 @@ export class SubmitSmartClipTaskRequestInputConfigStickersStickerId extends $dar
   id?: string;
   /**
    * @remarks
+   * ID type:
+   * materialId: Material Library reference ID
+   * fileKey: FileKey in Alibaba Cloud Model Studio
+   * url: Publicly accessible URL
+   * 
    * This parameter is required.
    * 
    * @example
@@ -340,6 +482,8 @@ export class SubmitSmartClipTaskRequestInputConfigStickersStickerId extends $dar
 export class SubmitSmartClipTaskRequestInputConfigStickers extends $dara.Model {
   /**
    * @remarks
+   * Height of the sticker.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -348,11 +492,15 @@ export class SubmitSmartClipTaskRequestInputConfigStickers extends $dara.Model {
   height?: number;
   /**
    * @remarks
+   * Sticker ID.
+   * 
    * This parameter is required.
    */
   stickerId?: SubmitSmartClipTaskRequestInputConfigStickersStickerId;
   /**
    * @remarks
+   * Width of the sticker.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -361,6 +509,8 @@ export class SubmitSmartClipTaskRequestInputConfigStickers extends $dara.Model {
   width?: number;
   /**
    * @remarks
+   * X coordinate of the top-left corner of the sticker.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -369,6 +519,8 @@ export class SubmitSmartClipTaskRequestInputConfigStickers extends $dara.Model {
   x?: number;
   /**
    * @remarks
+   * Y coordinate of the top-left corner of the sticker.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -410,6 +562,8 @@ export class SubmitSmartClipTaskRequestInputConfigStickers extends $dara.Model {
 export class SubmitSmartClipTaskRequestInputConfigVideoIds extends $dara.Model {
   /**
    * @remarks
+   * Material ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -418,6 +572,11 @@ export class SubmitSmartClipTaskRequestInputConfigVideoIds extends $dara.Model {
   id?: string;
   /**
    * @remarks
+   * ID type:
+   * materialId: Material Library reference ID
+   * fileKey: FileKey in Alibaba Cloud Model Studio
+   * url: Publicly accessible URL
+   * 
    * This parameter is required.
    * 
    * @example
@@ -448,12 +607,30 @@ export class SubmitSmartClipTaskRequestInputConfigVideoIds extends $dara.Model {
 }
 
 export class SubmitSmartClipTaskRequestInputConfig extends $dara.Model {
+  /**
+   * @remarks
+   * List of background music IDs.
+   */
   backgroundMusics?: SubmitSmartClipTaskRequestInputConfigBackgroundMusics[];
+  /**
+   * @remarks
+   * List of voiceover script texts.
+   */
   speechTexts?: string[];
+  /**
+   * @remarks
+   * List of stickers.
+   */
   stickers?: SubmitSmartClipTaskRequestInputConfigStickers[];
+  /**
+   * @remarks
+   * List of titles.
+   */
   titles?: string[];
   /**
    * @remarks
+   * List of video material ID objects.
+   * 
    * This parameter is required.
    */
   videoIds?: SubmitSmartClipTaskRequestInputConfigVideoIds[];
@@ -503,31 +680,49 @@ export class SubmitSmartClipTaskRequestInputConfig extends $dara.Model {
 
 export class SubmitSmartClipTaskRequestOutputConfig extends $dara.Model {
   /**
+   * @remarks
+   * Number of output videos.
+   * 
    * @example
    * 1
    */
   count?: number;
   /**
+   * @remarks
+   * Output file name. Must include {index}.
+   * 
    * @example
    * test_{index}.mp4
    */
   fileName?: string;
   /**
+   * @remarks
+   * Output video height.
+   * 
    * @example
    * 1080
    */
   height?: number;
   /**
+   * @remarks
+   * Maximum duration of the output video, in seconds.
+   * 
    * @example
    * 120
    */
   maxDuration?: number;
   /**
+   * @remarks
+   * Save to Content Management.
+   * 
    * @example
    * true
    */
   saveToGeneratedContent?: boolean;
   /**
+   * @remarks
+   * Output video width.
+   * 
    * @example
    * 1920
    */
@@ -564,17 +759,36 @@ export class SubmitSmartClipTaskRequestOutputConfig extends $dara.Model {
 }
 
 export class SubmitSmartClipTaskRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Video editing configuration.
+   */
   editingConfig?: SubmitSmartClipTaskRequestEditingConfig;
+  /**
+   * @remarks
+   * Additional extended parameters. These parameters merge with InputConfig, OutputConfig, and EditingConfig.
+   */
   extendParam?: string;
   /**
    * @remarks
+   * Input configuration.
+   * 
    * This parameter is required.
    */
   inputConfig?: SubmitSmartClipTaskRequestInputConfig;
+  /**
+   * @remarks
+   * Output configuration.
+   */
   outputConfig?: SubmitSmartClipTaskRequestOutputConfig;
   /**
    * @remarks
+   * Alibaba Cloud Model Studio workspace ID. For more information, see [workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 业务空间ID
    */
   workspaceId?: string;
   static names(): { [key: string]: string } {

package/src/models/SubmitSmartClipTaskResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class SubmitSmartClipTaskResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
@@ -31,27 +34,46 @@ export class SubmitSmartClipTaskResponseBodyData extends $dara.Model {
 
 export class SubmitSmartClipTaskResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The status code.
+   * 
    * @example
    * NoData
    */
   code?: string;
+  /**
+   * @remarks
+   * The result of the task submission.
+   */
   data?: SubmitSmartClipTaskResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * 1813ceee-7fe5-41b4-87e5-982a4d18cca5
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful. true indicates success. false indicates failure.
+   * 
    * @example
    * true
    */

package/src/models/SubmitSmartClipTaskShrinkRequest.ts

@@ -3,17 +3,36 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SubmitSmartClipTaskShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Video editing configuration.
+   */
   editingConfigShrink?: string;
+  /**
+   * @remarks
+   * Additional extended parameters. These parameters merge with InputConfig, OutputConfig, and EditingConfig.
+   */
   extendParam?: string;
   /**
    * @remarks
+   * Input configuration.
+   * 
    * This parameter is required.
    */
   inputConfigShrink?: string;
+  /**
+   * @remarks
+   * Output configuration.
+   */
   outputConfigShrink?: string;
   /**
    * @remarks
+   * Alibaba Cloud Model Studio workspace ID. For more information, see [workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 业务空间ID
    */
   workspaceId?: string;
   static names(): { [key: string]: string } {

package/src/models/SubmitTopicSelectionPerspectiveAnalysisTaskRequest.ts

@@ -3,7 +3,21 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocumentsComments extends $dara.Model {
+  /**
+   * @remarks
+   * Content
+   * 
+   * @example
+   * 内容
+   */
   text?: string;
+  /**
+   * @remarks
+   * Username
+   * 
+   * @example
+   * 用户名
+   */
   username?: string;
   static names(): { [key: string]: string } {
     return {
@@ -30,13 +44,22 @@ export class SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocumentsComments
 
 export class SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocuments extends $dara.Model {
   /**
+   * @remarks
+   * Author
+   * 
    * @example
    * 作者
    */
   author?: string;
+  /**
+   * @remarks
+   * Content list
+   */
   comments?: SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocumentsComments[];
   /**
    * @remarks
+   * Content
+   * 
    * This parameter is required.
    * 
    * @example
@@ -44,26 +67,41 @@ export class SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocuments extends
    */
   content?: string;
   /**
+   * @remarks
+   * Publication time. Format: YYYY-MM-dd HH:mm:ss
+   * 
    * @example
    * 2024-01-22 10:29:00
    */
   pubTime?: string;
   /**
+   * @remarks
+   * Article source
+   * 
    * @example
    * 新浪
    */
   source?: string;
   /**
+   * @remarks
+   * Summary
+   * 
    * @example
    * 文章摘要
    */
   summary?: string;
   /**
+   * @remarks
+   * Title
+   * 
    * @example
    * 文章标题
    */
   title?: string;
   /**
+   * @remarks
+   * Article URL
+   * 
    * @example
    * https://www.example.com/aaa.docx
    */
@@ -109,19 +147,31 @@ export class SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocuments extends
 export class SubmitTopicSelectionPerspectiveAnalysisTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The unique identifier of the workspace: [AgentKey](https://help.aliyun.com/document_detail/2587494.html)
+   * 
    * This parameter is required.
    * 
    * @example
    * xxxxx_p_efm
    */
   agentKey?: string;
+  /**
+   * @remarks
+   * The list of documents to be analyzed. (Provide at least one of documents or topic)
+   */
   documents?: SubmitTopicSelectionPerspectiveAnalysisTaskRequestDocuments[];
   /**
+   * @remarks
+   * The topic selection perspective tasks to be analyzed. By default, this parameter is empty, which means all tasks are analyzed. (TopicSummary: Topic event summary, HotViewPoints: Hot topic selection perspectives, TimedViewPoints: Timeliness topic selection perspectives, WebReviewPoints: Online review topic selection perspectives, FreshViewPoints: Novel topic selection perspectives)
+   * 
    * @example
    * TimedViewPoints
    */
   perspectiveTypes?: string[];
   /**
+   * @remarks
+   * The name of the topic to be analyzed. (Provide at least one of documents or topic)
+   * 
    * @example
    * 待分析的主题名（documents与topic二者至少传一个）
    */