@alicloud/cms20240330 9.2.2 → 10.0.0

package/src/models/UpdateAlertWebhookResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAlertWebhookResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8A33DBEA-*****-*****-*****-*****
    */

package/src/models/UpdateBizTraceRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateBizTraceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The advanced configuration.
+   * 
    * @example
    * {"sample":{"strategy":"BY_APP"}}
    */
   advancedConfig?: string;
   /**
+   * @remarks
+   * The name of the business trace.
+   * 
    * @example
    * just test
    */
   bizTraceName?: string;
   /**
+   * @remarks
+   * The list of configuration rules.
+   * 
    * @example
    * [{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]
    */
   ruleConfig?: string;
   /**
+   * @remarks
+   * The workspace.
+   * 
    * @example
    * default-cms-xxxxxxx-cn-hangzhou
    */

package/src/models/UpdateBizTraceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateBizTraceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the business trace.
+   * 
    * @example
    * e339260ed64c95d
    */
   bizTraceId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/UpdateContextRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateContextRequest extends $dara.Model {
   /**
+   * @remarks
+   * The updated text for the long-term memory.
+   * 
    * @example
    * Users prefer to first view the SLS error logs, index configuration, and the most recent Agent execution trace.
    */
   content?: string;
   /**
+   * @remarks
+   * The experience object.
+   * 
    * @example
    * {
    * 	"taskType": "troubleshooting",
@@ -18,11 +24,17 @@ export class UpdateContextRequest extends $dara.Model {
    */
   experience?: { [key: string]: any };
   /**
+   * @remarks
+   * A set of key-value pairs to attach to an object for storing custom information.
+   * 
    * @example
    * {"sessionId":"test_session_001"}
    */
   metadata?: { [key: string]: any };
   /**
+   * @remarks
+   * The payload to update.
+   * 
    * @example
    * {
    *     "userId": "u-10001",
@@ -40,6 +52,9 @@ export class UpdateContextRequest extends $dara.Model {
    */
   payload?: { [key: string]: any };
   /**
+   * @remarks
+   * The trigger condition.
+   * 
    * @example
    * Identify and troubleshoot SLs issues
    */

package/src/models/UpdateContextStoreRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateContextStoreRequestConfigSource extends $dara.Model {
   /**
+   * @remarks
+   * The Log Service Logstore name.
+   * 
    * @example
    * sls-test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The Log Service Project name.
+   * 
    * @example
    * sls-test-project
    */
   project?: string;
   /**
+   * @remarks
+   * The start time.
+   * 
    * @example
    * 1776824891000
    */
@@ -44,7 +53,15 @@ export class UpdateContextStoreRequestConfigSource extends $dara.Model {
 }
 
 export class UpdateContextStoreRequestConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The metadata field.
+   */
   metadataField?: { [key: string]: string };
+  /**
+   * @remarks
+   * The data source.
+   */
   source?: UpdateContextStoreRequestConfigSource;
   static names(): { [key: string]: string } {
     return {
@@ -77,6 +94,9 @@ export class UpdateContextStoreRequestConfig extends $dara.Model {
 
 export class UpdateContextStoreRequestDataset extends $dara.Model {
   /**
+   * @remarks
+   * The dataset name.
+   * 
    * @example
    * test_dataset
    */
@@ -103,14 +123,28 @@ export class UpdateContextStoreRequestDataset extends $dara.Model {
 }
 
 export class UpdateContextStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration.
+   */
   config?: UpdateContextStoreRequestConfig;
   /**
+   * @remarks
+   * The context type.
+   * 
    * @example
    * memory
    */
   contextType?: string;
+  /**
+   * @remarks
+   * The dataset.
+   */
   dataset?: UpdateContextStoreRequestDataset;
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * test
    */

package/src/models/UpdateContextStoreResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateContextStoreResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */

package/src/models/UpdateDatasetRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDatasetRequest extends $dara.Model {
   /**
+   * @remarks
+   * The new description for the dataset.
+   * 
    * @example
    * test dataset
    */

package/src/models/UpdateDatasetResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateDatasetResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */

package/src/models/UpdateDeliveryTaskRequest.ts

@@ -3,8 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class UpdateDeliveryTaskRequestSinkList extends $dara.Model {
+  /**
+   * @remarks
+   * The detailed configuration of the sink. The meaning of the key-value pairs depends on the specified sinkType.
+   */
   sinkConfigs?: { [key: string]: string };
   /**
+   * @remarks
+   * The sink type.
+   * 
    * @example
    * Prometheus
    * 
@@ -40,34 +47,64 @@ export class UpdateDeliveryTaskRequestSinkList extends $dara.Model {
 
 export class UpdateDeliveryTaskRequest extends $dara.Model {
   /**
+   * @remarks
+   * The data source ID (Prometheus instance ID).
+   * 
    * @example
    * rw-5f2b4sc7es4d66
    */
   dataSourceId?: string;
+  /**
+   * @remarks
+   * Additional labels to attach to all delivered metrics, specified as key-value pairs.
+   */
   externalLabels?: { [key: string]: string };
+  /**
+   * @remarks
+   * The labels for filtering metrics. This operation replaces the entire existing filter; incremental updates are not supported.
+   */
   labelFilters?: { [key: string]: string };
   /**
+   * @remarks
+   * The metric filtering mode.
+   * 
    * @example
    * Deny
    */
   labelFiltersType?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-aekzoiafjtr7zyq
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * The list of sinks.
+   */
   sinkList?: UpdateDeliveryTaskRequestSinkList[];
   /**
+   * @remarks
+   * The status of the delivery task.
+   * 
    * @example
    * Enable
    */
   status?: string;
   /**
+   * @remarks
+   * The task description.
+   * 
    * @example
    * updated desc
    */
   taskDescription?: string;
   /**
+   * @remarks
+   * The name of the delivery task. The name can include Chinese characters, English letters, underscores (_), and hyphens (-).
+   * 
    * @example
    * new-task-name
    */

package/src/models/UpdateDeliveryTaskResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateDeliveryTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 9335D7CB-2725-53DD-A2B3-187821C8F1B8

package/src/models/UpdateIntegrationPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateIntegrationPolicyRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Tag `key` value.
+   * The key of the tag.
    * 
    * @example
    * algo_bhv_expose_in_airec_exposure
@@ -13,7 +13,7 @@ export class UpdateIntegrationPolicyRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag `value` value.
+   * The value of the tag.
    * 
    * @example
    * [{\\"Id\\": \\"kgqie6hm\\", \\"Name\\": \\"Sheet1\\"}]
@@ -45,7 +45,7 @@ export class UpdateIntegrationPolicyRequestTags extends $dara.Model {
 export class UpdateIntegrationPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * Fee package type, CS_Pro/CS_Basic/empty.
+   * The type of the paid plan. Valid values: CS_Pro, CS_Basic, and empty.
    * 
    * @example
    * CS_Pro
@@ -53,7 +53,7 @@ export class UpdateIntegrationPolicyRequest extends $dara.Model {
   feePackage?: string;
   /**
    * @remarks
-   * Rule name, minimum 3 characters, maximum 63 characters, must start with a letter.
+   * The name of the rule. The name must be 3 to 63 characters in length and start with a letter.
    * 
    * @example
    * metrics-inner-manage
@@ -61,7 +61,7 @@ export class UpdateIntegrationPolicyRequest extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Resource group ID of the instance.
+   * The ID of the resource group to which the instance belongs.
    * 
    * @example
    * rg-aekzoiafjtr7zyq
@@ -69,7 +69,7 @@ export class UpdateIntegrationPolicyRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Resource tags.
+   * The tags of the resource.
    */
   tags?: UpdateIntegrationPolicyRequestTags[];
   static names(): { [key: string]: string } {

package/src/models/UpdateIntegrationPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateIntegrationPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0

package/src/models/UpdateMemoryRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateMemoryRequest extends $dara.Model {
   /**
+   * @remarks
+   * The metadata of the Memory.
+   * 
    * @example
    * {"sessionId":"test_session_001"}
    */
   metadata?: { [key: string]: any };
   /**
+   * @remarks
+   * The new text for the Memory.
+   * 
    * @example
    * Likes to play tennis on weekends
    */

package/src/models/UpdateMemoryResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateMemoryResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * 3B311FD9-A60B-55E0-A896-A0C73*********
    */

package/src/models/UpdateMemoryStoreRequest.ts

@@ -4,14 +4,28 @@ import { CustomExtractionStrategy } from "./CustomExtractionStrategy";
 
 
 export class UpdateMemoryStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Custom extraction strategies.
+   */
   customExtractionStrategies?: CustomExtractionStrategy[];
   /**
+   * @remarks
+   * Description.
+   * 
    * @example
    * memoryStore test
    */
   description?: string;
+  /**
+   * @remarks
+   * Extraction strategies. Supports "Episodic", "Summary", and "Fact".
+   */
   extractionStrategies?: string[];
   /**
+   * @remarks
+   * Short-term memory retention time.
+   * 
    * @example
    * 7
    */

package/src/models/UpdateMemoryStoreResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateMemoryStoreResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0
    */

package/src/models/UpdateNotifyStrategyRequest.ts

@@ -4,8 +4,15 @@ import { NotifyStrategyForModify } from "./NotifyStrategyForModify";
 
 
 export class UpdateNotifyStrategyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The request body.
+   */
   body?: NotifyStrategyForModify;
   /**
+   * @remarks
+   * The name of the workspace.
+   * 
    * @example
    * workspace-test
    */

package/src/models/UpdateNotifyStrategyResponseBody.ts

@@ -4,13 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateNotifyStrategyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The UUID of the notification policy.
+   * 
    * @example
    * 12312-31-23-123-1-23123
    */
   notifyStrategyId?: string;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request. This is a unique identifier for troubleshooting.
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****

package/src/models/UpdatePipelineRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdatePipelineRequestExecutePolicyRunOnce extends $dara.Model {
   /**
+   * @remarks
+   * The start timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The end timestamp.
+   * 
    * @example
    * 1772605413
    */
@@ -38,11 +44,17 @@ export class UpdatePipelineRequestExecutePolicyRunOnce extends $dara.Model {
 
 export class UpdatePipelineRequestExecutePolicyScheduled extends $dara.Model {
   /**
+   * @remarks
+   * The start timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The execution interval.
+   * 
    * @example
    * 86400
    */
@@ -72,11 +84,22 @@ export class UpdatePipelineRequestExecutePolicyScheduled extends $dara.Model {
 
 export class UpdatePipelineRequestExecutePolicy extends $dara.Model {
   /**
+   * @remarks
+   * The execution mode.
+   * 
    * @example
    * runOnce
    */
   mode?: string;
+  /**
+   * @remarks
+   * The one-time execution configuration.
+   */
   runOnce?: UpdatePipelineRequestExecutePolicyRunOnce;
+  /**
+   * @remarks
+   * The scheduled execution configuration.
+   */
   scheduled?: UpdatePipelineRequestExecutePolicyScheduled;
   static names(): { [key: string]: string } {
     return {
@@ -111,12 +134,22 @@ export class UpdatePipelineRequestExecutePolicy extends $dara.Model {
 
 export class UpdatePipelineRequestPipelineNodes extends $dara.Model {
   /**
+   * @remarks
+   * The node ID.
+   * 
    * @example
    * node_1
    */
   id?: string;
+  /**
+   * @remarks
+   * The node parameters.
+   */
   parameters?: { [key: string]: any };
   /**
+   * @remarks
+   * The node type.
+   * 
    * @example
    * dedup-fuzzy
    */
@@ -150,6 +183,10 @@ export class UpdatePipelineRequestPipelineNodes extends $dara.Model {
 }
 
 export class UpdatePipelineRequestPipeline extends $dara.Model {
+  /**
+   * @remarks
+   * The pipeline nodes.
+   */
   nodes?: UpdatePipelineRequestPipelineNodes[];
   static names(): { [key: string]: string } {
     return {
@@ -177,11 +214,17 @@ export class UpdatePipelineRequestPipeline extends $dara.Model {
 
 export class UpdatePipelineRequestSinkDataset extends $dara.Model {
   /**
+   * @remarks
+   * The dataset name.
+   * 
    * @example
    * dataset_1
    */
   dataset?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * workspace-test
    */
@@ -210,8 +253,15 @@ export class UpdatePipelineRequestSinkDataset extends $dara.Model {
 }
 
 export class UpdatePipelineRequestSink extends $dara.Model {
+  /**
+   * @remarks
+   * The destination dataset configuration.
+   */
   dataset?: UpdatePipelineRequestSinkDataset;
   /**
+   * @remarks
+   * The sink type.
+   * 
    * @example
    * dataset
    */
@@ -244,11 +294,17 @@ export class UpdatePipelineRequestSink extends $dara.Model {
 
 export class UpdatePipelineRequestSourceLogstore extends $dara.Model {
   /**
+   * @remarks
+   * The Logstore name.
+   * 
    * @example
    * test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The filter query.
+   * 
    * @example
    * status:500 and method:GET
    */
@@ -277,8 +333,15 @@ export class UpdatePipelineRequestSourceLogstore extends $dara.Model {
 }
 
 export class UpdatePipelineRequestSource extends $dara.Model {
+  /**
+   * @remarks
+   * The Log Service Logstore configuration.
+   */
   logstore?: UpdatePipelineRequestSourceLogstore;
   /**
+   * @remarks
+   * The source type.
+   * 
    * @example
    * logstore
    */
@@ -311,13 +374,32 @@ export class UpdatePipelineRequestSource extends $dara.Model {
 
 export class UpdatePipelineRequest extends $dara.Model {
   /**
+   * @remarks
+   * The pipeline description.
+   * 
    * @example
    * test pipeline
    */
   description?: string;
+  /**
+   * @remarks
+   * The execution policy.
+   */
   executePolicy?: UpdatePipelineRequestExecutePolicy;
+  /**
+   * @remarks
+   * The pipeline configuration.
+   */
   pipeline?: UpdatePipelineRequestPipeline;
+  /**
+   * @remarks
+   * The data sink configuration.
+   */
   sink?: UpdatePipelineRequestSink;
+  /**
+   * @remarks
+   * The data source configuration.
+   */
   source?: UpdatePipelineRequestSource;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdatePipelineResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdatePipelineResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * E99F1CCD-256A-5DF9-9B67-8F4A7ACE7132
    */