@alicloud/aimiaobi20230801 1.45.0 → 1.45.2

package/src/models/RunDocIntroductionRequest.ts

@@ -3,35 +3,83 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RunDocIntroductionRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Purge cache
+   * 
+   * @example
+   * true
+   */
   cleanCache?: boolean;
   /**
    * @remarks
+   * Document ID
+   * 
    * This parameter is required.
    * 
    * @example
    * 12345
    */
   docId?: string;
+  /**
+   * @remarks
+   * Custom requirements for the document summary
+   * 
+   * @example
+   * 用英文输出
+   */
   introductionPrompt?: string;
+  /**
+   * @remarks
+   * Custom requirements for key points
+   * 
+   * @example
+   * 用英文输出
+   */
   keyPointPrompt?: string;
+  /**
+   * @remarks
+   * User-defined model name
+   * 
+   * @example
+   * quanmiao-max、quanmiao-plus
+   */
   modelName?: string;
   /**
    * @remarks
+   * Conversation ID
+   * 
    * This parameter is required.
    * 
    * @example
    * a3b5eb35-6b28-4cf9-ac09-1dec25ab4df6
    */
   sessionId?: string;
+  /**
+   * @remarks
+   * Custom requirements for the summary content
+   * 
+   * @example
+   * 用英文输出
+   */
   summaryPrompt?: string;
   /**
    * @remarks
+   * Unique identifier (UUID) of the Alibaba Cloud Model Studio workspace. For more information, see [Workspace ID](https://help.aliyun.com/document_detail/2587495.html).
+   * 
    * This parameter is required.
    * 
    * @example
    * xxxx
    */
   workspaceId?: string;
+  /**
+   * @remarks
+   * Content to generate the summary from. If not empty, this value takes precedence over docId.
+   * 
+   * @example
+   * 要进行导读的内容
+   */
   referenceContent?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/RunDocIntroductionResponseBody.ts

@@ -4,32 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunDocIntroductionResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * error code
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * error message.
+   * 
    * @example
    * success
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * Type of management event
+   * 
    * @example
    * task-started
    */
   event?: string;
+  /**
+   * @remarks
+   * Description of the management event
+   * 
+   * @example
+   * 模型生成事件
+   */
   eventInfo?: string;
   /**
+   * @remarks
+   * session ID
+   * 
    * @example
    * 20247a52-23e2-46fb-943d-309cdee2bc6d
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Job ID
+   * 
    * @example
    * 8a9cecb7-6d20-32db-8823-5882c217b647
    */
   taskId?: string;
   /**
+   * @remarks
+   * End-to-end trace ID
+   * 
    * @example
    * 0bd58ea2-dc38-45da-ac02-17f05cb9040b
    */
