@alicloud/rdsai20250507 2.0.2 → 2.0.4

package/src/models/GetMessagesResponseBody.ts

@@ -3,28 +3,52 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetMessagesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The response to the query.
+   */
   answer?: string;
   /**
+   * @remarks
+   * The ID of the conversation.
+   * 
    * @example
    * 9cbbe885-b240-4803-9d15-6781a3fd****
    */
   conversationId?: string;
   /**
+   * @remarks
+   * The creation time of the conversation.
+   * 
    * @example
    * 1763986004
    */
   createdAt?: string;
   /**
+   * @remarks
+   * The feedback.
+   * 
    * @example
    * like
    */
   feedback?: string;
   /**
+   * @remarks
+   * The message ID.
+   * 
    * @example
    * 84dc9f9b-424a-404d-9c36-35e9d000****
    */
   id?: string;
+  /**
+   * @remarks
+   * The query statement.
+   */
   query?: string;
+  /**
+   * @remarks
+   * The retriever resources.
+   */
   retrieverResources?: any[];
   static names(): { [key: string]: string } {
     return {
@@ -63,18 +87,31 @@ export class GetMessagesResponseBodyData extends $dara.Model {
 }
 
 export class GetMessagesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned results.
+   */
   data?: GetMessagesResponseBodyData[];
   /**
+   * @remarks
+   * Indicates whether the current page is followed by a page.
+   * 
    * @example
    * true
    */
   hasMore?: boolean;
   /**
+   * @remarks
+   * The maximum number of entries to return.
+   * 
    * @example
    * 100
    */
   limit?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */

package/src/models/ListCustomAgentRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCustomAgentRequest extends $dara.Model {
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ListCustomAgent**.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page number of the returned page.
+   * 
    * @example
    * 10
    */

package/src/models/ListCustomAgentResponseBody.ts

@@ -4,27 +4,48 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCustomAgentResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The creation time of the agent.
+   * 
    * @example
    * 2020-11-27 16:01:28
    */
   createdAt?: string;
   /**
+   * @remarks
+   * Indicates whether tools are enabled.
+   * 
    * @example
    * true
    */
   enableTools?: boolean;
   /**
    * @remarks
-   * AgentId。
+   * The ID of the agent.
    * 
    * @example
    * d1b7d639-f34e-44c7-8231-987da14d****
    */
   id?: string;
+  /**
+   * @remarks
+   * The name of the dedicated agent.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The system prompts.
+   */
   systemPrompt?: string;
+  /**
+   * @remarks
+   * The information about the tool.
+   */
   tools?: string[];
   /**
+   * @remarks
+   * The modification time of the agent.
+   * 
    * @example
    * 2020-11-27 16:02:28
    */
@@ -66,23 +87,39 @@ export class ListCustomAgentResponseBodyData extends $dara.Model {
 }
 
 export class ListCustomAgentResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ListCustomAgentResponseBodyData[];
   /**
+   * @remarks
+   * The page number of the returned page.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned on each page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries returned. By default, this parameter is not returned.
+   * 
    * @example
    * 20
    */

package/src/models/ListCustomAgentToolsResponseBody.ts

@@ -4,22 +4,43 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListCustomAgentToolsResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The description in English.
+   * 
    * @example
    * Queries RDS instances.
    */
   en?: string;
+  /**
+   * @remarks
+   * The description in Japanese.
+   */
   ja?: string;
   /**
+   * @remarks
+   * The tool name.
+   * 
    * @example
    * describe_db_instances
    */
   name?: string;
+  /**
+   * @remarks
+   * The description in Traditional Chinese.
+   */
   tc?: string;
   /**
+   * @remarks
+   * The read/write type of the tool.
+   * 
    * @example
    * get
    */
   type?: string;
+  /**
+   * @remarks
+   * The description in Simplified Chinese.
+   */
   zh?: string;
   static names(): { [key: string]: string } {
     return {
@@ -53,8 +74,15 @@ export class ListCustomAgentToolsResponseBodyData extends $dara.Model {
 }
 
 export class ListCustomAgentToolsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ListCustomAgentToolsResponseBodyData[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 32DEFB4A-861F-5D1D-ADD5-918E4FD7****
    */

package/src/models/ModifyInstanceAuthConfigRequest.ts

@@ -37,13 +37,23 @@ export class ModifyInstanceAuthConfigRequestConfigList extends $dara.Model {
 }
 
 export class ModifyInstanceAuthConfigRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   */
   configList?: ModifyInstanceAuthConfigRequestConfigList[];
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceAuthConfig**.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/ModifyInstanceAuthConfigResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceAuthConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */

package/src/models/ModifyInstanceAuthConfigShrinkRequest.ts

@@ -3,13 +3,23 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyInstanceAuthConfigShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   */
   configListShrink?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceAuthConfig**.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/ModifyInstanceConfigRequest.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ETnLKlblzczshOTUbOCz****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The client token that is used to ensure the idempotence of the request.
+   * 
    * @example
    * eip、nat
    */
   configName?: string;
   /**
+   * @remarks
+   * The name of the configuration item that you want to modify. Configure this parameter together with the ConfigValue parameter.
+   * 
    * @example
    * on、off
    */
   configValue?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,6 +38,9 @@ export class ModifyInstanceConfigRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceConfig**.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/ModifyInstanceIpWhitelistRequest.ts

@@ -4,31 +4,59 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceIpWhitelistRequest extends $dara.Model {
   /**
+   * @remarks
+   * The method that is used to modify the IP address whitelist. Valid values:
+   * 
+   * *   **Cover** (default): Uses the IP addresses and CIDR blocks that are specified in the **IpWhitelist** parameter to **overwrite** the existing ones in the current whitelist.
+   * *   **Append**: **Appends** the IP addresses and CIDR blocks that are specified in the **IpWhitelist** parameter to the current whitelist.
+   * *   **Delete**: **Deletes** the IP addresses and CIDR blocks that are specified in the **IpWhitelist** parameter from the current whitelist. You must retain at least one IP address or CIDR block.
+   * 
    * @example
    * ETnLKlblzczshOTUbOCz****
    */
   clientToken?: string;
   /**
+   * @remarks
+   * The idempotency token. The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.
+   * 
    * @example
    * default
    */
   groupName?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * 10.23.XXX.XXX
    */
   ipWhitelist?: string;
   /**
+   * @remarks
+   * The IP address whitelist. Before you modify the IP address whitelist, call the DescribeInstanceIpWhitelist operation to query the existing IP address whitelist of the instance.
+   * 
+   * **Configuration rules**
+   * 
+   * *   You can configure IP addresses (such as 10.23.XXX.XXX) or CIDR blocks (such as 10.23.XXX.XXX/24).
+   * *   Separate multiple IP addresses or CIDR blocks with commas (,) and do not add spaces preceding or following the commas.
+   * *   You can configure up to 1,000 IP addresses and CIDR blocks in total for each instance. If you want to add a large number of IP addresses, we recommend that you merge the IP addresses into CIDR blocks, such as 10.23.XXX.XXX/24.
+   * 
    * @example
    * Cover
    */
   modifyMode?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceIpWhitelist**.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/ModifyInstanceIpWhitelistResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceIpWhitelistResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 87249A6F-xxx-804C-E1E0AD1FAD90
    */

package/src/models/ModifyInstanceRagconfigRequest.ts

@@ -38,13 +38,25 @@ export class ModifyInstanceRAGConfigRequestConfigList extends $dara.Model {
 
 export class ModifyInstanceRAGConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The value of the configuration item.
+   * 
    * @example
    * ETnLKlblzczshOTUbOCz****
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable the RAG agent. If you do not configure this parameter, the RAG agent state remains unchanged. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   */
   configList?: ModifyInstanceRAGConfigRequestConfigList[];
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,11 +64,17 @@ export class ModifyInstanceRAGConfigRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceRAGConfig**.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * true
    */

package/src/models/ModifyInstanceRagconfigResponseBody.ts

@@ -4,16 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceRAGConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */
   requestId?: string;
   /**
+   * @remarks
+   * The status of the RAG agent.
+   * 
+   * *   **true**
+   * *   **false**
+   * 
    * @example
    * true
    */

package/src/models/ModifyInstanceRagconfigShrinkRequest.ts

@@ -4,13 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceRAGConfigShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The value of the configuration item.
+   * 
    * @example
    * ETnLKlblzczshOTUbOCz****
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable the RAG agent. If you do not configure this parameter, the RAG agent state remains unchanged. Valid values:
+   * 
+   * *   **true**
+   * *   **false**
+   */
   configListShrink?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,11 +30,17 @@ export class ModifyInstanceRAGConfigShrinkRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceRAGConfig**.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * true
    */

package/src/models/ModifyInstanceSslrequest.ts

@@ -4,12 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceSSLRequest extends $dara.Model {
   /**
+   * @remarks
+   * Enables or disables SSL. Valid values:
+   * 
+   * *   **1**: enables SSL.
+   * *   **0**: disables SSL.
+   * 
    * @example
    * custom
    */
   CAType?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,12 +25,17 @@ export class ModifyInstanceSSLRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceSSL**.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
    * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,11 +43,21 @@ export class ModifyInstanceSSLRequest extends $dara.Model {
    */
   SSLEnabled?: number;
   /**
+   * @remarks
+   * The certificate type. Only **custom** is supported.
+   * 
+   * >  This parameter is required if **SSLEnabled** is set to **1**.
+   * 
    * @example
    * -----BEGIN CERTIFICATE-----MIID*****QqEP-----END CERTIFICATE-----
    */
   serverCert?: string;
   /**
+   * @remarks
+   * The content of the custom certificate.
+   * 
+   * >  This parameter is required if **CAType** is set to **custom**.
+   * 
    * @example
    * -----BEGIN PRIVATE KEY-----MIIE****ihfg==-----END PRIVATE KEY-----
    */

package/src/models/ModifyInstanceSslresponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceSSLResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */

package/src/models/ModifyInstanceStorageConfigRequest.ts

@@ -38,13 +38,22 @@ export class ModifyInstanceStorageConfigRequestConfigList extends $dara.Model {
 
 export class ModifyInstanceStorageConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The value of the configuration item.
+   * 
    * @example
    * ETnLKlblzczshOTUbOCz****
    */
   clientToken?: string;
+  /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   */
   configList?: ModifyInstanceStorageConfigRequestConfigList[];
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,6 +61,9 @@ export class ModifyInstanceStorageConfigRequest extends $dara.Model {
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The operation that you want to perform. Set the value to **ModifyInstanceStorageConfig**.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/ModifyInstanceStorageConfigResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyInstanceStorageConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the RDS Supabase instance.
+   * 
    * @example
    * ra-supabase-8moov5lxba****
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * FE9C65D7-930F-57A5-A207-8C396329241C
    */