@alicloud/agentloop20260520 2.3.9 → 2.4.1

package/dist/models/CreateContextStoreRequest.d.ts

@@ -1,18 +1,25 @@
 import * as $dara from '@darabonba/typescript';
-/**
- */
 export declare class CreateContextStoreRequestConfigAudit extends $dara.Model {
     /**
+     * @remarks
+     * Specifies whether to write item events for dropped recall candidates. Default value: false.
+     *
      * @example
      * false
      */
     droppedCandidates?: boolean;
     /**
+     * @remarks
+     * The logging mode for recall queries. Valid values: raw (plaintext) and hash (HMAC only). Default value: raw.
+     *
      * @example
      * raw
      */
     queryMode?: string;
     /**
+     * @remarks
+     * The number of days to retain audit logs. Valid values: 1 to 180. Default value: 30.
+     *
      * @example
      * 30
      */
@@ -28,8 +35,104 @@ export declare class CreateContextStoreRequestConfigAudit extends $dara.Model {
         [key: string]: any;
     });
 }
+export declare class CreateContextStoreRequestConfigExtractionPoliciesModel extends $dara.Model {
+    /**
+     * @remarks
+     * The name of the extraction model. Currently, only qwen3.8-flash is supported, which uses internal platform credentials.
+     *
+     * @example
+     * qwen3.8-flash
+     */
+    name?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
+export declare class CreateContextStoreRequestConfigExtractionPolicies extends $dara.Model {
+    /**
+     * @remarks
+     * The list of memory categories.
+     *
+     * @example
+     * ["preference","profile"]
+     */
+    categories?: string[];
+    /**
+     * @remarks
+     * The custom extraction instructions. This parameter is required when preset is set to custom. The length must be 1 to 8,000 characters.
+     *
+     * @example
+     * Extract only user product preferences
+     */
+    customInstructions?: string;
+    /**
+     * @remarks
+     * Specifies whether to execute this policy for new inputs. Default value: true. Disabling the policy does not delete historical memories.
+     *
+     * @example
+     * true
+     */
+    enabled?: boolean;
+    /**
+     * @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?: CreateContextStoreRequestConfigExtractionPoliciesModel;
+    /**
+     * @remarks
+     * The display name of the extraction policy.
+     *
+     * @example
+     * User preferences
+     */
+    name?: string;
+    /**
+     * @remarks
+     * The preset policy. Valid values: fact, toc-profile, tob-digital-twin, and custom. Default value: fact.
+     *
+     * @example
+     * fact
+     */
+    preset?: string;
+    /**
+     * @remarks
+     * The ID of the extraction policy. This parameter is optional. If omitted, the default value is used. The ID must start with a letter and can contain only letters, digits, underscores, and hyphens. The maximum length is 64 characters. After default value processing, the ID must be unique within the same library. Modifying the name or instructions does not change this ID.
+     *
+     * @example
+     * preferences
+     */
+    strategyId?: string;
+    static names(): {
+        [key: string]: string;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare class CreateContextStoreRequestConfigExtractionPolicyModel extends $dara.Model {
     /**
+     * @remarks
+     * The name of the extraction model. Currently, only qwen3.8-flash is supported, which uses internal platform credentials.
+     *
      * @example
      * qwen3.8-flash
      */
@@ -47,22 +150,38 @@ export declare class CreateContextStoreRequestConfigExtractionPolicyModel extend
 }
 export declare class CreateContextStoreRequestConfigExtractionPolicy extends $dara.Model {
     /**
+     * @remarks
+     * The list of memory categories.
+     *
      * @example
      * ["preference","profile"]
      */
     categories?: string[];
     /**
+     * @remarks
+     * The custom extraction instructions. This parameter is required when preset is set to custom. The length must be 1 to 8,000 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
+     * The preset policy. Valid values: fact, toc-profile, tob-digital-twin, and custom. Default value: fact.
+     *
      * @example
      * fact
      */
@@ -80,6 +199,9 @@ export declare class CreateContextStoreRequestConfigExtractionPolicy extends $da
 }
 export declare 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"]
      */
@@ -97,26 +219,43 @@ export declare class CreateContextStoreRequestConfigScopePolicy extends $dara.Mo
 }
 export declare class CreateContextStoreRequestConfigSourceDatasetCustomFields extends $dara.Model {
     /**
+     * @remarks
+     * The field description. This parameter is required when usage is set to extraction-input and is appended to the extraction prompt.
+     *
      * @example
-     * 客户等级
+     * Customer tier
      */
     description?: string;
     /**
+     * @remarks
+     * Specifies whether the field is sensitive.
+     *
      * @example
      * false
      */
     sensitive?: boolean;
     /**
+     * @remarks
+     * The name of the source field.
+     *
      * @example
      * customerTier
      */
     sourceField?: string;
     /**
+     * @remarks
+     * The target path for writing data, such as metadata.customerTier.
+     *
      * @example
      * metadata.customerTier
      */
     target?: string;
     /**
+     * @remarks
+     * The usage of the field. Valid values:
+     * - extraction-input: Participates in extraction.
+     * - ignore: Ignored.
+     *
      * @example
      * extraction-input
      */
@@ -134,6 +273,9 @@ export declare class CreateContextStoreRequestConfigSourceDatasetCustomFields ex
 }
 export declare class CreateContextStoreRequestConfigSourceDatasetFilter extends $dara.Model {
     /**
+     * @remarks
+     * The subset of the Pipeline where clause, which is pushed down to SQL.
+     *
      * @example
      * appId = \\"crm-service\\"
      */
@@ -151,16 +293,27 @@ export declare class CreateContextStoreRequestConfigSourceDatasetFilter extends
 }
 export declare 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 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
      */
@@ -177,23 +330,44 @@ export declare class CreateContextStoreRequestConfigSourceDatasetVersionPolicy e
     });
 }
 export declare class CreateContextStoreRequestConfigSourceDataset extends $dara.Model {
+    /**
+     * @remarks
+     * The list of custom field declarations.
+     */
     customFields?: CreateContextStoreRequestConfigSourceDatasetCustomFields[];
     /**
+     * @remarks
+     * 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 condition.
+     */
     filter?: CreateContextStoreRequestConfigSourceDatasetFilter;
     /**
+     * @remarks
+     * The polling interval in seconds. Valid values: 60 to 3600. Default value: 300.
+     *
      * @example
      * 300
      */
     pollIntervalSeconds?: number;
     /**
+     * @remarks
+     * The row schema contract for the Dataset. The value is fixed to MemorySourceV1 in the current phase.
+     *
      * @example
      * MemorySourceV1
      */
     schemaContract?: string;
+    /**
+     * @remarks
+     * The version consumption policy for the Dataset.
+     */
     versionPolicy?: CreateContextStoreRequestConfigSourceDatasetVersionPolicy;
     static names(): {
         [key: string]: string;
@@ -208,26 +382,41 @@ export declare class CreateContextStoreRequestConfigSourceDataset extends $dara.
 }
 export declare 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, which 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-*"]
      */
@@ -245,21 +434,33 @@ export declare class CreateContextStoreRequestConfigSourceTrajectoryFilter exten
 }
 export declare 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
      */
