@alicloud/agentloop20260520 2.3.9 → 2.4.0

package/src/models/CreateContextStoreRequest.ts

@@ -2,20 +2,27 @@
 import * as $dara from '@darabonba/typescript';
 
 
-/**
- */
 export class CreateContextStoreRequestConfigAudit extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to write item events for candidates dropped during recall. Default value: false.
+   * 
    * @example
    * false
    */
   droppedCandidates?: boolean;
   /**
+   * @remarks
+   * Specifies the logging mode for recall queries. Valid values: raw (plaintext) and hash (HMAC only). Default value: raw.
+   * 
    * @example
    * raw
    */
   queryMode?: string;
   /**
+   * @remarks
+   * Specifies the number of days to retain audit logs. Valid values: 1 to 180. Default value: 30.
+   * 
    * @example
    * 30
    */
@@ -47,6 +54,9 @@ export class CreateContextStoreRequestConfigAudit extends $dara.Model {
 
 export class CreateContextStoreRequestConfigExtractionPolicyModel extends $dara.Model {
   /**
+   * @remarks
+   * Specifies the name of the extraction model. Currently, only qwen3.8-flash is supported. Platform internal credentials are used.
+   * 
    * @example
    * qwen3.8-flash
    */
@@ -74,22 +84,38 @@ export class CreateContextStoreRequestConfigExtractionPolicyModel extends $dara.
 
 export class CreateContextStoreRequestConfigExtractionPolicy extends $dara.Model {
   /**
+   * @remarks
+   * The list of memory categories.
+   * 
    * @example
    * ["preference","profile"]
    */
   categories?: string[];
   /**
+   * @remarks
+   * Specifies the custom extraction instructions. This parameter is required when preset is set to custom. Length: 1 to 8000 characters.
+   * 
    * @example
-   * 只抽取用户的产品偏好
+   * Extract only user product preferences
    */
   customInstructions?: string;
   /**
+   * @remarks
+   * The list of exclusion rules. Content that matches these rules is not extracted.
+   * 
    * @example
-   * ["密码","证件号"]
+   * ["Password","ID number"]
    */
   excludeRules?: string[];
+  /**
+   * @remarks
+   * The extraction model configuration.
+   */
   model?: CreateContextStoreRequestConfigExtractionPolicyModel;
   /**
+   * @remarks
+   * Specifies the preset policy. Valid values: fact, toc-profile, tob-digital-twin, and custom. Default value: fact.
+   * 
    * @example
    * fact
    */
@@ -134,6 +160,9 @@ export class CreateContextStoreRequestConfigExtractionPolicy extends $dara.Model
 
 export class CreateContextStoreRequestConfigScopePolicy extends $dara.Model {
   /**
+   * @remarks
+   * Specifies that at least one of the specified scope fields must be non-empty. Valid values for elements: userId, agentId, appId, and runId.
+   * 
    * @example
    * ["userId"]
    */
@@ -164,26 +193,41 @@ export class CreateContextStoreRequestConfigScopePolicy extends $dara.Model {
 
 export class CreateContextStoreRequestConfigSourceDatasetCustomFields extends $dara.Model {
   /**
+   * @remarks
+   * Specifies the field description. This parameter is required when usage is set to extraction-input. It is appended to the extraction prompt.
+   * 
    * @example
-   * 客户等级
+   * Customer tier
    */
   description?: string;
   /**
+   * @remarks
+   * Specifies whether the field is a sensitive field.
+   * 
    * @example
    * false
    */
   sensitive?: boolean;
   /**
+   * @remarks
+   * The name of the source field.
+   * 
    * @example
    * customerTier
    */
   sourceField?: string;
   /**
+   * @remarks
+   * The target path for writing, such as metadata.customerTier.
+   * 
    * @example
    * metadata.customerTier
    */
   target?: string;
   /**
+   * @remarks
+   * Specifies the usage of the field. Valid values: extraction-input (participates in extraction) and ignore (ignored).
+   * 
    * @example
    * extraction-input
    */
@@ -219,6 +263,9 @@ export class CreateContextStoreRequestConfigSourceDatasetCustomFields extends $d
 
 export class CreateContextStoreRequestConfigSourceDatasetFilter extends $dara.Model {
   /**
+   * @remarks
+   * The subset of the Pipeline where clause, which is pushed down to SQL.
+   * 
    * @example
    * appId = \\"crm-service\\"
    */
@@ -246,16 +293,27 @@ export class CreateContextStoreRequestConfigSourceDatasetFilter extends $dara.Mo
 
 export class CreateContextStoreRequestConfigSourceDatasetVersionPolicy extends $dara.Model {
   /**
+   * @remarks
+   * The consumption mode. Valid values:
+   * - follow: Consumes data incrementally based on __dataset_seq.
+   * - fixed: Consumes the specified ACTIVE version in full at once.
+   * 
    * @example
    * follow
    */
   mode?: string;
   /**
+   * @remarks
+   * The starting __dataset_seq for the follow mode.
+   * 
    * @example
    * 0
    */
   startSeq?: number;
   /**
+   * @remarks
+   * The dataset version specified for the fixed mode.
+   * 
    * @example
    * v3
    */
@@ -286,23 +344,44 @@ export class CreateContextStoreRequestConfigSourceDatasetVersionPolicy extends $
 }
 
 export class CreateContextStoreRequestConfigSourceDataset extends $dara.Model {
+  /**
+   * @remarks
+   * The list of custom field declarations.
+   */
   customFields?: CreateContextStoreRequestConfigSourceDatasetCustomFields[];
   /**
+   * @remarks
+   * Specifies the name of the Dataset in the same AgentSpace. This parameter cannot be modified after creation.
+   * 
    * @example
    * trajectory-with-crm-profile
    */
   datasetName?: string;
+  /**
+   * @remarks
+   * The row filter conditions.
+   */
   filter?: CreateContextStoreRequestConfigSourceDatasetFilter;
   /**
+   * @remarks
+   * Specifies the polling interval in seconds. Valid values: 60 to 3600. Default value: 300.
+   * 
    * @example
    * 300
    */
   pollIntervalSeconds?: number;
   /**
+   * @remarks
+   * The Dataset row schema contract. In the current phase, this is fixed to MemorySourceV1.
+   * 
    * @example
    * MemorySourceV1
    */
   schemaContract?: string;
+  /**
+   * @remarks
+   * The dataset version consumption policy.
+   */
   versionPolicy?: CreateContextStoreRequestConfigSourceDatasetVersionPolicy;
   static names(): { [key: string]: string } {
     return {
@@ -346,26 +425,41 @@ export class CreateContextStoreRequestConfigSourceDataset extends $dara.Model {
 
 export class CreateContextStoreRequestConfigSourceTrajectoryFilter extends $dara.Model {
   /**
+   * @remarks
+   * The list of agent names. An explicitly empty list returns a 400 error.
+   * 
    * @example
    * ["sales-copilot"]
    */
   agentNames?: string[];
   /**
+   * @remarks
+   * Specifies whether to exclude degraded trajectories. Default value: false, which includes degraded trajectories.
+   * 
    * @example
    * false
    */
   excludeDegraded?: boolean;
   /**
+   * @remarks
+   * The minimum number of steps. The value must be greater than or equal to 0.
+   * 
    * @example
    * 2
    */
   minStepCount?: number;
   /**
+   * @remarks
+   * The native Simple Log Service (SLS) query statement. This statement is combined with the preceding conditions using AND.
+   * 
    * @example
    * tool_names:"search_order"
    */
   query?: string;
   /**
+   * @remarks
+   * The list of service names. A single trailing asterisk (*) is supported. An explicitly empty list returns a 400 error.
+   * 
    * @example
    * ["crm-service","app-*"]
    */
@@ -407,21 +501,33 @@ export class CreateContextStoreRequestConfigSourceTrajectoryFilter extends $dara
 
 export class CreateContextStoreRequestConfigSourceTrajectoryScopeMapping extends $dara.Model {
   /**
+   * @remarks
+   * The JSONPath expression for agentId. Default value: $.agent_name.
+   * 
    * @example
    * $.agent_name
    */
   agentId?: string;
   /**
+   * @remarks
+   * The JSONPath expression for appId. Default value: $.service_names[0].
+   * 
    * @example
    * $.service_names[0]
    */
   appId?: string;
   /**
+   * @remarks
+   * The JSONPath expression for runId. Default value: $.trajectory_id.
+   * 
    * @example
    * $.trajectory_id
    */
   runId?: string;
   /**
+   * @remarks
+   * The JSONPath expression for userId. By default, this field is not mapped.
+   * 
    * @example
    * $.trajectory_extensions.user_id
    */
@@ -454,20 +560,36 @@ export class CreateContextStoreRequestConfigSourceTrajectoryScopeMapping extends
 }
 
 export class CreateContextStoreRequestConfigSourceTrajectory extends $dara.Model {
+  /**
+   * @remarks
+   * The trajectory filter conditions. Conditions are combined with AND, and items within a list are combined with OR.
+   */
   filter?: CreateContextStoreRequestConfigSourceTrajectoryFilter;
   /**
+   * @remarks
+   * The name of the trajectory Logstore. Default value: agent-trajectory. This parameter cannot be modified after creation.
+   * 
    * @example
    * agent-trajectory
    */
   logstore?: string;
   /**
+   * @remarks
+   * Specifies the polling interval in seconds. Valid values: 60 to 3600. Default value: 300.
+   * 
    * @example
    * 300
    */
   pollIntervalSeconds?: number;
+  /**
+   * @remarks
+   * The scope field mapping. The value is a JSONPath expression. Only the $.a.b and $.a[0] formats are supported.
+   */
   scopeMapping?: CreateContextStoreRequestConfigSourceTrajectoryScopeMapping;
   /**
    * @remarks
+   * The start time for trajectory consumption in ISO 8601 UTC format. If not specified, the creation time is used by default.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -509,19 +631,95 @@ export class CreateContextStoreRequestConfigSourceTrajectory extends $dara.Model
   }
 }
 
+export class CreateContextStoreRequestConfigSourceVersionPolicy extends $dara.Model {
+  /**
+   * @remarks
+   * The continuous consumption mode. The value is fixed to follow.
+   * 
+   * @example
+   * follow
+   */
+  mode?: string;
+  /**
+   * @remarks
+   * The initial consumed append sequence. The value is a decimal string of a non-negative int64 integer. Default value: 0. The __dataset_seq field is used, and the business timestamp is not used as the consumption checkpoint.
+   * 
+   * @example
+   * 0
+   */
+  startSeq?: string;
+  static names(): { [key: string]: string } {
+    return {
+      mode: 'mode',
+      startSeq: 'startSeq',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      mode: 'string',
+      startSeq: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CreateContextStoreRequestConfigSource extends $dara.Model {
   /**
    * @remarks
-   * The AgentSpace where the trace data source resides. If not specified, the AgentSpace in the current path is used by default. Cross-AgentSpace access is not supported in the current version. If specified, the value must match the AgentSpace in the path. Otherwise, a 400 parameter error is returned. This value cannot be changed after creation.
+   * Specifies the AgentSpace where the trace data source is located. If not specified, the default is the AgentSpace in the current path. Cross-AgentSpace is not supported in the current phase. If specified, it must be equal to the path AgentSpace; otherwise, a 400 parameter error is returned. This parameter cannot be modified after creation.
    * 
    * @example
    * my-agent-space
    */
   agentSpace?: string;
+  /**
+   * @remarks
+   * The DatasetBinding v1 shared with optimization tasks. It includes version, selection (all/window and structured filters), and customFields. It is validated by the server and does not accept SQL or column mappings.
+   * 
+   * @example
+   * {"version":1,"selection":{"mode":"all"}}
+   */
+  binding?: { [key: string]: any };
+  /**
+   * @remarks
+   * The Dataset datasource config. This parameter is required when source.type is set to dataset.
+   */
   dataset?: CreateContextStoreRequestConfigSourceDataset;
   /**
    * @remarks
-   * The start time for data backfill, in ISO 8601 UTC format. If not specified, the current time is used.
+   * The name of the experience dataset source. The dataset must reside in the current AgentSpace. This parameter is provided only when the source type is experience and source.type is dataset.
+   * 
+   * @example
+   * reviewed_trajectories
+   */
+  datasetName?: string;
+  /**
+   * @remarks
+   * The input format of the dataset. For experience dataset sources, only atif is supported, and the fixed columns must be consistent with the optimization task.
+   * 
+   * @example
+   * atif
+   */
+  format?: string;
+  /**
+   * @remarks
+   * The maximum number of records to read per batch. Valid values: 1 to 1000. Default value: 1000. In manual mode, exceeding the limit causes a failure. In follow mode, bounded pagination is used to continue consumption.
+   * 
+   * @example
+   * 1000
+   */
+  maxRecords?: number;
+  /**
+   * @remarks
+   * The start time for data backfill in ISO 8601 UTC format. If not specified, the current time is used.
    * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
@@ -529,39 +727,67 @@ export class CreateContextStoreRequestConfigSource extends $dara.Model {
    * 2026-01-01T00:00:00Z
    */
   startTime?: string;
+  /**
+   * @remarks
+   * The trajectory datasource config. This parameter is required when source.type is trajectory.
+   */
   trajectory?: CreateContextStoreRequestConfigSourceTrajectory;
   /**
+   * @remarks
+   * The data source type for the memory type. Valid values: trajectory and dataset. If not specified, the value defaults to manual, which means data is written only through AddContexts. This parameter cannot be modified after creation.
+   * 
    * @example
    * trajectory
    */
   type?: string;
+  /**
+   * @remarks
+   * The continuous consumption configuration for the native experience dataset. The default mode is manual. The follow mode only allows binding.selection.mode=all and consumes data based on the append sequence. This parameter cannot be modified after creation.
+   */
+  versionPolicy?: CreateContextStoreRequestConfigSourceVersionPolicy;
   static names(): { [key: string]: string } {
     return {
       agentSpace: 'agentSpace',
+      binding: 'binding',
       dataset: 'dataset',
+      datasetName: 'datasetName',
+      format: 'format',
+      maxRecords: 'maxRecords',
       startTime: 'startTime',
       trajectory: 'trajectory',
       type: 'type',
+      versionPolicy: 'versionPolicy',
     };
   }
 
   static types(): { [key: string]: any } {
     return {
       agentSpace: 'string',
+      binding: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
       dataset: CreateContextStoreRequestConfigSourceDataset,
+      datasetName: 'string',
+      format: 'string',
+      maxRecords: 'number',
       startTime: 'string',
       trajectory: CreateContextStoreRequestConfigSourceTrajectory,
       type: 'string',
+      versionPolicy: CreateContextStoreRequestConfigSourceVersionPolicy,
     };
   }
 
   validate() {
+    if(this.binding) {
+      $dara.Model.validateMap(this.binding);
+    }
     if(this.dataset && typeof (this.dataset as any).validate === 'function') {
       (this.dataset as any).validate();
     }
     if(this.trajectory && typeof (this.trajectory as any).validate === 'function') {
       (this.trajectory as any).validate();
     }
+    if(this.versionPolicy && typeof (this.versionPolicy as any).validate === 'function') {
+      (this.versionPolicy as any).validate();
+    }
     super.validate();
   }
 
@@ -572,36 +798,57 @@ export class CreateContextStoreRequestConfigSource extends $dara.Model {
 
 export class CreateContextStoreRequestConfigStoragePolicy extends $dara.Model {
   /**
+   * @remarks
+   * The allowed storage actions. Default value: all actions, including ADD, UPDATE, MERGE, and DELETE.
+   * 
    * @example
    * ["ADD","UPDATE","MERGE","DELETE"]
    */
   allowedActions?: string[];
   /**
+   * @remarks
+   * Specifies whether to enable deduplication in event mode. Default value: true.
+   * 
    * @example
    * true
    */
   dedupe?: boolean;
   /**
+   * @remarks
+   * Specifies whether to enable human edit protection. Default value: true. When enabled, automatic extraction does not overwrite manually modified memories.
+   * 
    * @example
    * true
    */
   humanEditProtection?: boolean;
   /**
+   * @remarks
+   * The merge key for upsert operations. Valid values: factKey, semantic, and both. Default value: semantic.
+   * 
    * @example
    * semantic
    */
   mergeKey?: string;
   /**
+   * @remarks
+   * The storage mode. Valid values: event for event appending, and upsert for merged updates. Default value: upsert.
+   * 
    * @example
    * upsert
    */
   mode?: string;
   /**
+   * @remarks
+   * The similarity threshold for semantic merging. Valid values: 0 to 1. Default value: 0.4.
+   * 
    * @example
    * 0.4
    */
   similarityThreshold?: number;
   /**
+   * @remarks
+   * The number of days before memories expire. A value of 0 indicates that memories do not expire.
+   * 
    * @example
    * 0
    */
@@ -643,7 +890,15 @@ export class CreateContextStoreRequestConfigStoragePolicy extends $dara.Model {
 }
 
 export class CreateContextStoreRequestConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The audit configuration.
+   */
   audit?: CreateContextStoreRequestConfigAudit;
+  /**
+   * @remarks
+   * The extraction policy for the memory type.
+   */
   extractionPolicy?: CreateContextStoreRequestConfigExtractionPolicy;
   /**
    * @remarks
@@ -655,16 +910,20 @@ export class CreateContextStoreRequestConfig extends $dara.Model {
   metadataField?: { [key: string]: string };
   /**
    * @remarks
-   * The experience mining interval, which specifies how often experience mining is performed. Valid values: 1h, 6h, 12h, and 1d. Default value: 1d. This value cannot be changed after creation.
+   * Specifies the experience mining interval, which controls how often experience mining is executed. Valid values: 1h, 6h, 12h, and 1d. Default value: 1d. This parameter cannot be modified after creation.
    * 
    * @example
    * 1d
    */
   miningInterval?: string;
+  /**
+   * @remarks
+   * The scope constraint policy.
+   */
   scopePolicy?: CreateContextStoreRequestConfigScopePolicy;
   /**
    * @remarks
-   * The list of service names. This parameter is required and cannot be empty. It works with source.agentSpace to locate the trace data source. The trajectory extraction service uses the AgentSpace to look up the bound CMS workspace and project/logstore, and then filters by service name. This value cannot be changed after creation. No modification entry is available in the current version.
+   * The list of service names. This parameter is required and cannot be empty. It works with source.agentSpace to locate the trace data source. The trajectory extraction service uses agentSpace to find the bound CMS workspace and project or logstore, and then filters by serviceName. This parameter cannot be modified after creation.
    * 
    * @example
    * ["order-service","payment-service"]
@@ -672,9 +931,13 @@ export class CreateContextStoreRequestConfig extends $dara.Model {
   serviceNames?: string[];
   /**
    * @remarks
-   * The datasource config, which serves only as the root identifier for the data source. This is an optional block.
+   * The datasource config, which serves only as the root identity for the data source. This is an optional block.
    */
   source?: CreateContextStoreRequestConfigSource;
+  /**
+   * @remarks
+   * The storage policy for the memory type.
+   */
   storagePolicy?: CreateContextStoreRequestConfigStoragePolicy;
   static names(): { [key: string]: string } {
     return {
@@ -735,12 +998,12 @@ export class CreateContextStoreRequestConfig extends $dara.Model {
 export class CreateContextStoreRequest extends $dara.Model {
   /**
    * @remarks
-   * The context store configuration, including the datasource config and metadata field mapping.
+   * The context library configuration, including data sources and metadata field mappings.
    */
   config?: CreateContextStoreRequestConfig;
   /**
    * @remarks
-   * The context store name, which must be globally unique within the AgentSpace. The name must be 2 to 64 characters in length.
+   * The name of the context store. The name must be globally unique within AgentSpace and 2 to 64 characters in length.
    * 
    * This parameter is required.
    * 
@@ -750,7 +1013,7 @@ export class CreateContextStoreRequest extends $dara.Model {
   contextStoreName?: string;
   /**
    * @remarks
-   * The context store type. Valid values: experience and memory.
+   * The type of the context store. Valid values include experience and memory.
    * 
    * This parameter is required.
    * 
@@ -760,15 +1023,15 @@ export class CreateContextStoreRequest extends $dara.Model {
   contextType?: string;
   /**
    * @remarks
-   * The description of the context store, which helps users understand its purpose.
+   * The description of the context store, which helps business users understand its purpose.
    * 
    * @example
-   * 我的上下文库
+   * My context store
    */
   description?: string;
   /**
    * @remarks
-   * The idempotency token, which is a unique string generated by the client to ensure the idempotence of the create operation.
+   * The idempotency token, which is a unique string generated by the client to ensure the idempotency of the creation operation.
    * 
    * @example
    * a1b2c3d4-1234-5678-90ab-cdef12345678

package/src/models/CreateContextStoreResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class CreateContextStoreResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The request ID, which is used to locate and troubleshoot issues.
+   * The request ID, which is used to locate the request when you troubleshoot issues.
    * 
    * @example
    * 9ACFB10A-1B2C-3D4E-5F6G-7H8I9J0K1L2M
    */
   requestId?: string;
   /**
+   * @remarks
+   * The version number of the currently effective strategy for the memory type.
+   * 
    * @example
    * 1
    */