@alicloud/agentcore20260804 2.3.1 → 2.4.0

package/src/models/SearchMemoriesRequest.ts

@@ -0,0 +1,175 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SearchMemoriesRequestBodyScope extends $dara.Model {
+  /**
+   * @remarks
+   * The agent ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with an agent ID, this field is not returned.
+   * 
+   * @example
+   * agent-001
+   */
+  agentId?: string;
+  /**
+   * @remarks
+   * The session ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with a session ID, this field is not returned.
+   * 
+   * @example
+   * session-001
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * The user ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with a user ID, this field is not returned.
+   * 
+   * @example
+   * user-001
+   */
+  userId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      agentId: 'agentId',
+      sessionId: 'sessionId',
+      userId: 'userId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      agentId: 'string',
+      sessionId: 'string',
+      userId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesRequestBody extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to enable reranking. Default value: true.
+   */
+  enableRerank?: boolean;
+  /**
+   * @remarks
+   * The string key-value metadata for exact match. You can specify up to 16 keys. Each key can be up to 64 characters in length, and each value can be up to 1,024 characters in length.
+   */
+  metadata?: { [key: string]: string };
+  /**
+   * @remarks
+   * The minimum relevance score. Valid values: 0 to 1. Default value: 0.2. If both minScore and minSimilarity are specified, the AND logic is applied for filtering.
+   * 
+   * @example
+   * 0.2
+   */
+  minScore?: number;
+  /**
+   * @remarks
+   * The minimum similarity. Valid values: 0 to 1. Default value: 0.3. If both minScore and minSimilarity are specified, the AND logic is applied for filtering.
+   * 
+   * @example
+   * 0.3
+   */
+  minSimilarity?: number;
+  /**
+   * @remarks
+   * The query text. The text can be up to 8,192 characters in length.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * What sports does the user like?
+   */
+  query?: string;
+  /**
+   * @remarks
+   * The retrieval scope. UserId, AgentId, and SessionId are all optional.
+   */
+  scope?: SearchMemoriesRequestBodyScope;
+  /**
+   * @remarks
+   * The number of results to return.
+   * 
+   * @example
+   * 10
+   */
+  topK?: number;
+  static names(): { [key: string]: string } {
+    return {
+      enableRerank: 'enableRerank',
+      metadata: 'metadata',
+      minScore: 'minScore',
+      minSimilarity: 'minSimilarity',
+      query: 'query',
+      scope: 'scope',
+      topK: 'topK',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      enableRerank: 'boolean',
+      metadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      minScore: 'number',
+      minSimilarity: 'number',
+      query: 'string',
+      scope: SearchMemoriesRequestBodyScope,
+      topK: 'number',
+    };
+  }
+
+  validate() {
+    if(this.metadata) {
+      $dara.Model.validateMap(this.metadata);
+    }
+    if(this.scope && typeof (this.scope as any).validate === 'function') {
+      (this.scope as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The semantic retrieval request.
+   * 
+   * This parameter is required.
+   */
+  body?: SearchMemoriesRequestBody;
+  static names(): { [key: string]: string } {
+    return {
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      body: SearchMemoriesRequestBody,
+    };
+  }
+
+  validate() {
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SearchMemoriesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { SearchMemoriesResponseBody } from "./SearchMemoriesResponseBody";
+
+
+export class SearchMemoriesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: SearchMemoriesResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: SearchMemoriesResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SearchMemoriesResponseBody.ts

@@ -0,0 +1,321 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SearchMemoriesResponseBodyDataMemoriesMemoryContent extends $dara.Model {
+  /**
+   * @remarks
+   * The memory text.
+   * 
+   * @example
+   * The user likes hiking
+   */
+  text?: string;
+  static names(): { [key: string]: string } {
+    return {
+      text: 'text',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      text: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesResponseBodyDataMemoriesMemoryScope extends $dara.Model {
+  /**
+   * @remarks
+   * The agent ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with an agent ID, this field is not returned.
+   * 
+   * @example
+   * agent-001
+   */
+  agentId?: string;
+  /**
+   * @remarks
+   * The session ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with a session ID, this field is not returned.
+   * 
+   * @example
+   * session-001
+   */
+  sessionId?: string;
+  /**
+   * @remarks
+   * The user ID. The ID must be 1 to 128 bytes in length and encoded in UTF-8. The ID cannot contain forward slashes (/) or asterisks (*). If the memory is not associated with a user ID, this field is not returned.
+   * 
+   * @example
+   * user-001
+   */
+  userId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      agentId: 'agentId',
+      sessionId: 'sessionId',
+      userId: 'userId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      agentId: 'string',
+      sessionId: 'string',
+      userId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesResponseBodyDataMemoriesMemory extends $dara.Model {
+  /**
+   * @remarks
+   * The memory content.
+   */
+  content?: SearchMemoriesResponseBodyDataMemoriesMemoryContent;
+  /**
+   * @remarks
+   * The time when the memory was created.
+   * 
+   * @example
+   * 2026-09-23T10:00:00Z
+   */
+  createdAt?: string;
+  /**
+   * @remarks
+   * The long-term memory ID.
+   * 
+   * @example
+   * mem-2f5f9c5a8d0e4c3b
+   */
+  memoryId?: string;
+  /**
+   * @remarks
+   * The memory metadata.
+   */
+  metadata?: { [key: string]: string };
+  /**
+   * @remarks
+   * The memory scope.
+   */
+  scope?: SearchMemoriesResponseBodyDataMemoriesMemoryScope;
+  /**
+   * @remarks
+   * The time when the memory was last updated.
+   * 
+   * @example
+   * 2026-09-23T10:05:00Z
+   */
+  updatedAt?: string;
+  static names(): { [key: string]: string } {
+    return {
+      content: 'content',
+      createdAt: 'createdAt',
+      memoryId: 'memoryId',
+      metadata: 'metadata',
+      scope: 'scope',
+      updatedAt: 'updatedAt',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      content: SearchMemoriesResponseBodyDataMemoriesMemoryContent,
+      createdAt: 'string',
+      memoryId: 'string',
+      metadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      scope: SearchMemoriesResponseBodyDataMemoriesMemoryScope,
+      updatedAt: 'string',
+    };
+  }
+
+  validate() {
+    if(this.content && typeof (this.content as any).validate === 'function') {
+      (this.content as any).validate();
+    }
+    if(this.metadata) {
+      $dara.Model.validateMap(this.metadata);
+    }
+    if(this.scope && typeof (this.scope as any).validate === 'function') {
+      (this.scope as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesResponseBodyDataMemories extends $dara.Model {
+  /**
+   * @remarks
+   * The matched memory.
+   */
+  memory?: SearchMemoriesResponseBodyDataMemoriesMemory;
+  /**
+   * @remarks
+   * The relevance score.
+   * 
+   * @example
+   * 0.86
+   */
+  score?: number;
+  /**
+   * @remarks
+   * The vector similarity.
+   * 
+   * @example
+   * 0.91
+   */
+  similarity?: number;
+  static names(): { [key: string]: string } {
+    return {
+      memory: 'memory',
+      score: 'score',
+      similarity: 'similarity',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      memory: SearchMemoriesResponseBodyDataMemoriesMemory,
+      score: 'number',
+      similarity: 'number',
+    };
+  }
+
+  validate() {
+    if(this.memory && typeof (this.memory as any).validate === 'function') {
+      (this.memory as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of retrieval results.
+   */
+  memories?: SearchMemoriesResponseBodyDataMemories[];
+  static names(): { [key: string]: string } {
+    return {
+      memories: 'memories',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      memories: { 'type': 'array', 'itemType': SearchMemoriesResponseBodyDataMemories },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.memories)) {
+      $dara.Model.validateArray(this.memories);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class SearchMemoriesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The business status code.
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The retrieval results.
+   */
+  data?: SearchMemoriesResponseBodyData;
+  /**
+   * @remarks
+   * The HTTP status code.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 01A00000-0000-0000-0000-000000000001
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request is successful.
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      httpStatusCode: 'httpStatusCode',
+      message: 'message',
+      requestId: 'requestId',
+      success: 'success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: SearchMemoriesResponseBodyData,
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/SearchMemoriesShrinkRequest.ts

@@ -0,0 +1,33 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class SearchMemoriesShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The semantic retrieval request.
+   * 
+   * This parameter is required.
+   */
+  bodyShrink?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bodyShrink: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bodyShrink: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/UpdateAgentImchannelCredentialRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAgentIMChannelCredentialRequestBody extends $dara.Model {
   /**
    * @remarks
-   * The channel credential. All fields must be provided and field values must be non-empty strings. DingTalk uses clientID and clientSecret. Lark uses appId and appSecret. WeCom uses botId and secret.
+   * The channel credentials. All fields must be provided and the field values must be non-empty strings. For DingTalk, use clientID and clientSecret. For Lark, use appId and appSecret. For WeCom, use botId and secret.
    * 
    * This parameter is required.
    */
@@ -42,7 +42,7 @@ export class UpdateAgentIMChannelCredentialRequest extends $dara.Model {
   body?: UpdateAgentIMChannelCredentialRequestBody;
   /**
    * @remarks
-   * Reserved idempotency token. The backend does not provide persistent idempotence guarantees in the current version.
+   * The reserved idempotence token. The backend does not provide persistent idempotence guarantees in the current phase.
    * 
    * @example
    * client-token-1

package/src/models/UpdateAgentImchannelCredentialResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAgentIMChannelCredentialResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The list of configured secret field names. Secret values are not included.
+   * The list of configured secret field names, excluding the secret values.
    */
   configuredSecretFields?: string[];
   /**
@@ -45,7 +45,7 @@ export class UpdateAgentIMChannelCredentialResponseBodyData extends $dara.Model
 export class UpdateAgentIMChannelCredentialResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The business status code. The value is SUCCESS if the request succeeds.
+   * The business status code. The value is SUCCESS when the request is successful.
    * 
    * @example
    * SUCCESS
@@ -53,12 +53,12 @@ export class UpdateAgentIMChannelCredentialResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The summary of the updated IM channel credential.
+   * The summary of the updated IM channel credentials.
    */
   data?: UpdateAgentIMChannelCredentialResponseBodyData;
   /**
    * @remarks
-   * The HTTP status code. The value is 200 if the request succeeds.
+   * The HTTP status code. The value is 200 when the request is successful.
    * 
    * @example
    * 200
@@ -66,7 +66,7 @@ export class UpdateAgentIMChannelCredentialResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The result message of the request.
+   * The message indicating the request processing result.
    * 
    * @example
    * success
@@ -82,7 +82,7 @@ export class UpdateAgentIMChannelCredentialResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    */
   success?: boolean;
   static names(): { [key: string]: string } {

package/src/models/UpdateAgentImchannelCredentialShrinkRequest.ts

@@ -10,7 +10,7 @@ export class UpdateAgentIMChannelCredentialShrinkRequest extends $dara.Model {
   bodyShrink?: string;
   /**
    * @remarks
-   * Reserved idempotency token. The backend does not provide persistent idempotence guarantees in the current version.
+   * The reserved idempotence token. The backend does not provide persistent idempotence guarantees in the current phase.
    * 
    * @example
    * client-token-1

package/src/models/UpdateAgentImchannelRequest.ts

@@ -39,17 +39,17 @@ export class UpdateAgentIMChannelRequestBodyChannelConfig extends $dara.Model {
 export class UpdateAgentIMChannelRequestBody extends $dara.Model {
   /**
    * @remarks
-   * The channel behavior configuration. When specified, the entire configuration is replaced. An empty object restores default values.
+   * The channel behavior configuration. This configuration is fully replaced when passed. An empty object indicates that the default values are restored.
    */
   channelConfig?: UpdateAgentIMChannelRequestBodyChannelConfig;
   /**
    * @remarks
-   * Specifies whether to enable the IM channel. Default value upon creation: true.
+   * Specifies whether to enable the IM channel. Default value: true.
    */
   enabled?: boolean;
   /**
    * @remarks
-   * The ID of the bound ServiceEndpoint. The endpoint must belong to the specified agent and its current version, be in the ready state, and have a public endpoint.
+   * The ID of the bound ServiceEndpoint. The endpoint must belong to the specified agent and its current version, and must be ready and have a public endpoint.
    * 
    * @example
    * se-1
@@ -91,7 +91,7 @@ export class UpdateAgentIMChannelRequest extends $dara.Model {
   body?: UpdateAgentIMChannelRequestBody;
   /**
    * @remarks
-   * The reserved idempotency token. The backend does not provide persistent idempotency guarantees in the current phase.
+   * The reserved idempotence token. The backend does not provide persistent idempotence guarantees in the current phase.
    * 
    * @example
    * client-token-1