@alicloud/websitebuild20250429 2.25.0 → 2.26.1

package/src/models/ListAistaffChatMessagesResponseBody.ts

@@ -4,67 +4,121 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAIStaffChatMessagesResponseBodyModuleMessages extends $dara.Model {
   /**
+   * @remarks
+   * Bot ID.
+   * 
    * @example
    * Zero2
    */
   botId?: string;
   /**
+   * @remarks
+   * Current conversation round ID
+   * 
    * @example
    * 54a0bfa0-41bd-4e96-acd9-fb13c0474452
    */
   chatId?: string;
   /**
+   * @remarks
+   * Current session status
+   * 
    * @example
    * success
    */
   chatStatus?: string;
   /**
+   * @remarks
+   * ID of the invoked data class API.
+   * 
    * @example
    * domain cnamenwww.buyhao8.com www.buyhao8.com.a1.initrr.comn
    */
   content?: string;
   /**
+   * @remarks
+   * Content type
+   * 
    * @example
    * application/octet-stream
    */
   contentType?: string;
   /**
+   * @remarks
+   * Session ID
+   * 
    * @example
    * job-675163021891846144
    */
   conversationId?: string;
   /**
+   * @remarks
+   * Creation Time
+   * 
    * @example
    * 1723532098
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * Updated At
+   * 
    * @example
    * 1591339051000
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * Message ID
+   * 
    * @example
    * 1dafa033-e72b-44c2-99b7-bc202c5b6198
    */
   messageId?: string;
+  /**
+   * @remarks
+   * Business extension metadata (in Map format, must be a JSON string)
+   */
   metaData?: { [key: string]: any };
   /**
+   * @remarks
+   * Indicates the role of the participant in the conversation. Valid values include:
+   * 
+   * - user: User
+   * 
+   * - assistant: Assistant
+   * 
+   * - system: System
+   * - function: Function
+   * 
+   * - plugin: Plugin
+   * 
+   * - tool: Tool
+   * 
    * @example
    * user
    */
   role?: string;
   /**
+   * @remarks
+   * Section ID of the inspection item.
+   * 
    * @example
    * 324
    */
   sectionId?: string;
   /**
+   * @remarks
+   * Site ID.
+   * 
    * @example
    * 928636774795776
    */
   siteId?: string;
   /**
+   * @remarks
+   * File type
+   * 
    * @example
    * SINGLE
    */
@@ -120,6 +174,15 @@ export class ListAIStaffChatMessagesResponseBodyModuleMessages extends $dara.Mod
 }
 
 export class ListAIStaffChatMessagesResponseBodyModule extends $dara.Model {
+  /**
+   * @remarks
+   * Sender type.  
+   * 
+   * Enumeration values:  
+   * - **ADMIN**: System  
+   * - **CUSTOMER**: Visitor  
+   * - **AGENT**: Agent
+   */
   messages?: ListAIStaffChatMessagesResponseBodyModuleMessages[];
   static names(): { [key: string]: string } {
     return {
@@ -147,31 +210,54 @@ export class ListAIStaffChatMessagesResponseBodyModule extends $dara.Model {
 
 export class ListAIStaffChatMessagesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Permission denied information
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * Is retry allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App Name.
+   * 
    * @example
    * or
    */
   appName?: string;
   /**
+   * @remarks
+   * Dynamic error code.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * Dynamic message. Not currently used. Please ignore.
+   * 
    * @example
    * SYSTEM_ERROR
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * Returned error parameters
+   */
   errorArgs?: any[];
+  /**
+   * @remarks
+   * Response data
+   */
   module?: ListAIStaffChatMessagesResponseBodyModule;
   /**
    * @remarks
@@ -182,12 +268,25 @@ export class ListAIStaffChatMessagesResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.ERROR
    */
   rootErrorCode?: string;
+  /**
+   * @remarks
+   * Abnormal message
+   * 
+   * @example
+   * 系统异常
+   */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Reserved parameter.
+   * 
    * @example
    * True
    */

package/src/models/ListAppAssistantAgentsRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAppAssistantAgentsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Business ID
+   * 
    * @example
    * WD20250703155602000001
    */
   bizId?: string;
   /**
+   * @remarks
+   * Platform Type
+   * 
    * @example
    * ChannelOps
    */

package/src/models/ListAppAssistantAgentsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAppAssistantAgentsResponseBodyModuleCredential extends $dara.Model {
   /**
    * @remarks
-   * API Key
+   * API key
    * 
    * @example
    * akm-xxxxxxx
@@ -19,13 +19,23 @@ export class ListAppAssistantAgentsResponseBodyModuleCredential extends $dara.Mo
    * sk-xxxxxx
    */
   apiSecret?: string;
+  /**
+   * @remarks
+   * Extension field
+   */
   extra?: { [key: string]: string };
   /**
+   * @remarks
+   * Password
+   * 
    * @example
    * ***
    */
   password?: string;
   /**
+   * @remarks
+   * Username
+   * 
    * @example
    * Test
    */
@@ -63,7 +73,15 @@ export class ListAppAssistantAgentsResponseBodyModuleCredential extends $dara.Mo
 }
 
 export class ListAppAssistantAgentsResponseBodyModuleEmbedConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Extension fields
+   */
   extra?: { [key: string]: string };
+  /**
+   * @remarks
+   * Raw embed script
+   */
   rawScript?: string;
   static names(): { [key: string]: string } {
     return {
@@ -93,45 +111,88 @@ export class ListAppAssistantAgentsResponseBodyModuleEmbedConfig extends $dara.M
 
 export class ListAppAssistantAgentsResponseBodyModule extends $dara.Model {
   /**
+   * @remarks
+   * Agent ID (returned by the platform)
+   * 
    * @example
    * liyang1_v@soulapp
    */
   agentId?: string;
+  /**
+   * @remarks
+   * Agent Name
+   * 
+   * @example
+   * 演示
+   */
   agentName?: string;
   /**
+   * @remarks
+   * bizId of the associated application instance
+   * 
    * @example
    * WD20250703155602000001
    */
   bizId?: string;
+  /**
+   * @remarks
+   * Credential
+   */
   credential?: ListAppAssistantAgentsResponseBodyModuleCredential;
+  /**
+   * @remarks
+   * Embed configuration
+   */
   embedConfig?: ListAppAssistantAgentsResponseBodyModuleEmbedConfig;
+  /**
+   * @remarks
+   * Extension parameters
+   */
   extraParams?: { [key: string]: string };
   /**
+   * @remarks
+   * Creation Time
+   * 
    * @example
    * 1740479834
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * Updated At
+   * 
    * @example
    * 2025-08-28T02:25:41Z
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * Agent platform appId
+   * 
    * @example
    * WA12313123131
    */
   platformAppId?: string;
   /**
+   * @remarks
+   * Platform Type
+   * 
    * @example
    * VMWARE
    */
   platformType?: string;
   /**
+   * @remarks
+   * Status
+   * 
    * @example
    * NORMAL
    */
   status?: string;
   /**
+   * @remarks
+   * User ID
+   * 
    * @example
    * 1231311312
    */
@@ -190,31 +251,55 @@ export class ListAppAssistantAgentsResponseBodyModule extends $dara.Model {
 
 export class ListAppAssistantAgentsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The detailed reason why access was denied.
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * is retry allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App Name.
+   * 
    * @example
    * spring-cloud-b
    */
   appName?: string;
   /**
+   * @remarks
+   * dynamic error code.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * dynamic error message, used to replace the `%s` placeholder in the **ErrMessage** error message.  
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, it indicates that the request parameter **DtsJobId** is invalid.
+   * 
    * @example
    * SYSTEM_ERROR
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * Returned error parameters
+   */
   errorArgs?: any[];
+  /**
+   * @remarks
+   * response Data
+   */
   module?: ListAppAssistantAgentsResponseBodyModule[];
   /**
    * @remarks
@@ -225,12 +310,25 @@ export class ListAppAssistantAgentsResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.ERROR
    */
   rootErrorCode?: string;
+  /**
+   * @remarks
+   * abnormal message
+   * 
+   * @example
+   * 系统异常
+   */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Reserved parameter.
+   * 
    * @example
    * True
    */

package/src/models/ListAppChatMessagesRequest.ts

@@ -4,26 +4,43 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAppChatMessagesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Chat ID
+   * 
    * @example
    * 20833ba4-d189-4c50-9a44-a6bcbda2c93b
    */
   chatId?: string;
   /**
+   * @remarks
+   * Session ID
+   * 
    * @example
    * 593fe1a2-d0b4-4fde-a2b0-78ad6a438d41
    */
   conversationId?: string;
   /**
+   * @remarks
+   * Number of results per query.  
+   * 
+   * Valid range: 10 to 100. Default Value: 20.
+   * 
    * @example
    * 10
    */
   maxResults?: number;
   /**
+   * @remarks
+   * Token indicating the start of the next query. This value is empty if there is no subsequent query.
+   * 
    * @example
    * FFh3Xqm+JgZ/U9Jyb7wdVr9LWk80Tghn5UZjbcWEVEderBcbVF+Y6PS0i8PpCL4PQZ3e0C9oEH0Asd4tJEuGtkl2WuKdiWZpEwadNydQdJPFM=
    */
   nextToken?: string;
   /**
+   * @remarks
+   * Segment ID
+   * 
    * @example
    * 169
    */

package/src/models/ListAppChatMessagesResponseBody.ts

@@ -4,37 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAppChatMessagesResponseBodyModule extends $dara.Model {
   /**
+   * @remarks
+   * Bot ID
+   * 
    * @example
    * Zero2
    */
   botId?: string;
   /**
+   * @remarks
+   * Unique ID of a single message
+   * 
    * @example
    * chat-xrz3etcl2bsygwlx8g
    */
   chatId?: string;
   /**
+   * @remarks
+   * Current chat status
+   * 
    * @example
    * created
    */
   chatStatus?: string;
   /**
+   * @remarks
+   * ID of the data class API being invoked.
+   * 
    * @example
    * {\\"code\\": \\"200\\", \\"success\\": True, \\"content\\": True, \\"requestId\\": \\"028993DE-097E-5F4E-AC48-64A2D5ED5F30\\", \\"businessError\\": False, \\"message\\": \\"success\\", \\"httpStatusCode\\": 200}
    */
   content?: string;
   /**
+   * @remarks
+   * Content type
+   * 
    * @example
    * image/png
    */
   contentType?: string;
   /**
+   * @remarks
+   * Session ID
+   * 
    * @example
    * 872be9bc-3097-433d-b462-596202455102
    */
   conversationId?: string;
   /**
    * @remarks
+   * Creation Time
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ss.SSSZ
    * 
    * @example
@@ -43,6 +63,8 @@ export class ListAppChatMessagesResponseBodyModule extends $dara.Model {
   gmtCreateTime?: string;
   /**
    * @remarks
+   * Updated At
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ss.SSSZ
    * 
    * @example
@@ -50,36 +72,68 @@ export class ListAppChatMessagesResponseBodyModule extends $dara.Model {
    */
   gmtModifiedTime?: string;
   /**
+   * @remarks
+   * Message ID
+   * 
    * @example
    * ee60f5a6-88ca-4074-ad37-515f065bbbd2
    */
   messageId?: string;
   /**
+   * @remarks
+   * Business extension metadata (in Map format, must be a JSON string)
+   * 
    * @example
    * {\\"appId\\":\\"WS20260506101154000001\\",\\"inputTokens\\":1148,\\"outputTokens\\":60}
    */
   metaData?: string;
   /**
+   * @remarks
+   * Region ordinal number. This parameter is deprecated.
+   * 
    * @example
    * 1
    */
   no?: number;
   /**
+   * @remarks
+   * Indicates the role of the participant in the conversation. Valid values include:
+   * 
+   * - user: User
+   * 
+   * - assistant: Assistant
+   * 
+   * - system: System
+   * - function: Function
+   * 
+   * - plugin: Plugin
+   * 
+   * - tool: Tool
+   * 
    * @example
    * LoC
    */
   role?: string;
   /**
+   * @remarks
+   * Section ID of the checklist item.
+   * 
    * @example
    * 11
    */
   sectionId?: string;
   /**
+   * @remarks
+   * Site ID, which can be obtained by invoking the [ListSites](~~ListSites~~) API.
+   * 
    * @example
    * 865181640657408
    */
   siteId?: string;
   /**
+   * @remarks
+   * File type
+   * 
    * @example
    * IMAGE
    */
@@ -135,38 +189,70 @@ export class ListAppChatMessagesResponseBodyModule extends $dara.Model {
 
 export class ListAppChatMessagesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * permission denied information
+   * 
    * @example
    * {}
    */
   accessDeniedDetail?: string;
   /**
+   * @remarks
+   * is retry allowed
+   * 
    * @example
    * False
    */
   allowRetry?: boolean;
   /**
+   * @remarks
+   * App name.
+   * 
    * @example
    * dewuApp
    */
   appName?: string;
   /**
+   * @remarks
+   * Dynamic error code.
+   * 
    * @example
    * ERROR-oo1
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * dynamic error message used to replace `%s` in the **ErrMessage** error message.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, it indicates that the request parameter **DtsJobId** is invalid.
+   * 
    * @example
-   * abc
+   * xxx
    */
   dynamicMessage?: string;
+  /**
+   * @remarks
+   * returned error parameters
+   */
   errorArgs?: any[];
   /**
+   * @remarks
+   * Number of results per query.
+   * 
+   * Value range: 10 to 100. Default Value: 20.
+   * 
    * @example
    * 10
    */
   maxResults?: number;
+  /**
+   * @remarks
+   * Response data
+   */
   module?: ListAppChatMessagesResponseBodyModule[];
   /**
+   * @remarks
+   * Token for starting the next query. It is empty when there is no next query.
+   * 
    * @example
    * 0l45bkwM022Dt+rOvPi/oQ==
    */
@@ -180,16 +266,25 @@ export class ListAppChatMessagesResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Error code
+   * 
    * @example
    * SYSTEM.EROR
    */
   rootErrorCode?: string;
   /**
+   * @remarks
+   * abnormal message
+   * 
    * @example
    * 系统异常
    */
   rootErrorMsg?: string;
   /**
+   * @remarks
+   * Reserved parameter.
+   * 
    * @example
    * True
    */