@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/CreateContextStoreRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateContextStoreRequestConfigSource extends $dara.Model {
   /**
+   * @remarks
+   * The name of the Log Service Logstore.
+   * 
    * @example
    * sls-test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The name of the Log Service project.
+   * 
    * @example
    * sls-test-project
    */
   project?: string;
   /**
    * @remarks
+   * The effective start time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -47,7 +55,15 @@ export class CreateContextStoreRequestConfigSource extends $dara.Model {
 }
 
 export class CreateContextStoreRequestConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The metadata fields.
+   */
   metadataField?: { [key: string]: string };
+  /**
+   * @remarks
+   * The configuration source.
+   */
   source?: CreateContextStoreRequestConfigSource;
   static names(): { [key: string]: string } {
     return {
@@ -80,6 +96,9 @@ export class CreateContextStoreRequestConfig extends $dara.Model {
 
 export class CreateContextStoreRequestDataset extends $dara.Model {
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
@@ -106,9 +125,15 @@ export class CreateContextStoreRequestDataset extends $dara.Model {
 }
 
 export class CreateContextStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration.
+   */
   config?: CreateContextStoreRequestConfig;
   /**
    * @remarks
+   * The name of the context store.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -117,14 +142,23 @@ export class CreateContextStoreRequest extends $dara.Model {
   contextStoreName?: string;
   /**
    * @remarks
+   * The type of the context store.
+   * 
    * This parameter is required.
    * 
    * @example
    * memory
    */
   contextType?: string;
+  /**
+   * @remarks
+   * The properties of the dataset.
+   */
   dataset?: CreateContextStoreRequestDataset;
   /**
+   * @remarks
+   * The description of the context store.
+   * 
    * @example
    * desc
    */

package/src/models/CreateContextStoreResponseBody.ts

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

package/src/models/CreateDatasetRequest.ts

@@ -6,6 +6,8 @@ import { IndexKey } from "./IndexKey";
 export class CreateDatasetRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the dataset.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,12 +15,17 @@ export class CreateDatasetRequest extends $dara.Model {
    */
   datasetName?: string;
   /**
+   * @remarks
+   * The description of the dataset.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The schema of the dataset.
+   * 
    * This parameter is required.
    */
   schema?: { [key: string]: IndexKey };

package/src/models/CreateDatasetResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDatasetResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateDeliveryTaskRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDeliveryTaskRequestSinkList extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration for the sink, specified as key-value pairs. The valid keys and values depend on the value of `sinkType`.
+   */
   sinkConfigs?: { [key: string]: string };
   /**
    * @remarks
+   * The type of the delivery destination (sink).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,11 +46,17 @@ export class CreateDeliveryTaskRequestSinkList extends $dara.Model {
 
 export class CreateDeliveryTaskRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * The key of the resource tag.
+   * 
    * @example
    * _cms_workspace
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the resource tag.
+   * 
    * @example
    * test
    */
@@ -75,37 +87,64 @@ export class CreateDeliveryTaskRequestTags extends $dara.Model {
 export class CreateDeliveryTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Prometheus instance that serves as the data source.
+   * 
    * This parameter is required.
    * 
    * @example
    * rw-xxxxxx
    */
   dataSourceId?: string;
+  /**
+   * @remarks
+   * A map of key-value pairs to attach as additional labels to all delivered metrics.
+   */
   externalLabels?: { [key: string]: string };
+  /**
+   * @remarks
+   * The label conditions for filtering metrics. The key is the label name and the value is the value to match. The filtering behavior is controlled by `labelFiltersType`.
+   */
   labelFilters?: { [key: string]: string };
   /**
+   * @remarks
+   * The mode for applying the label filters.
+   * 
    * @example
    * Allow
    */
   labelFiltersType?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-ae******ey
    */
   resourceGroupId?: string;
   /**
    * @remarks
+   * An array of delivery destination objects.
+   * 
    * This parameter is required.
    */
   sinkList?: CreateDeliveryTaskRequestSinkList[];
+  /**
+   * @remarks
+   * An array of resource tags.
+   */
   tags?: CreateDeliveryTaskRequestTags[];
   /**
+   * @remarks
+   * The task description.
+   * 
    * @example
    * my delivery task
    */
   taskDescription?: string;
   /**
    * @remarks
+   * The name of the task. The name can contain Chinese characters, English letters, underscores (_), and hyphens (-).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateDeliveryTaskResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDeliveryTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The unique ID for the request.
    * 
    * @example
    * 4CB23A2E-B426-5D4B-9AA2-6C7A508D954B
    */
   requestId?: string;
   /**
+   * @remarks
+   * The ID of the delivery task.
+   * 
    * @example
    * 98e367d8fb8cc83b
    */

package/src/models/CreateEntityStoreResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateEntityStoreResponseBody extends $dara.Model {
   /**
    * @remarks
-   * request ID
+   * The request ID.
    * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
@@ -13,7 +13,7 @@ export class CreateEntityStoreResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * workspace name
+   * The name of the workspace.
    * 
    * @example
    * workspace-test-001

package/src/models/CreateIntegrationPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   /**
    * @remarks
-   * Cluster entity type, such as acs.ack.cluster/acs.one.cluster/acs.asi.cluster or others.
+   * The cluster entity type. Examples: acs.ack.cluster, acs.one.cluster, and acs.asi.cluster.
    * 
    * @example
    * acs.ack.cluster
@@ -13,7 +13,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   clusterEntityType?: string;
   /**
    * @remarks
-   * Cluster ID.
+   * The cluster ID.
    * 
    * @example
    * na61prod3-na61cloudhdfsssd
@@ -22,7 +22,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   clusterNamespace?: string;
   /**
    * @remarks
-   * Whether to disable the unique binding of the Policy. If enabled, multiple Policies can be created for a single container cluster.
+   * Specifies whether to disable unique policy binding. If this parameter is set to true, you can create multiple policies for a container cluster.
    * 
    * @example
    * ture
@@ -30,7 +30,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   disablePolicyShare?: boolean;
   /**
    * @remarks
-   * Entity group ID.
+   * The entity group ID.
    * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
@@ -38,7 +38,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   entityGroupId?: string;
   /**
    * @remarks
-   * User ID to which the cluster belongs.
+   * The ID of the user who owns the cluster.
    * 
    * @example
    * 12xxxx
@@ -46,7 +46,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   entityUserId?: string;
   /**
    * @remarks
-   * VPC ID.
+   * The virtual private cloud (VPC) ID.
    * 
    * @example
    * vpc-bp18fgg3ffxa9czna40xt
@@ -88,7 +88,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
 export class CreateIntegrationPolicyRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Tag `key` value.
+   * The key of the tag.
    * 
    * @example
    * use
@@ -96,7 +96,7 @@ export class CreateIntegrationPolicyRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag `value` value.
+   * The value of the tag.
    * 
    * @example
    * database
@@ -128,12 +128,12 @@ export class CreateIntegrationPolicyRequestTags extends $dara.Model {
 export class CreateIntegrationPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * Entity group for creating the policy. Policies can be quickly created using the entity group, and `clusterId` and `vpcId` are independent of each other.
+   * The entity group used to create the policy. You can quickly create a policy using an entity group. The clusterId and vpcId parameters are independent of each other.
    */
   entityGroup?: CreateIntegrationPolicyRequestEntityGroup;
   /**
    * @remarks
-   * Policy name
+   * The policy name.
    * 
    * @example
    * prod-database
@@ -141,7 +141,7 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Policy type: CS/ECS/Cloud
+   * The policy type. Valid values: CS, ECS, and Cloud.
    * 
    * This parameter is required.
    * 
@@ -151,7 +151,7 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   policyType?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekz2km4kmhtbii
@@ -159,12 +159,12 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Resource tags.
+   * The resource tags.
    */
   tags?: CreateIntegrationPolicyRequestTags[];
   /**
    * @remarks
-   * Workspace.
+   * The workspace.
    * 
    * @example
    * prometheus

package/src/models/CreateIntegrationPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   /**
    * @remarks
-   * Entity group ID.
+   * The entity group ID.
    * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
@@ -13,7 +13,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   entityGroupId?: string;
   /**
    * @remarks
-   * Policy ID.
+   * The policy ID.
    * 
    * @example
    * policy-14c8e9a29b0a46da843f8781471062ff
@@ -21,7 +21,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * Policy name.
+   * The policy name.
    * 
    * @example
    * metrics-inner-manage
@@ -29,7 +29,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Policy type.
+   * The policy type.
    * 
    * @example
    * CS
@@ -37,7 +37,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyType?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region.
    * 
    * @example
    * cn-heyuan
@@ -45,7 +45,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * u1234567
@@ -53,7 +53,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * The workspace where the Policy resides.
+   * The workspace where the policy resides.
    * 
    * @example
    * prometheus
@@ -95,7 +95,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
 export class CreateIntegrationPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Whether it is created.
+   * Indicates whether the policy was created.
    * 
    * @example
    * true
@@ -103,12 +103,12 @@ export class CreateIntegrationPolicyResponseBody extends $dara.Model {
   created?: boolean;
   /**
    * @remarks
-   * Uploaded policy.
+   * The upload policy.
    */
   policy?: CreateIntegrationPolicyResponseBodyPolicy;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CD8BA7D6-995D-578D-9941-78B0FECD14B5

package/src/models/CreateMemoryStoreRequest.ts

@@ -4,13 +4,23 @@ import { CustomExtractionStrategy } from "./CustomExtractionStrategy";
 
 
 export class CreateMemoryStoreRequestTraceSourceConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to include the output in the trace.
+   */
   includeOutput?: boolean;
   /**
+   * @remarks
+   * The query to filter traces.
+   * 
    * @example
    * (serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c
    */
   query?: string;
   /**
+   * @remarks
+   * The name of the workspace that contains the trace source.
+   * 
    * @example
    * test-workspace
    */
@@ -41,15 +51,28 @@ export class CreateMemoryStoreRequestTraceSourceConfig extends $dara.Model {
 }
 
 export class CreateMemoryStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A list of custom extraction strategies.
+   */
   customExtractionStrategies?: CustomExtractionStrategy[];
   /**
+   * @remarks
+   * The description of the MemoryStore.
+   * 
    * @example
    * Test memory store for demonstration.
    */
   description?: string;
+  /**
+   * @remarks
+   * The extraction strategies to use. Valid values include `Episodic`, `Summary`, and `Fact`.
+   */
   extractionStrategies?: string[];
   /**
    * @remarks
+   * The name of the MemoryStore. The name must be unique within the workspace.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -58,6 +81,8 @@ export class CreateMemoryStoreRequest extends $dara.Model {
   memoryStoreName?: string;
   /**
    * @remarks
+   * The short-term TTL, which is the number of conversation rounds to retain.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -65,10 +90,17 @@ export class CreateMemoryStoreRequest extends $dara.Model {
    */
   shortTermTtl?: number;
   /**
+   * @remarks
+   * The source type of the memory. Valid values are `None` and `Trace`.
+   * 
    * @example
    * None/Trace
    */
   sourceType?: string;
+  /**
+   * @remarks
+   * Configuration for the trace source. Required if `sourceType` is `Trace`.
+   */
   traceSourceConfig?: CreateMemoryStoreRequestTraceSourceConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateMemoryStoreResponseBody.ts

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