@alicloud/dms20250414 2.0.0 → 2.1.1

package/src/models/CreateDataAgentSessionResponseBody.ts

@@ -14,10 +14,8 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   /**
    * @remarks
    * The stage of the custom agent. Valid values:
-   * 
-   * - **debug**: Debug stage
-   * 
-   * - **prod**: Production stage
+   * - **debug**: the debugging stage.
+   * - **prod**: the production stage.
    * 
    * @example
    * debug
@@ -25,22 +23,38 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   customAgentStage?: string;
   /**
    * @remarks
-   * Indicates whether web search is enabled.
+   * Specifies whether to enable web search.
    * 
    * @example
    * true
    */
   enableSearch?: boolean;
+  /**
+   * @remarks
+   * The encryption key.
+   * 
+   * @example
+   * null
+   */
   encryptKey?: string;
+  /**
+   * @remarks
+   * The encryption type.
+   * 
+   * @example
+   * null
+   */
   encryptType?: string;
+  /**
+   * @remarks
+   * The list of knowledge base IDs.
+   */
   kbUuidList?: string[];
   /**
    * @remarks
    * The language. Valid values:
-   * 
-   * - **CHINESE**: Chinese
-   * 
-   * - **ENGLISH**: English
+   * - **CHINESE**: Chinese.
+   * - **ENGLISH**: English.
    * 
    * @example
    * CHINESE
@@ -48,30 +62,39 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
   language?: string;
   /**
    * @remarks
-   * A list of MCP server IDs.
+   * The list of MCP server IDs in the session configuration.
    */
   mcpServerIds?: string[];
   /**
    * @remarks
    * The mode. Valid values:
-   * 
-   * - **ASK_DATA**: Quick Inquiry Mode
-   * 
-   * - **ANALYSIS**: Analysis Mode
-   * 
-   * - **INSIGHT**: Insight Mode
+   *  - **ASK_DATA**: the data query mode.
+   *  - **ANALYSIS**: the analysis mode.
+   *  - **INSIGHT**: the insight mode.
    * 
    * @example
    * ANALYSIS
    */
   mode?: string;
+  /**
+   * @remarks
+   * The report page width.
+   * 
+   * @example
+   * 0
+   */
   reportPageWidth?: number;
