@alicloud/aimiaobi20230801 1.45.0 → 1.45.2

package/src/models/RunStyleFeatureAnalysisResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunStyleFeatureAnalysisResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * 403
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * Pop sign mismatch, please check.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * Event type.
+   * 
    * @example
    * result-generated
    */
   event?: string;
   /**
+   * @remarks
+   * Event description.
+   * 
    * @example
    * 模型生成事件
    */
   eventInfo?: string;
   /**
+   * @remarks
+   * Session ID.
+   * 
    * @example
    * 3cd10828-0e42-471c-8f1a-931cde20b035
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Task ID.
+   * 
    * @example
    * d3be9981-ca2d-4e17-bf31-1c0a628e9f99
    */
   taskId?: string;
   /**
+   * @remarks
+   * Trace ID.
+   * 
    * @example
    * 2150451a17191950923411783e2927
    */
@@ -73,6 +94,9 @@ export class RunStyleFeatureAnalysisResponseBodyHeader extends $dara.Model {
 
 export class RunStyleFeatureAnalysisResponseBodyPayloadOutput extends $dara.Model {
   /**
+   * @remarks
+   * Output content.
+   * 
    * @example
    * 这是测试输出
    */
@@ -100,16 +124,25 @@ export class RunStyleFeatureAnalysisResponseBodyPayloadOutput extends $dara.Mode
 
 export class RunStyleFeatureAnalysisResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Input Tokens.
+   * 
    * @example
    * 100
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Output Tokens.
+   * 
    * @example
    * 100
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total Tokens.
+   * 
    * @example
    * 200
    */
@@ -140,7 +173,15 @@ export class RunStyleFeatureAnalysisResponseBodyPayloadUsage extends $dara.Model
 }
 
 export class RunStyleFeatureAnalysisResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Output content object.
+   */
   output?: RunStyleFeatureAnalysisResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * Large Language Model (LLM) token usage information.
+   */
   usage?: RunStyleFeatureAnalysisResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -172,10 +213,25 @@ export class RunStyleFeatureAnalysisResponseBodyPayload extends $dara.Model {
 }
 
 export class RunStyleFeatureAnalysisResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Whether the output is complete. True indicates completion.
+   */
   end?: boolean;
+  /**
+   * @remarks
+   * The streaming output header, containing general return information.
+   */
   header?: RunStyleFeatureAnalysisResponseBodyHeader;
+  /**
+   * @remarks
+   * The payload of the response, in JSON structure
+   */
   payload?: RunStyleFeatureAnalysisResponseBodyPayload;
   /**
+   * @remarks
+   * Unique request ID.
+   * 
    * @example
    * d3be9981-ca2d-4e17-bf31-1c0a628e9f99
    */

package/src/models/RunStyleFeatureAnalysisShrinkRequest.ts

@@ -3,10 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RunStyleFeatureAnalysisShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A collection of custom content texts.
+   */
   contentsShrink?: string;
+  /**
+   * @remarks
+   * A collection of Material Library IDs.
+   */
   materialIdsShrink?: string;
   /**
    * @remarks
+   * The unique identifier of the Alibaba Cloud Model Studio workspace. Get the [workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RunSummaryGenerateRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class RunSummaryGenerateRequest extends $dara.Model {
   /**
    * @remarks
+   * Content to summarize.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class RunSummaryGenerateRequest extends $dara.Model {
    */
   content?: string;
   /**
+   * @remarks
+   * Custom prompt for summary generation.
+   * 
    * @example
    * 请为上述内容生成一段摘要，字数在100~200字以内。
    */
   prompt?: string;
   /**
    * @remarks
+   * Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RunSummaryGenerateResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunSummaryGenerateResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * 403
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * Pop sign mismatch, please check.
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * Event type.
+   * 
    * @example
    * result-generated
    */
   event?: string;
   /**
+   * @remarks
+   * Event description.
+   * 
    * @example
    * 模型生成事件
    */
   eventInfo?: string;
   /**
+   * @remarks
+   * Session ID.
+   * 
    * @example
    * 3cd10828-0e42-471c-8f1a-931cde20b035
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Task ID.
+   * 
    * @example
    * d3be9981-ca2d-4e17-bf31-1c0a628e9f99
    */
   taskId?: string;
   /**
+   * @remarks
+   * Trace ID.
+   * 
    * @example
    * 2150451a17191950923411783e2927
    */
@@ -73,6 +94,9 @@ export class RunSummaryGenerateResponseBodyHeader extends $dara.Model {
 
 export class RunSummaryGenerateResponseBodyPayloadOutput extends $dara.Model {
   /**
+   * @remarks
+   * Output text.
+   * 
    * @example
    * 这是测试输出
    */
@@ -100,16 +124,25 @@ export class RunSummaryGenerateResponseBodyPayloadOutput extends $dara.Model {
 
 export class RunSummaryGenerateResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Number of input tokens.
+   * 
    * @example
    * 100
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Number of output tokens.
+   * 
    * @example
    * 100
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total number of tokens.
+   * 
    * @example
    * 200
    */
@@ -140,7 +173,15 @@ export class RunSummaryGenerateResponseBodyPayloadUsage extends $dara.Model {
 }
 
 export class RunSummaryGenerateResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Output object.
+   */
   output?: RunSummaryGenerateResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * Large Language Model (LLM) token usage information.
+   */
   usage?: RunSummaryGenerateResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -172,10 +213,25 @@ export class RunSummaryGenerateResponseBodyPayload extends $dara.Model {
 }
 
 export class RunSummaryGenerateResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the response is complete. Set to true when complete.
+   */
   end?: boolean;
+  /**
+   * @remarks
+   * Streaming output header. Contains general response information.
+   */
   header?: RunSummaryGenerateResponseBodyHeader;
+  /**
+   * @remarks
+   * Response payload in JSON format.
+   */
   payload?: RunSummaryGenerateResponseBodyPayload;
   /**
+   * @remarks
+   * Unique request ID.
+   * 
    * @example
    * d3be9981-ca2d-4e17-bf31-1c0a628e9f99
    */

package/src/models/RunTextPolishingRequest.ts

@@ -5,21 +5,42 @@ import * as $dara from '@darabonba/typescript';
 export class RunTextPolishingRequest extends $dara.Model {
   /**
    * @remarks
+   * Text content.
+   * 
    * This parameter is required.
    * 
    * @example
    * 文本内容
    */
   content?: string;
+  /**
+   * @remarks
+   * Original article.
+   * 
+   * @example
+   * 原始文章内容
+   */
   originContent?: string;
+  /**
+   * @remarks
+   * Custom polishing requirements.
+   * 
+   * @example
+   * 自定义的润色要求
+   */
   prompt?: string;
   /**
+   * @remarks
+   * The task ID. The same task ID shares a session. The task timeout is 12 hours.
+   * 
    * @example
    * taskld-xxxxx
    */
   taskId?: string;
   /**
    * @remarks
+   * The unique identifier of the Alibaba Cloud Model Studio workspace. Obtain the [Workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RunTextPolishingResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunTextPolishingResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * 错误码
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * 错误信息
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * The SSE event. \\`task-started\\`: started. \\`task-finished\\`: finished. \\`task-failed\\`: failed.
+   * 
    * @example
    * task-started
    */
   event?: string;
   /**
+   * @remarks
+   * Parent session ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   originSessionId?: string;
   /**
+   * @remarks
+   * Session ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Task ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   taskId?: string;
   /**
+   * @remarks
+   * End-to-end trace ID.
+   * 
    * @example
    * 全链路ID
    */
@@ -73,6 +94,9 @@ export class RunTextPolishingResponseBodyHeader extends $dara.Model {
 
 export class RunTextPolishingResponseBodyPayloadOutput extends $dara.Model {
   /**
+   * @remarks
+   * Text generation result.
+   * 
    * @example
    * 文本生成结果
    */
@@ -100,16 +124,25 @@ export class RunTextPolishingResponseBodyPayloadOutput extends $dara.Model {
 
 export class RunTextPolishingResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Number of tokens used for input.
+   * 
    * @example
    * 1
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Number of tokens used for output.
+   * 
    * @example
    * 1
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total number of tokens used for this call.
+   * 
    * @example
    * 2
    */
@@ -140,7 +173,15 @@ export class RunTextPolishingResponseBodyPayloadUsage extends $dara.Model {
 }
 
 export class RunTextPolishingResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Output.
+   */
   output?: RunTextPolishingResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * Token consumption.
+   */
   usage?: RunTextPolishingResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -172,9 +213,20 @@ export class RunTextPolishingResponseBodyPayload extends $dara.Model {
 }
 
 export class RunTextPolishingResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Response header.
+   */
   header?: RunTextPolishingResponseBodyHeader;
+  /**
+   * @remarks
+   * Response body.
+   */
   payload?: RunTextPolishingResponseBodyPayload;
   /**
+   * @remarks
+   * Unique request identifier.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */

package/src/models/RunTitleGenerationRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class RunTitleGenerationRequestReferenceData extends $dara.Model {
   /**
    * @remarks
+   * List of main content.
+   * 
    * This parameter is required.
    */
   contents?: string[];
@@ -33,20 +35,40 @@ export class RunTitleGenerationRequestReferenceData extends $dara.Model {
 }
 
 export class RunTitleGenerationRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A collection of titles to deduplicate against the newly generated titles. The total character count for all titles must not exceed 5K.
+   */
   deduplicatedTitles?: string[];
   /**
    * @remarks
+   * Data for title generation.
+   * 
    * This parameter is required.
    */
   referenceData?: RunTitleGenerationRequestReferenceData;
   /**
+   * @remarks
+   * The unique identifier for the associated creative article.
+   * 
+   * > The system automatically generates the TaskId by default. You do not need to specify it. If subsequent tasks use the same TaskId, they belong to the same conversation group.
+   * 
    * @example
    * xxxx
    */
   taskId?: string;
+  /**
+   * @remarks
+   * Number of titles to generate, maximum 10.
+   * 
+   * @example
+   * 10
+   */
   titleCount?: string;
   /**
    * @remarks
+   * The unique identifier for the Alibaba Cloud Model Studio workspace. For more information, see [Get the workspace ID](https://help.aliyun.com/document_detail/2782167.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RunTitleGenerationResponseBody.ts

@@ -4,32 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunTitleGenerationResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * AccessForbid
    */
   errorCode?: string;
   /**
+   * @remarks
+   * Error code message.
+   * 
    * @example
    * xxx
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * SSE event.
+   * 
    * @example
    * task-failed
    */
   event?: string;
   /**
+   * @remarks
+   * Session ID.
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   sessionId?: string;
+  /**
+   * @remarks
+   * Status code.
+   * 
+   * @example
+   * 400
+   */
   statusCode?: number;
   /**
+   * @remarks
+   * Task ID.
+   * 
    * @example
    * 50a1cc8e-717e-4a2b-a76b-dc9734a8564b
    */
   taskId?: string;
   /**
+   * @remarks
+   * Full link ID.
+   * 
    * @example
    * 0a3d448f17000139741898287e0eb3
    */
@@ -69,6 +94,9 @@ export class RunTitleGenerationResponseBodyHeader extends $dara.Model {
 
 export class RunTitleGenerationResponseBodyPayloadOutput extends $dara.Model {
   /**
+   * @remarks
+   * Article title.
+   * 
    * @example
    * xxx
    */
@@ -96,16 +124,25 @@ export class RunTitleGenerationResponseBodyPayloadOutput extends $dara.Model {
 
 export class RunTitleGenerationResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Number of tokens used for input.
+   * 
    * @example
    * 1
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Number of tokens used for output.
+   * 
    * @example
    * 1
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total number of tokens used for this call.
+   * 
    * @example
    * 2
    */
@@ -136,7 +173,15 @@ export class RunTitleGenerationResponseBodyPayloadUsage extends $dara.Model {
 }
 
 export class RunTitleGenerationResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Outputs.
+   */
   output?: RunTitleGenerationResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * Token usage.
+   */
   usage?: RunTitleGenerationResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -168,16 +213,55 @@ export class RunTitleGenerationResponseBodyPayload extends $dara.Model {
 }
 
 export class RunTitleGenerationResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Status code.
+   * 
+   * @example
+   * AccessForbid
+   */
   code?: string;
+  /**
+   * @remarks
+   * Response header.
+   */
   header?: RunTitleGenerationResponseBodyHeader;
+  /**
+   * @remarks
+   * HTTP status code.
+   * 
+   * @example
+   * 200
+   */
   httpStatusCode?: string;
+  /**
+   * @remarks
+   * Error description.
+   * 
+   * @example
+   * 数据不存在
+   */
   message?: string;
+  /**
+   * @remarks
+   * Response body.
+   */
   payload?: RunTitleGenerationResponseBodyPayload;
   /**
+   * @remarks
+   * Unique request identifier.
+   * 
    * @example
    * 94512A33-8EC1-5452-A793-5C91F18ED2F0
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Whether the operation was successful: true for success, false for failure.
+   * 
+   * @example
+   * true
+   */
   success?: boolean;
   static names(): { [key: string]: string } {
     return {