@alicloud/agentcore20260804 2.2.1 → 2.3.0

package/src/models/ListCustomAgentsRequest.ts

@@ -0,0 +1,44 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListCustomAgentsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The maximum number of entries to return per page. Valid values: 1 to 100. If this parameter is omitted or set to 0, the default value 20 is used.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The opaque token used to query the next page. Omit this parameter in the first request. In subsequent requests, pass the nextToken value returned in the previous response as is, and keep the same workspace. Do not construct the token yourself.
+   * 
+   * @example
+   * djE6YWdlbnRjb3JlLmFnZW50Lmxpc3QuY3VzdG9tOjIw
+   */
+  nextToken?: string;
+  static names(): { [key: string]: string } {
+    return {
+      maxResults: 'maxResults',
+      nextToken: 'nextToken',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      maxResults: 'number',
+      nextToken: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListCustomAgentsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListCustomAgentsResponseBody } from "./ListCustomAgentsResponseBody";
+
+
+export class ListCustomAgentsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ListCustomAgentsResponseBody;
+  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: ListCustomAgentsResponseBody,
+    };
+  }
+
+  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/ListCustomAgentsResponseBody.ts

@@ -0,0 +1,345 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListCustomAgentsResponseBodyItemsProtocolPaths extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the purpose of the current API path.
+   * 
+   * @example
+   * AG-UI conversation API
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The API path corresponding to the current protocol.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * /agui
+   */
+  name?: string;
+  static names(): { [key: string]: string } {
+    return {
+      description: 'description',
+      name: 'name',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      description: 'string',
+      name: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListCustomAgentsResponseBodyItemsProtocol extends $dara.Model {
+  /**
+   * @remarks
+   * The request header configuration of the current protocol. The key is the header name and the value is a string.
+   */
+  headers?: { [key: string]: string };
+  /**
+   * @remarks
+   * The list of API paths corresponding to the current protocol.
+   */
+  paths?: ListCustomAgentsResponseBodyItemsProtocolPaths[];
+  /**
+   * @remarks
+   * The invoke Protocol Type. Valid values: agui: AG-UI protocol. openai-chat-completion: OpenAI Chat Completions compatible protocol. custom: custom protocol.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * agui
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      paths: 'paths',
+      type: 'type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      paths: { 'type': 'array', 'itemType': ListCustomAgentsResponseBodyItemsProtocolPaths },
+      type: 'string',
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(Array.isArray(this.paths)) {
+      $dara.Model.validateArray(this.paths);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListCustomAgentsResponseBodyItems extends $dara.Model {
+  /**
+   * @remarks
+   * The unique identifier of the custom agent. You can obtain the value from the response of CreateCustomAgent or ListCustomAgents.
+   * 
+   * @example
+   * agent-550e8400e29b41d4a716446655440000
+   */
+  agentId?: string;
+  /**
+   * @remarks
+   * The creation method of the agent. The value is CUSTOM for custom agents.
+   * 
+   * @example
+   * CUSTOM
+   */
+  createMode?: string;
+  /**
+   * @remarks
+   * The time when the agent was created. The time is displayed in ISO 8601 format. The trailing Z indicates the UTC time zone. Fractional seconds may be included.
+   * 
+   * @example
+   * 2026-10-10T06:00:00Z
+   */
+  createdAt?: string;
+  /**
+   * @remarks
+   * The deployment method of the agent. Custom agents are deployed and managed by the platform. The value is MANAGED.
+   * 
+   * @example
+   * MANAGED
+   */
+  deployType?: string;
+  /**
+   * @remarks
+   * The description of the agent\\"s purpose.
+   * 
+   * @example
+   * Custom agent that provides conversation services
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The latest configuration version number. Updates with the same configuration may retain the original version number. This field does not indicate that the configuration has taken effect.
+   * 
+   * @example
+   * 1
+   */
+  latestSpecVersion?: number;
+  /**
+   * @remarks
+   * The name of the custom agent.
+   * 
+   * @example
+   * my-custom-agent
+   */
+  name?: string;
+  /**
+   * @remarks
+   * The list of invocation protocol configurations for the agent.
+   */
+  protocol?: ListCustomAgentsResponseBodyItemsProtocol[];
+  /**
+   * @remarks
+   * The compute specifications of the agent. Valid values: INTERACTIVE, STANDARD, and HEAVY.
+   * 
+   * @example
+   * STANDARD
+   */
+  runtime?: string;
+  /**
+   * @remarks
+   * The overall status of the agent. Valid values: Creating: The agent is being created. Running: The agent is running. Failed: The agent failed to run. Updating: The agent is being updated. Deleting: The agent is being deleted. Deleted: The agent is deleted. To query the execution progress of the latest configuration, call GetCustomAgent.
+   * 
+   * @example
+   * Running
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The time when the agent was last updated. The time is displayed in ISO 8601 format. The trailing Z indicates the UTC time zone. Fractional seconds may be included.
+   * 
+   * @example
+   * 2026-10-10T06:05:00Z
+   */
+  updatedAt?: string;
+  /**
+   * @remarks
+   * The ID of the workspace to which the custom agent belongs.
+   * 
+   * @example
+   * ws-a1b2c3d4e5f6
+   */
+  workspaceId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      agentId: 'agentId',
+      createMode: 'createMode',
+      createdAt: 'createdAt',
+      deployType: 'deployType',
+      description: 'description',
+      latestSpecVersion: 'latestSpecVersion',
+      name: 'name',
+      protocol: 'protocol',
+      runtime: 'runtime',
+      status: 'status',
+      updatedAt: 'updatedAt',
+      workspaceId: 'workspaceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      agentId: 'string',
+      createMode: 'string',
+      createdAt: 'string',
+      deployType: 'string',
+      description: 'string',
+      latestSpecVersion: 'number',
+      name: 'string',
+      protocol: { 'type': 'array', 'itemType': ListCustomAgentsResponseBodyItemsProtocol },
+      runtime: 'string',
+      status: 'string',
+      updatedAt: 'string',
+      workspaceId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.protocol)) {
+      $dara.Model.validateArray(this.protocol);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListCustomAgentsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The result code of the request. The value is SUCCESS if the request is successful.
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The HTTP status code of the request. The value is 200 if the request is successful.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The list of custom agent summaries on the current page. To obtain the complete configuration and the execution results of the latest version, call GetCustomAgent.
+   */
+  items?: ListCustomAgentsResponseBodyItems[];
+  /**
+   * @remarks
+   * The maximum number of entries returned per page for this query.
+   * 
+   * @example
+   * 20
+   */
+  maxResults?: number;
+  /**
+   * @remarks
+   * The description of the processing result for this request. The value is success if the request is successful.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The opaque token used to query the next page. An empty value indicates that there are no more pages. Pass the token as is in subsequent requests.
+   * 
+   * @example
+   * djE6YWdlbnRjb3JlLmFnZW50Lmxpc3QuY3VzdG9tOjIw
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The unique identifier of the request. You can use the ID to locate and troubleshoot issues.
+   * 
+   * @example
+   * 550E8400-E29B-41D4-A716-446655440000
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the request was processed successfully. true indicates that the request was processed successfully. A successful creation, update, or deletion does not mean that the background operation is complete.
+   */
+  success?: boolean;
+  /**
+   * @remarks
+   * The total number of custom agents that meet the query conditions in the specified workspace.
+   * 
+   * @example
+   * 40
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      httpStatusCode: 'httpStatusCode',
+      items: 'items',
+      maxResults: 'maxResults',
+      message: 'message',
+      nextToken: 'nextToken',
+      requestId: 'requestId',
+      success: 'success',
+      totalCount: 'totalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      httpStatusCode: 'number',
+      items: { 'type': 'array', 'itemType': ListCustomAgentsResponseBodyItems },
+      maxResults: 'number',
+      message: 'string',
+      nextToken: 'string',
+      requestId: 'string',
+      success: 'boolean',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListUsersRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListUsersRequest extends $dara.Model {
   /**
    * @remarks
-   * The maximum number of records per page. Valid values: 1 to 100. Default value: 10.
+   * The maximum number of records to return per page. Valid values: 1 to 100. If this parameter is not specified, 10 records are returned by default.
    * 
    * @example
    * 10
@@ -13,7 +13,7 @@ export class ListUsersRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The filter condition for exact match by username.
+   * The filter condition for exact match on the username.
    * 
    * @example
    * user-01
@@ -21,7 +21,7 @@ export class ListUsersRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The filter condition for fuzzy match by username. The value can be up to 128 characters in length.
+   * The filter condition for fuzzy match on the username. The value can be up to 128 characters in length.
    * 
    * @example
    * user
@@ -29,7 +29,7 @@ export class ListUsersRequest extends $dara.Model {
   nameLike?: string;
   /**
    * @remarks
-   * The pagination token for the next page. Do not specify this parameter for the first request. For subsequent requests, set this parameter to the nextToken value returned in the previous response.
+   * The cursor for querying the next page. Do not specify this parameter in the first call. In subsequent calls, specify the nextToken value returned in the previous call.
    * 
    * @example
    * dXNlci1vZmZzZXQ6MTA

package/src/models/ListUsersResponseBody.ts

@@ -13,7 +13,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   agentCoreUserId?: string;
   /**
    * @remarks
-   * The authentication method of the user. A value of password indicates local password authentication in the workspace. Values of dingtalk and feishu indicate that the user is synchronized and authenticated by the corresponding external identity provider.
+   * The authentication method of the user. A value of password indicates that the user is authenticated by using the local password of the workspace. A value of dingtalk or feishu indicates that the user is synchronized and authenticated by the corresponding external identity provider.
    * 
    * @example
    * password
@@ -21,7 +21,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   authMethod?: string;
   /**
    * @remarks
-   * The creation time in UTC, formatted in RFC 3339.
+   * The creation time. The time is displayed in UTC and follows the RFC 3339 format.
    * 
    * @example
    * 2026-08-12T03:04:05Z
@@ -29,15 +29,15 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   createdAt?: string;
   /**
    * @remarks
-   * The display name of the user. The value is 1 to 32 characters in length.
+   * The display name of the user. The name must be 1 to 32 characters in length.
    * 
    * @example
-   * John Smith
+   * Zhang San
    */
   displayName?: string;
   /**
    * @remarks
-   * The email address of the user. The value can be up to 256 characters in length.
+   * The email address of the user. The email address can be up to 256 characters in length.
    * 
    * @example
    * user-01@example.com
@@ -45,7 +45,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   email?: string;
   /**
    * @remarks
-   * The username. The value must be unique within the workspace and can contain only lowercase letters, digits, and hyphens (-). It must start and end with a lowercase letter or digit. The value is 1 to 32 characters in length.
+   * The username. The username must be unique within the workspace and can contain only lowercase letters, digits, and hyphens (-). It must start and end with a lowercase letter or a digit, and must be 1 to 32 characters in length.
    * 
    * @example
    * user-01
@@ -53,7 +53,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The remarks of the user. The value can be up to 1024 characters in length.
+   * The note of the user. The note can be up to 1,024 characters in length.
    * 
    * @example
    * Agent operations team member
@@ -69,7 +69,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The user status. Valid values: Creating, Active, Updating, Deleting, Failed, DeleteFailed.
+   * The status of the user. Valid values: Creating, Active, Updating, Deleting, Failed, and DeleteFailed.
    * 
    * @example
    * Active
@@ -77,7 +77,7 @@ export class ListUsersResponseBodyItems extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time of the last modification in UTC, formatted in RFC 3339.
+   * The time of the last modification. The time is displayed in UTC and follows the RFC 3339 format.
    * 
    * @example
    * 2026-08-12T03:04:05Z
@@ -151,12 +151,12 @@ export class ListUsersResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The list of users.
+   * The user list.
    */
   items?: ListUsersResponseBodyItems[];
   /**
    * @remarks
-   * The maximum number of records per page that takes effect for this query.
+   * The maximum number of records per page that takes effect in the current query.
    * 
    * @example
    * 10
@@ -164,7 +164,7 @@ export class ListUsersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The response message. An error description is returned if the request fails.
+   * The response message. If the request fails, an error description is returned.
    * 
    * @example
    * success
@@ -172,7 +172,7 @@ export class ListUsersResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The pagination token for the next page. This value is empty if no more pages are available.
+   * The cursor for the next page. If no next page exists, this parameter is empty.
    * 
    * @example
    * dXNlci1vZmZzZXQ6MTA
@@ -188,12 +188,12 @@ export class ListUsersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    */
   success?: boolean;
   /**
    * @remarks
-   * The total number of users that match the query conditions.
+   * The total number of users that meet the query conditions.
    * 
    * @example
    * 42