-  reportWaterMark?: string;
   /**
    * @remarks
-   * The name of the user\\"s OSS bucket.
+   * The report watermark.
    * 
-   * - Analysis files and report artifacts can be uploaded to this OSS bucket.
+   * @example
+   * null
+   */
+  reportWaterMark?: string;
+  /**
+   * @remarks
+   * The name of the user OSS bucket. Analysis process files and report artifacts can be uploaded to the specified OSS bucket.
    * 
    * @example
    * user-oss-bucket
@@ -129,7 +152,7 @@ export class CreateDataAgentSessionResponseBodyDataSessionConfig extends $dara.M
 export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The agent ID.
+   * Agent Id
    * 
    * @example
    * cu0cs*******mf
@@ -145,7 +168,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   agentStatus?: string;
   /**
    * @remarks
-   * The time when the session was created, in Unix milliseconds.
+   * The creation time of the session.
    * 
    * @example
    * 1765262307992
@@ -153,7 +176,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   createTime?: number;
   /**
    * @remarks
-   * The ID of the associated file.
+   * The basic information of the file.
    * 
    * @example
    * f-8*******01m
@@ -161,7 +184,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   file?: string;
   /**
    * @remarks
-   * Indicates whether the current user has favorited the session.
+   * Indicates whether the session is saved to the favorites of the current user.
    * 
    * @example
    * false
@@ -190,10 +213,10 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
   sessionStatus?: string;
   /**
    * @remarks
-   * The session title.
+   * The title.
    * 
    * @example
-   * 帮我分析一下这份数据，给出报告。
+   * Help me analyze this data and generate a report
    */
   title?: string;
   static names(): { [key: string]: string } {
@@ -239,7 +262,7 @@ export class CreateDataAgentSessionResponseBodyData extends $dara.Model {
 export class CreateDataAgentSessionResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The response structure.
+   * The response struct.
    */
   data?: CreateDataAgentSessionResponseBodyData;
   /**
@@ -252,7 +275,7 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned if the request fails.
+   * The error message returned if the request failed.
    * 
    * @example
    * UnknownError
@@ -260,7 +283,7 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
   errorMessage?: string;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * 1CB***********3F1A
@@ -271,7 +294,6 @@ export class CreateDataAgentSessionResponseBody extends $dara.Model {
    * Indicates whether the request was successful. Valid values:
    * 
    * - **true**: The request was successful.
-   * 
    * - **false**: The request failed.
    * 
    * @example

package/src/models/CreateDataAgentSessionShrinkRequest.ts

@@ -26,10 +26,10 @@ export class CreateDataAgentSessionShrinkRequest extends $dara.Model {
   sessionConfigShrink?: string;
   /**
    * @remarks
-   * The session title. Supports Chinese and English. Maximum length: 128 characters.
+   * The title. Chinese and English characters are supported. Maximum length: 128 characters.
    * 
    * @example
-   * 帮我分析一下这份数据，给出报告。
+   * Help me analyze this data and generate a report
    */
   title?: string;
   /**

package/src/models/CreateDataAgentThemeRequest.ts

@@ -5,11 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataAgentThemeRequest extends $dara.Model {
   /**
    * @remarks
-   * The application scenario, which affects filtering when viewing the theme list in the console. Valid values:
+   * The scenario, which affects the filtering when you view the theme list in the console. Valid values:
    * 
-   * - (Recommended) custom: a user-uploaded custom theme with no preset style or information organization structure.
-   * - report: a web report that conforms to the DataAgent information organization structure.
-   * - (Not supported) infographic: an infographic that conforms to the DataAgent information organization structure.
+   * - (Recommended) custom: A user-uploaded custom theme with no preset style or information organization structure.
+   * - report: A web report that conforms to the DataAgent information organization structure.
+   * - (Not supported) infographic: An infographic that conforms to the DataAgent information organization structure.
    * 
    * @example
    * custom
@@ -27,9 +27,9 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
    * @remarks
    * The file source, which affects the backend logic for determining whether the theme is valid. Valid values:
    * 
-   * - upload: uploaded through OSS.
-   * - (Not supported) public_url: provided through an OSS URL that allows public network access.
-   * - (Not supported) user_oss: provided through a user OSS URL.
+   * - upload: The file is uploaded through OSS.
+   * - (Not supported) public_url: The file is provided through a public network access OSS URL.
+   * - (Not supported) user_oss: The file is provided through a user OSS URL.
    * 
    * @example
    * upload
@@ -45,7 +45,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
   themeId?: string;
   /**
    * @remarks
-   * The display name of the theme. The value can be up to 64 characters in length. This parameter is required during creation.
+   * The display name of the theme. The value can be up to 64 characters in length. This parameter is required when you create a theme.
    * 
    * @example
    * weekly report
@@ -62,6 +62,14 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
    * template
    */
   themeType?: string;
+  /**
+   * @remarks
+   * The workspace to which the theme belongs. If this parameter is not specified or is set to personal, the personal workspace is used. You can also specify a collaboration workspace ID.
+   * 
+   * @example
+   * 99fad******qg6c0l4nlacu
+   */
+  workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
       category: 'Category',
@@ -70,6 +78,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
       themeId: 'ThemeId',
       themeName: 'ThemeName',
       themeType: 'ThemeType',
+      workspaceId: 'WorkspaceId',
     };
   }
 
@@ -81,6 +90,7 @@ export class CreateDataAgentThemeRequest extends $dara.Model {
       themeId: 'string',
       themeName: 'string',
       themeType: 'string',
+      workspaceId: 'string',
     };
   }
 

package/src/models/CreateDataAgentThemeResponseBody.ts

