@alicloud/rdsai20250507 3.4.2 → 3.5.0

package/src/models/ModifyWhitelistIpsRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyWhitelistIpsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The IP whitelist. Before you modify the IP whitelist, call the DescribeInstanceIpWhitelist operation to query the existing IP whitelist of the instance.
+   * 
    * @example
    * 127.0.0.1,192.168.1.0/24
    */

package/src/models/ModifyWhitelistIpsResponseBody.ts

@@ -4,19 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyWhitelistIpsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The returned message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/RenameApiKeyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RenameApiKeyRequest extends $dara.Model {
   /**
    * @remarks
-   * API KEY
+   * The API key to rename.
    * 
    * This parameter is required.
    * 
@@ -14,12 +14,17 @@ export class RenameApiKeyRequest extends $dara.Model {
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The ID of the instance.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */
   instanceId?: string;
   /**
    * @remarks
+   * The new name for the API key.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/RenameApiKeyResponseBody.ts

@@ -4,19 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class RenameApiKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates if the request succeeded.
+   * 
    * @example
    * true
    */

package/src/models/ResetApiKeyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResetApiKeyRequest extends $dara.Model {
   /**
    * @remarks
-   * Api Key
+   * The API key.
    * 
    * @example
    * sk-rds-*****
@@ -13,6 +13,8 @@ export class ResetApiKeyRequest extends $dara.Model {
   apiKey?: string;
   /**
    * @remarks
+   * The ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ResetApiKeyResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ResetApiKeyResponseBodyDataCustomKeyList extends $dara.Model {
   /**
+   * @remarks
+   * The custom API key.
+   * 
    * @example
    * sk-rds-*****
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The name of the API key.
+   * 
    * @example
    * api-*****
    */
@@ -38,15 +44,25 @@ export class ResetApiKeyResponseBodyDataCustomKeyList extends $dara.Model {
 
 export class ResetApiKeyResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The new system API key.
+   * 
    * @example
    * sk-rds-*****
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The model invocation URL.
+   * 
    * @example
    * http://xxx.yy/v1
    */
   baseUrl?: string;
+  /**
+   * @remarks
+   * A list of custom API keys.
+   */
   customKeyList?: ResetApiKeyResponseBodyDataCustomKeyList[];
   static names(): { [key: string]: string } {
     return {
@@ -77,21 +93,31 @@ export class ResetApiKeyResponseBodyData extends $dara.Model {
 }
 
 export class ResetApiKeyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ResetApiKeyResponseBodyData;
   /**
+   * @remarks
+   * The response message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/UpdateApiKeyQuotaRequest.ts

@@ -5,23 +5,43 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateApiKeyQuotaRequestKeys extends $dara.Model {
   /**
    * @remarks
-   * API KEY
+   * The API key.
    * 
    * @example
    * sk-rds-xxx
    */
   apiKey?: string;
   /**
+   * @example
+   * 100000000
+   */
+  dailyTokenQuota?: number;
+  /**
+   * @remarks
+   * The limit rate. This parameter is required when `LimitType` is set to `ratio`.
+   * 
    * @example
    * 0.2
    */
   limitRate?: number;
   /**
+   * @remarks
+   * The limit type. Valid values:
+   * 
+   * - `ratio`: Allocates the quota proportionally.
+   * 
+   * - `fixed`: Allocates a fixed quota.
+   * 
+   * - `auto`: Allocates the quota automatically.
+   * 
    * @example
    * fixed
    */
   limitType?: string;
   /**
+   * @remarks
+   * The token quota. This parameter is required when `LimitType` is set to `fixed`.
+   * 
    * @example
    * 100000
    */
@@ -29,6 +49,7 @@ export class UpdateApiKeyQuotaRequestKeys extends $dara.Model {
   static names(): { [key: string]: string } {
     return {
       apiKey: 'ApiKey',
+      dailyTokenQuota: 'DailyTokenQuota',
       limitRate: 'LimitRate',
       limitType: 'LimitType',
       tokenQuota: 'TokenQuota',
@@ -38,6 +59,7 @@ export class UpdateApiKeyQuotaRequestKeys extends $dara.Model {
   static types(): { [key: string]: any } {
     return {
       apiKey: 'string',
+      dailyTokenQuota: 'number',
       limitRate: 'number',
       limitType: 'string',
       tokenQuota: 'number',
@@ -55,10 +77,17 @@ export class UpdateApiKeyQuotaRequestKeys extends $dara.Model {
 
 export class UpdateApiKeyQuotaRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * A list of API keys.
+   */
   keys?: UpdateApiKeyQuotaRequestKeys[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateApiKeyQuotaResponseBody.ts

@@ -5,23 +5,43 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateApiKeyQuotaResponseBodyDataCustomKeyList extends $dara.Model {
   /**
    * @remarks
-   * Api Key
+   * The API key.
    * 
    * @example
    * sk-rds-xxx
    */
   apiKey?: string;
   /**
+   * @example
+   * 1000000000
+   */
+  dailyTokenQuota?: number;
+  /**
+   * @remarks
+   * The limit rate.
+   * 
    * @example
    * 0.2
    */
   limitRate?: number;
   /**
+   * @remarks
+   * The quota limiting method. Valid values:
+   * 
+   * - `ratio`: Sets the limit based on a ratio.
+   * 
+   * - `fixed`: Sets the limit to a fixed value.
+   * 
+   * - `auto`: Allocates the limit automatically.
+   * 
    * @example
    * fixed
    */
   limitType?: string;
   /**
+   * @remarks
+   * The token quota for the API key.
+   * 
    * @example
    * 10000
    */
@@ -29,6 +49,7 @@ export class UpdateApiKeyQuotaResponseBodyDataCustomKeyList extends $dara.Model
   static names(): { [key: string]: string } {
     return {
       apiKey: 'ApiKey',
+      dailyTokenQuota: 'DailyTokenQuota',
       limitRate: 'LimitRate',
       limitType: 'LimitType',
       tokenQuota: 'TokenQuota',
@@ -38,6 +59,7 @@ export class UpdateApiKeyQuotaResponseBodyDataCustomKeyList extends $dara.Model
   static types(): { [key: string]: any } {
     return {
       apiKey: 'string',
+      dailyTokenQuota: 'number',
       limitRate: 'number',
       limitType: 'string',
       tokenQuota: 'number',
@@ -54,6 +76,10 @@ export class UpdateApiKeyQuotaResponseBodyDataCustomKeyList extends $dara.Model
 }
 
 export class UpdateApiKeyQuotaResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of custom API keys.
+   */
   customKeyList?: UpdateApiKeyQuotaResponseBodyDataCustomKeyList[];
   static names(): { [key: string]: string } {
     return {
@@ -80,21 +106,31 @@ export class UpdateApiKeyQuotaResponseBodyData extends $dara.Model {
 }
 
 export class UpdateApiKeyQuotaResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: UpdateApiKeyQuotaResponseBodyData;
   /**
+   * @remarks
+   * The returned message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/UpdateApiKeyQuotaShrinkRequest.ts

@@ -4,10 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateApiKeyQuotaShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-*********6
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * A list of API keys.
+   */
   keysShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateCustomAgentRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomAgentRequest extends $dara.Model {
   /**
    * @remarks
-   * The operation that you want to perform. Set the value to **UpdateCustomAgent**.
+   * The agent ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateCustomAgentRequest extends $dara.Model {
   customAgentId?: string;
   /**
    * @remarks
-   * The system prompts.
+   * Specifies whether to enable tools.
    * 
    * @example
    * true
@@ -23,18 +23,24 @@ export class UpdateCustomAgentRequest extends $dara.Model {
   enableTools?: boolean;
   /**
    * @remarks
-   * The ID of the agent.
+   * The name of the custom agent.
+   * 
+   * @example
+   * 查询实例列表Agent
    */
   name?: string;
   skillIds?: string[];
   /**
    * @remarks
-   * The name of the agent.
+   * The system prompt.
+   * 
+   * @example
+   * 我是您用来查询实例列表的专属Agent
    */
   systemPrompt?: string;
   /**
    * @remarks
-   * Specifies whether to enable tools.
+   * The tools that the custom agent can use.
    */
   tools?: string[];
   static names(): { [key: string]: string } {

package/src/models/UpdateCustomAgentResponseBody.ts

@@ -45,7 +45,7 @@ export class UpdateCustomAgentResponseBody extends $dara.Model {
   enableTools?: string;
   /**
    * @remarks
-   * The ID of the agent.
+   * AgentId.
    * 
    * @example
    * 82cf3d62-0add-47bd-869f-877131f7****
@@ -53,7 +53,10 @@ export class UpdateCustomAgentResponseBody extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The name of the agent.
+   * The name of the custom agent.
+   * 
+   * @example
+   * 查询实例列表Agent
    */
   name?: string;
   /**
@@ -67,12 +70,15 @@ export class UpdateCustomAgentResponseBody extends $dara.Model {
   skills?: UpdateCustomAgentResponseBodySkills[];
   /**
    * @remarks
-   * The system prompts.
+   * The system prompt.
+   * 
+   * @example
+   * 我是您用来查询实例列表的专属Agent
    */
   systemPrompt?: string;
   /**
    * @remarks
-   * The information about the tool.
+   * The tools that the custom agent can use.
    */
   tools?: string[];
   static names(): { [key: string]: string } {

package/src/models/UpdateCustomAgentShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateCustomAgentShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The operation that you want to perform. Set the value to **UpdateCustomAgent**.
+   * The agent ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class UpdateCustomAgentShrinkRequest extends $dara.Model {
   customAgentId?: string;
   /**
    * @remarks
-   * The system prompts.
+   * Specifies whether to enable tools.
    * 
    * @example
    * true
@@ -23,18 +23,24 @@ export class UpdateCustomAgentShrinkRequest extends $dara.Model {
   enableTools?: boolean;
   /**
    * @remarks
-   * The ID of the agent.
+   * The name of the custom agent.
+   * 
+   * @example
+   * 查询实例列表Agent
    */
   name?: string;
   skillIdsShrink?: string;
   /**
    * @remarks
-   * The name of the agent.
+   * The system prompt.
+   * 
+   * @example
+   * 我是您用来查询实例列表的专属Agent
    */
   systemPrompt?: string;
   /**
    * @remarks
-   * Specifies whether to enable tools.
+   * The tools that the custom agent can use.
    */
   toolsShrink?: string;
   static names(): { [key: string]: string } {

package/src/models/UpdateMoquotaAlertThresholdRequest.ts

@@ -5,12 +5,19 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateMOQuotaAlertThresholdRequestApikey extends $dara.Model {
   /**
    * @remarks
-   * ApiKey
+   * The API key.
    * 
    * @example
    * sk-rds-*****
    */
   apikey?: string;
+  /**
+   * @remarks
+   * The alert threshold percentage. For example, a value of 80 triggers an alert when usage reaches 80% of the usage quota. The alert is reset after the usage falls below this percentage.
+   * 
+   * @example
+   * [0, 100]，0 会清理告警设置
+   */
   thresholdPercent?: number;
   static names(): { [key: string]: string } {
     return {
@@ -38,11 +45,15 @@ export class UpdateMOQuotaAlertThresholdRequestApikey extends $dara.Model {
 export class UpdateMOQuotaAlertThresholdRequest extends $dara.Model {
   /**
    * @remarks
+   * A list of API keys.
+   * 
    * This parameter is required.
    */
   apikey?: UpdateMOQuotaAlertThresholdRequestApikey[];
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateMoquotaAlertThresholdResponseBody.ts

@@ -5,27 +5,43 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateMOQuotaAlertThresholdResponseBodyResults extends $dara.Model {
   /**
    * @remarks
-   * API Key
+   * The API key.
    * 
    * @example
    * sk-rds-*****
    */
   apikey?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * rds_copilot***_public_cn-o*****1
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The API key name.
+   * 
    * @example
    * api-*****
    */
   keyName?: string;
   /**
+   * @remarks
+   * The key type.
+   * 
    * @example
    * system / custom
    */
   keyType?: string;
+  /**
+   * @remarks
+   * The alert threshold percentage. For example, a value of 80 triggers an alert when usage reaches 80% of the usage quota. The alert is reset after the usage falls below this percentage.
+   * 
+   * @example
+   * [0, 100]，0 会清理告警设置
+   */
   thresholdPercent?: number;
   static names(): { [key: string]: string } {
     return {
@@ -59,14 +75,21 @@ export class UpdateMOQuotaAlertThresholdResponseBodyResults extends $dara.Model
 export class UpdateMOQuotaAlertThresholdResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The result list.
+   */
   results?: UpdateMOQuotaAlertThresholdResponseBodyResults[];
   /**
+   * @remarks
+   * A value of `true` indicates that the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/UpdateMoquotaAlertThresholdShrinkRequest.ts

@@ -5,11 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateMOQuotaAlertThresholdShrinkRequest extends $dara.Model {
   /**
    * @remarks
+   * A list of API keys.
+   * 
    * This parameter is required.
    */
   apikeyShrink?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateSkillRequest.ts

@@ -6,6 +6,9 @@ export class UpdateSkillRequest extends $dara.Model {
   /**
    * @remarks
    * The content of the skill.
+   * 
+   * @example
+   * {"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}
    */
   content?: { [key: string]: any };
   /**
@@ -16,6 +19,9 @@ export class UpdateSkillRequest extends $dara.Model {
   /**
    * @remarks
    * The description of the Skill. It can be up to 1000 characters in length.
+   * 
+   * @example
+   * SQL审查专家：全面审核SQL的安全性、性能与规范性，识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时，立即启用。
    */
   description?: string;
   /**

package/src/models/UpdateSkillResponseBody.ts

@@ -6,6 +6,9 @@ export class UpdateSkillResponseBody extends $dara.Model {
   /**
    * @remarks
    * The content of the skill.
+   * 
+   * @example
+   * {"MySQL": "MySQL 优化指南...","PostgreSQL": "PostgreSQL 优化指南..."}
    */
   content?: { [key: string]: any };
   /**
@@ -16,6 +19,9 @@ export class UpdateSkillResponseBody extends $dara.Model {
   /**
    * @remarks
    * The description of the skill. It can be up to 1000 characters in length.
+   * 
+   * @example
+   * SQL审查专家：全面审核SQL的安全性、性能与规范性，识别风险并提供优化建议。用户提交SQL或询问“SQL审核”“SQL Review”“有风险吗”“如何优化”时，立即启用。
    */
   description?: string;
   /**