@@ -276,20 +477,36 @@ export declare class CreateContextStoreRequestConfigSourceTrajectoryScopeMapping
     });
 }
 export declare class CreateContextStoreRequestConfigSourceTrajectory extends $dara.Model {
+    /**
+     * @remarks
+     * The trajectory filter condition. 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
+     * 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 this parameter is not specified, the creation time is used by default.
+     *
      * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
      *
      * @example
@@ -307,19 +524,85 @@ export declare class CreateContextStoreRequestConfigSourceTrajectory extends $da
         [key: string]: any;
     });
 }
+export declare 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 number. 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;
+    };
+    static types(): {
+        [key: string]: any;
+    };
+    validate(): void;
+    constructor(map?: {
+        [key: string]: any;
+    });
+}
 export declare 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.
+     * The AgentSpace where the trace data source is located. If not specified, the default value is the AgentSpace in the current path. Cross-AgentSpace operations are not supported in the current phase. If specified, the value must be identical 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 configuration 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 data source configuration. 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 source name of the experience Dataset, which must be located in the current AgentSpace. This parameter is provided only when the type is experience and source.type is set to dataset.
+     *
+     * @example
+     * reviewed_trajectories
+     */
+    datasetName?: string;
+    /**
+     * @remarks
+     * The input format of the Dataset. For experience library Dataset sources, only atif is supported, and the fixed columns are consistent with those of optimization tasks.
+     *
+     * @example
+     * atif
+     */
+    format?: string;
+    /**
+     * @remarks
+     * The maximum number of Dataset 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 this parameter is not specified, the current time is used.
      *
      * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
      *
@@ -327,12 +610,24 @@ export declare class CreateContextStoreRequestConfigSource extends $dara.Model {
      * 2026-01-01T00:00:00Z
      */
     startTime?: string;
+    /**
+     * @remarks
+     * The trajectory data source configuration. This parameter is required when source.type is set to trajectory.
+     */
     trajectory?: CreateContextStoreRequestConfigSourceTrajectory;
     /**
+     * @remarks
+     * The data source type for the memory type. Valid values: trajectory, dataset. If this parameter is not specified, the default value is 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 value is manual. The follow mode is allowed only when binding.selection.mode is set to all. In this mode, data is consumed by append sequence number. This configuration cannot be modified after creation.
+     */
+    versionPolicy?: CreateContextStoreRequestConfigSourceVersionPolicy;
     static names(): {
         [key: string]: string;
     };
@@ -346,36 +641,57 @@ export declare class CreateContextStoreRequestConfigSource extends $dara.Model {
 }
 export declare class CreateContextStoreRequestConfigStoragePolicy extends $dara.Model {
     /**
+     * @remarks
+     * The allowed storage actions. Default value: all. Valid values: ADD, UPDATE, MERGE, 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 manual edit protection. Default value: true. If this feature is enabled, automatic extraction does not overwrite manually modified memories.
+     *
      * @example
      * true
      */
     humanEditProtection?: boolean;
     /**
+     * @remarks
+     * The merge key for upsert operations. Default value: semantic. Valid values: factKey, semantic, both.
+     *
      * @example
      * semantic
      */
     mergeKey?: string;
     /**
+     * @remarks
+     * The storage mode. Default value: upsert. Valid values: event (event append), upsert (merge update).
+     *
      * @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 a memory expires. A value of 0 indicates that the memory does not expire.
+     *
      * @example
      * 0
      */
@@ -392,7 +708,20 @@ export declare class CreateContextStoreRequestConfigStoragePolicy extends $dara.
     });
 }
 export declare class CreateContextStoreRequestConfig extends $dara.Model {
+    /**
+     * @remarks
+     * The audit configuration.
+     */
     audit?: CreateContextStoreRequestConfigAudit;
+    /**
+     * @remarks
+     * The extraction policies. You can specify 1 to 10 policies. In a request, you can specify either this field or the compatible extractionPolicy field, but not both. The strategyVersion parameter indicates the snapshot version of the entire library configuration.
+     */
+    extractionPolicies?: CreateContextStoreRequestConfigExtractionPolicies[];
+    /**
+     * @remarks
+     * The extraction policy for the memory type.
+     */
     extractionPolicy?: CreateContextStoreRequestConfigExtractionPolicy;
     /**
      * @remarks
@@ -406,16 +735,20 @@ export declare class CreateContextStoreRequestConfig extends $dara.Model {
     };
     /**
      * @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.
+     * 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 query 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"]
@@ -423,9 +756,13 @@ export declare 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 data source configuration, which serves only as the root identifier for the data source. This block is optional.
      */
     source?: CreateContextStoreRequestConfigSource;
+    /**
+     * @remarks
+     * The storage policy for the memory type.
+     */
     storagePolicy?: CreateContextStoreRequestConfigStoragePolicy;
     static names(): {
         [key: string]: string;
@@ -441,12 +778,12 @@ export declare class CreateContextStoreRequestConfig extends $dara.Model {
 export declare 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.
      *
@@ -456,7 +793,7 @@ export declare 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 (experience store) and memory (memory store).
      *
      * This parameter is required.
      *
@@ -466,15 +803,15 @@ export declare 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. This is a unique string generated by the client to ensure the idempotency of the creation operation.
      *
      * @example
      * a1b2c3d4-1234-5678-90ab-cdef12345678