@@ -47,7 +47,7 @@ export class CreateDataAgentThemeResponseBody extends $dara.Model {
   data?: CreateDataAgentThemeResponseBodyData;
   /**
    * @remarks
-   * The error code returned when the request is abnormal.
+   * The error code returned when the request fails.
    * 
    * @example
    * UnknownError
@@ -55,7 +55,7 @@ export class CreateDataAgentThemeResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned when the request fails.
    * 
    * @example
    * UnknownError

package/src/models/DescribeDataAgentSessionRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDataAgentSessionRequest extends $dara.Model {
   /**
    * @remarks
-   * The current Data Management unit.
+   * The current DMS unit.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeDataAgentSessionResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
   description?: string;
   /**
    * @remarks
-   * The time when the backend completed the artifact task. This is a UNIX timestamp accurate to the second.
+   * The time when the backend completed the artifact task. The value is a UNIX timestamp accurate to seconds.
    * 
    * @example
    * 1778743587
@@ -21,7 +21,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
   finishTime?: string;
   /**
    * @remarks
-   * The globally unique artifact ID. If the report is produced by calling SendChatMessage with MessageType set to REPORT, the artifact ID is the same as the MessageId in the response of the SendChatMessage operation.
+   * The artifact ID, which is globally unique. If the report is produced by calling SendChatMessage with MessageType set to REPORT, the artifact ID is the same as the MessageId in the response of the SendChatMessage operation.
    * 
    * @example
    * bab******33e1
@@ -29,7 +29,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
   id?: string;
   /**
    * @remarks
-   * The artifact name. This is typically a string concatenated by the system and is aligned with the name field in the ListFileUpload operation. You can use this field to query the download URL of the artifact file.
+   * The artifact name, which is typically a string concatenated by the system. This name is aligned with the name field in the ListFileUpload operation. You can use this field to query the download URL of the artifact file.
    * 
    * @example
    * report_****_2026****
@@ -37,7 +37,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
   name?: string;
   /**
    * @remarks
-   * The time when the backend received the artifact request. This is a UNIX timestamp accurate to the second.
+   * The time when the backend received the artifact request. The value is a UNIX timestamp accurate to seconds.
    * 
    * @example
    * 1778743587
@@ -45,7 +45,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
   receiveTime?: string;
   /**
    * @remarks
-   * The time when the backend actually started running the artifact task. This is a UNIX timestamp accurate to the second.
+   * The time when the backend actually started running the artifact task. The value is a UNIX timestamp accurate to seconds.
    * 
    * @example
    * 1778743587
@@ -113,7 +113,7 @@ export class DescribeDataAgentSessionResponseBodyDataArtifacts extends $dara.Mod
 export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extends $dara.Model {
   /**
    * @remarks
-   * The key of the chat replay history.
+   * The key of the chat history replay record.
    * 
    * @example
    * testKey1
@@ -121,7 +121,7 @@ export class DescribeDataAgentSessionResponseBodyDataChatHistoryLocations extend
   key?: string;
   /**
    * @remarks
-   * The OSS download URL of the chat replay history.
+   * The OSS download URL of the chat history replay record.
    * 
    * @example
    * ****
@@ -155,9 +155,9 @@ export class DescribeDataAgentSessionResponseBodyDataDataSources extends $dara.M
    * @remarks
    * The data source category. Valid values:
    * 
-   * - **CHAT**: specified through the CreateDataAgentSession or SendChatMessage operation during a conversation.
+   * - **CHAT**: Specified through the CreateDataAgentSession or SendChatMessage operation during a conversation.
    * 
-   * - **CUSTOM_AGENT**: from the preset analysis data scope in a custom agent.
+   * - **CUSTOM_AGENT**: From the preset analysis data scope in a custom agent.
    * 
    * @example
    * CHAT
@@ -207,7 +207,7 @@ export class DescribeDataAgentSessionResponseBodyDataRecallResults extends $dara
   content?: string;
   /**
    * @remarks
-   * The similarity score of this data entry. The scoring algorithm is related to the algorithm (l2/ip/cosine) specified when the index was created.
+   * The similarity score of this record. The scoring algorithm is related to the algorithm (l2/ip/cosine) specified when the index was created.
    * 
    * @example
    * 0.65
@@ -258,8 +258,8 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   /**
    * @remarks
    * The stage of the custom agent. Valid values:
-   * - **debug**: test stage.
-   * - **prod**: production stage.
+   * - **debug**: The debug stage.
+   * - **prod**: The production stage.
    * 
    * @example
    * debug
@@ -312,9 +312,9 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   /**
    * @remarks
    * The mode. Valid values:
-   *  - **ASK_DATA**: ask data mode.
-   *  - **ANALYSIS**: analysis mode.
-   *  - **INSIGHT**: insight mode.
+   * - **ASK_DATA**: The ask-data mode.
+   * - **ANALYSIS**: The analysis mode.
+   * - **INSIGHT**: The insight mode.
    * 
    * @example
    * ANALYSIS
@@ -338,8 +338,7 @@ export class DescribeDataAgentSessionResponseBodyDataSessionConfig extends $dara
   reportWaterMark?: string;
   /**
    * @remarks
-   * The name of the user OSS bucket.
-   * - Analysis process files and report artifacts can be uploaded to the user-specified OSS bucket.
+   * The name of the user OSS bucket. Analysis process files and report artifacts can be uploaded to the user-specified OSS bucket.
    * 
    * @example
    * user-oss-bucket
@@ -418,7 +417,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
   artifacts?: DescribeDataAgentSessionResponseBodyDataArtifacts[];
   /**
    * @remarks
-   * The chat replay history.
+   * The chat history replay records.
    */
   chatHistoryLocations?: DescribeDataAgentSessionResponseBodyDataChatHistoryLocations[];
   /**
@@ -489,7 +488,7 @@ export class DescribeDataAgentSessionResponseBodyData extends $dara.Model {
    * The title.
    * 
    * @example
-   * 分析一下这份文件，给出报告。
+   * Analyze this file and generate a report
    */
   title?: string;
   /**
@@ -598,7 +597,7 @@ export class DescribeDataAgentSessionResponseBody extends $dara.Model {
    * @remarks
    * The return value. Valid values:
    * 
-   * - **true**: Succeeded.
+   * - **true**: Successful.
    * - **false**: Failed.
    * 
    * @example

package/src/models/DescribeDataAgentThemeResponseBody.ts

@@ -37,7 +37,7 @@ export class DescribeDataAgentThemeResponseBodyData extends $dara.Model {
   modifiedAt?: string;
   /**
    * @remarks
-   * The theme tracing information. This field is currently not enabled.
+   * The tracing information of the theme. This field is currently not enabled.
    * 
    * @example
    * 6d1e3f9a-****-****-****-2b8c4e6f0a1d
@@ -45,10 +45,7 @@ export class DescribeDataAgentThemeResponseBodyData extends $dara.Model {
   referTo?: string;
   /**
    * @remarks
-   * The source of the theme. Valid values:
-   * 
-   * - system
-   * - custom
+   * The source of the theme. Valid values: system, custom.
    * 
    * @example
    * custom
@@ -72,10 +69,9 @@ export class DescribeDataAgentThemeResponseBodyData extends $dara.Model {
   themeName?: string;
   /**
    * @remarks
-   * The theme stage. Valid values:
-   * 
-   * - design: design.md only.
-   * - template: complete and renderable.
+   * The stage of the theme. Valid values:
+   * - design: The theme contains only design.md.
+   * - template: The theme is complete and renderable.
    * 
    * @example
    * template
@@ -126,7 +122,7 @@ export class DescribeDataAgentThemeResponseBody extends $dara.Model {
   data?: DescribeDataAgentThemeResponseBodyData;
   /**
    * @remarks
-   * The error code returned when the request is abnormal.
+   * The error code returned when the request fails.
    * 
    * @example
    * UnknownError
@@ -150,10 +146,10 @@ export class DescribeDataAgentThemeResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. Valid values:
+   * Indicates whether the request is successful. Valid values:
    * 
-   * - **true**: The request was successful.
-   * - **false**: The request failed.
+   * - **true**: The request is successful.
+   * - **false**: The request fails.
    */
   success?: boolean;
   static names(): { [key: string]: string } {

package/src/models/GetDataAgentThemeUploadSignatureRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDataAgentThemeUploadSignatureRequest extends $dara.Model {
   /**
    * @remarks
-   * The theme UUID. By default, you do not need to specify this parameter because the backend automatically generates and returns a UUID. Specify this parameter to regenerate a signature only when the previous signature has expired.
+   * The UUID of the theme. By default, you do not need to specify this parameter because the backend automatically generates and returns a UUID. Specify this parameter to regenerate the signature only when the previous signature has expired.
    * 
    * @example
    * 0f8b2c1d-****-****-****-9a3e5f7b1c2d

package/src/models/GetDataAgentThemeUploadSignatureResponseBody.ts

@@ -13,7 +13,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   expireTime?: string;
   /**
    * @remarks
-   * The target object key, which is exactly locked by the policy.
+   * The target object key that is exactly locked by the policy.
    */
   objectKey?: string;
   /**
@@ -63,7 +63,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   policy?: string;
   /**
    * @remarks
-   * The theme business identifier generated or reused for this request. Pass this identifier to the CreateDataAgentTheme operation after the upload is complete to register the metadata.
+   * The theme business ID generated or reused for this request. After the upload is complete, pass this ID to the CreateDataAgentTheme operation to register the metadata.
    * 
    * @example
    * 0f8b2c1d****a3e5f7b1c2d
@@ -76,7 +76,7 @@ export class GetDataAgentThemeUploadSignatureResponseBodyData extends $dara.Mode
   uploadDir?: string;
   /**
    * @remarks
-   * The PostObject destination address over the public network.
+   * The PostObject target address over the public network.
    * 
    * @example
    * https://**********.oss-cn-hangzhou.aliyuncs.com
@@ -131,7 +131,7 @@ export class GetDataAgentThemeUploadSignatureResponseBody extends $dara.Model {
   data?: GetDataAgentThemeUploadSignatureResponseBodyData;
   /**
    * @remarks
-   * The error code returned when the request fails.
+   * The error code. This parameter is returned only if the request fails.
    * 
    * @example
    * UnknownError
@@ -139,7 +139,7 @@ export class GetDataAgentThemeUploadSignatureResponseBody extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the request fails.
    * 
    * @example
    * UnknownError

package/src/models/ListDataAgentAccuracyTestInstancesResponseBody.ts

@@ -27,6 +27,13 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
    * 20282*****7591
    */
   creator?: string;
+  /**
+   * @remarks
+   * The data source.
+   * 
+   * @example
+   * null
+   */
   datasource?: string;
   /**
    * @remarks
@@ -81,12 +88,12 @@ export class ListDataAgentAccuracyTestInstancesResponseBodyData extends $dara.Mo
    * The custom agent name.
    * 
    * @example
-   * Agent测试名称
+   * AgentTestName
    */
   name?: string;
   /**
    * @remarks
-   * Specifies whether sessions are displayed after analysis. This parameter is not supported.
+   * Specifies whether sessions are displayed after analysis. This feature is not supported.
    * 
    * @example
    * true

package/src/models/ListDataAgentThemeRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListDataAgentThemeRequest extends $dara.Model {
   /**
    * @remarks
-   * The common scenarios. Valid values: report, infographic, and others.
+   * The common scenario of the theme. Valid values: report, infographic, and others.
    * 
    * @example
    * report
@@ -13,7 +13,7 @@ export class ListDataAgentThemeRequest extends $dara.Model {
   category?: string;
   /**
    * @remarks
-   * **[Not supported]** The page size. Maximum value: 100.
+   * **[Not currently supported]** The maximum number of entries per page. Maximum value: 100.
    * 
    * @example
    * 20
@@ -21,10 +21,10 @@ export class ListDataAgentThemeRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * **[Not supported]** The pagination token for the next query. Valid values:
+   * **[Not currently supported]** The pagination token for the next query. Valid values:
    * 
    * - If **NextToken** is empty, no next query exists.
-   * - If **NextToken** has a return value, the value indicates the token for the next query.
+   * - If **NextToken** has a return value, the value is the token for the next query.
    * 
    * @example
    * f056501ada12****
@@ -40,7 +40,7 @@ export class ListDataAgentThemeRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The current page size.
+   * The number of entries per page.
    * 
    * @example
    * 10
@@ -62,13 +62,21 @@ export class ListDataAgentThemeRequest extends $dara.Model {
    * @remarks
    * The theme stage. Valid values:
    * 
-   * - design: contains only design.md.
-   * - template: complete and renderable.
+   * - design: The theme contains only design.md.
+   * - template: The theme is complete and renderable.
    * 
    * @example
    * template
    */
   themeType?: string;
+  /**
+   * @remarks
+   * The workspace context. If this parameter is left empty or set to personal, the personal workspace is used. To query themes in a collaborative workspace, specify the workspace ID.
+   * 
+   * @example
+   * 99fad*******6c0l4nlacu
+   */
+  workspaceId?: string;
   static names(): { [key: string]: string } {
     return {
       category: 'Category',
@@ -78,6 +86,7 @@ export class ListDataAgentThemeRequest extends $dara.Model {
       pageSize: 'PageSize',
       themeFrom: 'ThemeFrom',
       themeType: 'ThemeType',
+      workspaceId: 'WorkspaceId',
     };
   }
 
@@ -90,6 +99,7 @@ export class ListDataAgentThemeRequest extends $dara.Model {
       pageSize: 'number',
       themeFrom: 'string',
       themeType: 'string',
+      workspaceId: 'string',
     };
   }