@@ -69,36 +94,57 @@ export class RunDocIntroductionResponseBodyHeader extends $dara.Model {
 
 export class RunDocIntroductionResponseBodyPayloadOutputIntroductionsBlocks extends $dara.Model {
   /**
+   * @remarks
+   * Start Time of the segment
+   * 
    * @example
    * 0
    */
   beginTime?: number;
   /**
+   * @remarks
+   * End Time of the segment
+   * 
    * @example
    * 1200
    */
   endTime?: number;
   /**
+   * @remarks
+   * Height of the text block
+   * 
    * @example
    * 600
    */
   height?: number;
   /**
+   * @remarks
+   * Page number where the text block is located
+   * 
    * @example
    * 10
    */
   pageId?: number;
   /**
+   * @remarks
+   * Width of the text block
+   * 
    * @example
    * 600
    */
   width?: number;
   /**
+   * @remarks
+   * X coordinate of the top-left corner of the block
+   * 
    * @example
    * 10
    */
   x?: number;
   /**
+   * @remarks
+   * Y coordinate of the top-left corner of the block
+   * 
    * @example
    * 10
    */
@@ -137,13 +183,34 @@ export class RunDocIntroductionResponseBodyPayloadOutputIntroductionsBlocks exte
 }
 
 export class RunDocIntroductionResponseBodyPayloadOutputIntroductions extends $dara.Model {
+  /**
+   * @remarks
+   * Array of position information
+   */
   blocks?: RunDocIntroductionResponseBodyPayloadOutputIntroductionsBlocks[];
   /**
+   * @remarks
+   * Starting page number of multiple text blocks
+   * 
    * @example
    * 10
    */
   startPageId?: number;
+  /**
+   * @remarks
+   * Summary of this segment
+   * 
+   * @example
+   * 本段摘要内容
+   */
   summary?: string;
+  /**
+   * @remarks
+   * Title of this segment
+   * 
+   * @example
+   * 本段标题内容
+   */
   title?: string;
   static names(): { [key: string]: string } {
     return {
@@ -176,8 +243,26 @@ export class RunDocIntroductionResponseBodyPayloadOutputIntroductions extends $d
 }
 
 export class RunDocIntroductionResponseBodyPayloadOutput extends $dara.Model {
+  /**
+   * @remarks
+   * Array of segment introductions
+   */
   introductions?: RunDocIntroductionResponseBodyPayloadOutputIntroductions[];
+  /**
+   * @remarks
+   * Key point content
+   * 
+   * @example
+   * 要点1；要点2；
+   */
   keyPoint?: string;
+  /**
+   * @remarks
+   * Outline summary
+   * 
+   * @example
+   * 大纲摘要内容
+   */
   summary?: string;
   static names(): { [key: string]: string } {
     return {
@@ -209,16 +294,25 @@ export class RunDocIntroductionResponseBodyPayloadOutput extends $dara.Model {
 
 export class RunDocIntroductionResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Input token quantity
+   * 
    * @example
    * 100
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Output token quantity
+   * 
    * @example
    * 100
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total token quantity
+   * 
    * @example
    * 200
    */
@@ -249,7 +343,15 @@ export class RunDocIntroductionResponseBodyPayloadUsage extends $dara.Model {
 }
 
 export class RunDocIntroductionResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Outputs
+   */
   output?: RunDocIntroductionResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * token usage
+   */
   usage?: RunDocIntroductionResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -281,9 +383,20 @@ export class RunDocIntroductionResponseBodyPayload extends $dara.Model {
 }
 
 export class RunDocIntroductionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * response header
+   */
   header?: RunDocIntroductionResponseBodyHeader;
+  /**
+   * @remarks
+   * response body
+   */
   payload?: RunDocIntroductionResponseBodyPayload;
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * C9B5BEA6-E8C4-5861-BE37-D906D516510E
    */

package/src/models/RunDocQaRequest.ts

@@ -3,8 +3,18 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class RunDocQaRequestConversationContexts extends $dara.Model {
+  /**
+   * @remarks
+   * Q&A pair content
+   * 
+   * @example
+   * 问答内容
+   */
   content?: string;
   /**
+   * @remarks
+   * Role
+   * 
    * @example
    * user
    */
@@ -33,18 +43,51 @@ export class RunDocQaRequestConversationContexts extends $dara.Model {
 }
 
 export class RunDocQaRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Array of folder IDs for filtering. This parameter takes effect only when SearchSource is set to fromIndexLib.
+   */
   categoryIds?: string[];
+  /**
+   * @remarks
+   * Array of historical context content
+   */
   conversationContexts?: RunDocQaRequestConversationContexts[];
+  /**
+   * @remarks
+   * Array of multiple document IDs
+   */
   docIds?: string[];
+  /**
+   * @remarks
+   * Custom model name defined by the User
+   * 
+   * @example
+   * quanmiao-max、quanmiao-plus
+   */
   modelName?: string;
   /**
    * @remarks
+   * Question
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * 苹果16手机什么时候发布
    */
   query?: string;
+  /**
+   * @remarks
+   * Associated content actively provided by the questioner
+   * 
+   * @example
+   * 关联内容
+   */
   referenceContent?: string;
   /**
    * @remarks
+   * Search source
+   * 
    * This parameter is required.
    * 
    * @example
@@ -53,6 +96,8 @@ export class RunDocQaRequest extends $dara.Model {
   searchSource?: string;
   /**
    * @remarks
+   * Conversation ID
+   * 
    * This parameter is required.
    * 
    * @example
@@ -61,6 +106,8 @@ export class RunDocQaRequest extends $dara.Model {
   sessionId?: string;
   /**
    * @remarks
+   * Alibaba Cloud Model Studio workspace ID. For details on how to obtain it, see [How to Use Workspaces](https://help.aliyun.com/document_detail/2587495.html).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RunDocQaResponseBody.ts

@@ -4,32 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class RunDocQaResponseBodyHeader extends $dara.Model {
   /**
+   * @remarks
+   * error code
+   * 
    * @example
    * success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * error message
+   * 
    * @example
    * success
    */
   errorMessage?: string;
   /**
+   * @remarks
+   * management event
+   * 
    * @example
    * task-started
    */
   event?: string;
+  /**
+   * @remarks
+   * Description of the management event
+   * 
+   * @example
+   * 模型生成事件
+   */
   eventInfo?: string;
   /**
+   * @remarks
+   * Session ID
+   * 
    * @example
    * f5517ee8-dbec-4dc8-bd0a-af084b5e3db1
    */
   sessionId?: string;
   /**
+   * @remarks
+   * Job ID
+   * 
    * @example
    * 3f7045e099474ba28ceca1b4eb6d6e21
    */
   taskId?: string;
   /**
+   * @remarks
+   * End-to-end trace ID
+   * 
    * @example
    * 46e5c2b5-0877-4f09-bd91-ab0cf314e48b
    */
@@ -69,11 +94,17 @@ export class RunDocQaResponseBodyHeader extends $dara.Model {
 
 export class RunDocQaResponseBodyPayloadOutputMediaUrlListClipInfos extends $dara.Model {
   /**
+   * @remarks
+   * Start time of the video segment
+   * 
    * @example
    * 0
    */
   from?: number;
   /**
+   * @remarks
+   * End time of the video segment
+   * 
    * @example
    * 30
    */
@@ -102,13 +133,23 @@ export class RunDocQaResponseBodyPayloadOutputMediaUrlListClipInfos extends $dar
 }
 
 export class RunDocQaResponseBodyPayloadOutputMediaUrlList extends $dara.Model {
+  /**
+   * @remarks
+   * Array of related video time information
+   */
   clipInfos?: RunDocQaResponseBodyPayloadOutputMediaUrlListClipInfos[];
   /**
+   * @remarks
+   * File URL
+   * 
    * @example
    * https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg
    */
   fileUrl?: string;
   /**
+   * @remarks
+   * Media asset type
+   * 
    * @example
    * video
    */
@@ -142,7 +183,21 @@ export class RunDocQaResponseBodyPayloadOutputMediaUrlList extends $dara.Model {
 }
 
 export class RunDocQaResponseBodyPayloadOutputRecommends extends $dara.Model {
+  /**
+   * @remarks
+   * Title of the recommended content
+   * 
+   * @example
+   * 标题内容
+   */
   title?: string;
+  /**
+   * @remarks
+   * URL of the recommended content
+   * 
+   * @example
+   * 推荐内容url
+   */
   url?: string;
   static names(): { [key: string]: string } {
     return {
@@ -169,18 +224,41 @@ export class RunDocQaResponseBodyPayloadOutputRecommends extends $dara.Model {
 
 export class RunDocQaResponseBodyPayloadOutputReferences extends $dara.Model {
   /**
+   * @remarks
+   * Published At
+   * 
    * @example
    * 2024-10-08 18:00
    */
   pubTime?: string;
+  /**
+   * @remarks
+   * Source
+   * 
+   * @example
+   * 新浪新闻
+   */
   source?: string;
   /**
+   * @remarks
+   * Source docId
+   * 
    * @example
    * 123456
    */
   sourceDocId?: string;
+  /**
+   * @remarks
+   * Title of the associated content
+   * 
+   * @example
+   * 标题内容
+   */
   title?: string;
   /**
+   * @remarks
+   * Article URL
+   * 
    * @example
    * http://xxxxx
    */
@@ -215,15 +293,44 @@ export class RunDocQaResponseBodyPayloadOutputReferences extends $dara.Model {
 }
 
 export class RunDocQaResponseBodyPayloadOutput extends $dara.Model {
+  /**
+   * @remarks
+   * Content of the response
+   * 
+   * @example
+   * 回答内容
+   */
   content?: string;
+  /**
+   * @remarks
+   * Response content after intervention
+   * 
+   * @example
+   * 干预后的回答内容
+   */
   interveneContent?: string;
   /**
+   * @remarks
+   * Indicates whether the request is rejected
+   * 
    * @example
    * false
    */
   isReject?: boolean;
+  /**
+   * @remarks
+   * List of multimodal resource information
+   */
   mediaUrlList?: RunDocQaResponseBodyPayloadOutputMediaUrlList[];
+  /**
+   * @remarks
+   * Array of recommended content
+   */
   recommends?: RunDocQaResponseBodyPayloadOutputRecommends[];
+  /**
+   * @remarks
+   * Array of sources for the response content
+   */
   references?: RunDocQaResponseBodyPayloadOutputReferences[];
   static names(): { [key: string]: string } {
     return {
@@ -267,16 +374,25 @@ export class RunDocQaResponseBodyPayloadOutput extends $dara.Model {
 
 export class RunDocQaResponseBodyPayloadUsage extends $dara.Model {
   /**
+   * @remarks
+   * Quantity of input tokens
+   * 
    * @example
    * 100
    */
   inputTokens?: number;
   /**
+   * @remarks
+   * Number of tokens used in the output
+   * 
    * @example
    * 100
    */
   outputTokens?: number;
   /**
+   * @remarks
+   * Total number of tokens
+   * 
    * @example
    * 200
    */
@@ -307,7 +423,15 @@ export class RunDocQaResponseBodyPayloadUsage extends $dara.Model {
 }
 
 export class RunDocQaResponseBodyPayload extends $dara.Model {
+  /**
+   * @remarks
+   * Outputs
+   */
   output?: RunDocQaResponseBodyPayloadOutput;
+  /**
+   * @remarks
+   * token usage
+   */
   usage?: RunDocQaResponseBodyPayloadUsage;
   static names(): { [key: string]: string } {
     return {
@@ -339,9 +463,20 @@ export class RunDocQaResponseBodyPayload extends $dara.Model {
 }
 
 export class RunDocQaResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * response header
+   */
   header?: RunDocQaResponseBodyHeader;
+  /**
+   * @remarks
+   * response body
+   */
   payload?: RunDocQaResponseBodyPayload;
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 1813ceee-7fe5-41b4-87e5-982a4d18cca5
    */