@alicloud/polardb20170801 8.1.1 → 8.2.1

package/src/models/DescribeKnowledgeSpaceAttributeResponseBody.ts

@@ -0,0 +1,508 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategyParameters extends $dara.Model {
+  /**
+   * @remarks
+   * The maximum number of tokens in a single chunk.
+   * 
+   * @example
+   * 512
+   */
+  maxTokens?: number;
+  /**
+   * @remarks
+   * Specifies whether to merge adjacent small chunks under the same heading.
+   * 
+   * @example
+   * true
+   */
+  mergePeers?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      maxTokens: 'MaxTokens',
+      mergePeers: 'MergePeers',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      maxTokens: 'number',
+      mergePeers: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategy extends $dara.Model {
+  /**
+   * @remarks
+   * The parameter details.
+   */
+  parameters?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategyParameters;
+  /**
+   * @remarks
+   * The type of the default chunking strategy. Valid values: hybrid or hierarchical.
+   * 
+   * @example
+   * hybrid
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      parameters: 'Parameters',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      parameters: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategyParameters,
+      type: 'string',
+    };
+  }
+
+  validate() {
+    if(this.parameters && typeof (this.parameters as any).validate === 'function') {
+      (this.parameters as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesMatch extends $dara.Model {
+  /**
+   * @remarks
+   * The content type. Currently, table is supported.
+   * 
+   * @example
+   * table
+   */
+  contentType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      contentType: 'ContentType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      contentType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategyParameters extends $dara.Model {
+  /**
+   * @remarks
+   * The Markdown table processing mode. Valid values: auto, on, or off.
+   * 
+   * @example
+   * auto
+   */
+  markdownTables?: string;
+  /**
+   * @remarks
+   * The maximum number of tokens in a single chunk for matched content.
+   * 
+   * @example
+   * 512
+   */
+  maxTokens?: number;
+  static names(): { [key: string]: string } {
+    return {
+      markdownTables: 'MarkdownTables',
+      maxTokens: 'MaxTokens',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      markdownTables: 'string',
+      maxTokens: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategy extends $dara.Model {
+  /**
+   * @remarks
+   * The parameter details.
+   */
+  parameters?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategyParameters;
+  /**
+   * @remarks
+   * The chunking strategy type used when a rule is matched.
+   * 
+   * @example
+   * hierarchical
+   */
+  type?: string;
+  static names(): { [key: string]: string } {
+    return {
+      parameters: 'Parameters',
+      type: 'Type',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      parameters: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategyParameters,
+      type: 'string',
+    };
+  }
+
+  validate() {
+    if(this.parameters && typeof (this.parameters as any).validate === 'function') {
+      (this.parameters as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRules extends $dara.Model {
+  /**
+   * @remarks
+   * The content type. Currently, table is supported.
+   */
+  match?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesMatch;
+  /**
+   * @remarks
+   * The chunking strategy.
+   */
+  strategy?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategy;
+  static names(): { [key: string]: string } {
+    return {
+      match: 'Match',
+      strategy: 'Strategy',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      match: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesMatch,
+      strategy: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRulesStrategy,
+    };
+  }
+
+  validate() {
+    if(this.match && typeof (this.match as any).validate === 'function') {
+      (this.match as any).validate();
+    }
+    if(this.strategy && typeof (this.strategy as any).validate === 'function') {
+      (this.strategy as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The default chunking strategy. This strategy is used when no rule is matched.
+   */
+  defaultStrategy?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategy;
+  /**
+   * @remarks
+   * The list of override rules that are matched in order.
+   */
+  rules?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRules[];
+  static names(): { [key: string]: string } {
+    return {
+      defaultStrategy: 'DefaultStrategy',
+      rules: 'Rules',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      defaultStrategy: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigDefaultStrategy,
+      rules: { 'type': 'array', 'itemType': DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfigRules },
+    };
+  }
+
+  validate() {
+    if(this.defaultStrategy && typeof (this.defaultStrategy as any).validate === 'function') {
+      (this.defaultStrategy as any).validate();
+    }
+    if(Array.isArray(this.rules)) {
+      $dara.Model.validateArray(this.rules);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeSpaceAttributeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The access control list (ACL) mode of the knowledge space. Valid values:
+   * - DISABLED
+   * - ENFORCED
+   * 
+   * @example
+   * ENFORCED
+   */
+  ACLMode?: string;
+  /**
+   * @remarks
+   * The time when the knowledge space was created.
+   * 
+   * @example
+   * 2026-06-25T09:53:44Z
+   */
+  creationTime?: string;
+  /**
+   * @remarks
+   * The ID of the PolarDB instance.
+   * 
+   * @example
+   * pc-*************
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * The name of the database.
+   * 
+   * @example
+   * polar_rag_meta
+   */
+  DBName?: string;
+  /**
+   * @remarks
+   * The type of the database engine. Valid values:
+   * * MySQL
+   * * PostgreSQL
+   * 
+   * @example
+   * MySQL
+   */
+  DBType?: string;
+  /**
+   * @remarks
+   * The description of the knowledge space.
+   * 
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The vector dimensions.
+   * 
+   * @example
+   * 1536
+   */
+  embeddingDimension?: number;
+  /**
+   * @remarks
+   * The embedding model.
+   * 
+   * @example
+   * text-embedding-v4
+   */
+  embeddingModel?: string;
+  /**
+   * @remarks
+   * The total number of knowledge bases.
+   * 
+   * @example
+   * 1
+   */
+  knowledgeBaseCount?: number;
+  /**
+   * @remarks
+   * The unique identifier of the knowledge space.
+   * 
+   * @example
+   * pks-xxxxxx
+   */
+  knowledgeSpaceId?: string;
+  /**
+   * @remarks
+   * The large language model.
+   * 
+   * @example
+   * qwen3.6-plus
+   */
+  LLMModel?: string;
+  /**
+   * @remarks
+   * The name of the knowledge space.
+   * 
+   * @example
+   * testName
+   */
+  name?: string;
+  /**
+   * @remarks
+   * OSS Bucket
+   * 
+   * @example
+   * test-bucket
+   */
+  OSSBucket?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 6BD9CDE4-5E7B-4BF3-9BB8-83C73E******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The reranking model.
+   * 
+   * @example
+   * qwen3-rerank
+   */
+  rerankModel?: string;
+  /**
+   * @remarks
+   * The chunk size in tokens.
+   * 
+   * @example
+   * 512
+   */
+  shardSize?: number;
+  /**
+   * @remarks
+   * The default chunking strategy configuration of the knowledge space. This parameter may be empty if existing instances do not have the complete configuration saved.
+   */
+  shardingStrategyConfig?: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig;
+  /**
+   * @remarks
+   * The instance status.
+   * 
+   * @example
+   * Activation
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The chunking strategy.
+   * 
+   * @example
+   * hybrid
+   */
+  strategy?: string;
+  /**
+   * @remarks
+   * The total number of documents.
+   * 
+   * @example
+   * 1
+   */
+  totalDocs?: number;
+  /**
+   * @remarks
+   * The total size in bytes.
+   * 
+   * @example
+   * 318881
+   */
+  totalSizeBytes?: number;
+  static names(): { [key: string]: string } {
+    return {
+      ACLMode: 'ACLMode',
+      creationTime: 'CreationTime',
+      DBClusterId: 'DBClusterId',
+      DBName: 'DBName',
+      DBType: 'DBType',
+      description: 'Description',
+      embeddingDimension: 'EmbeddingDimension',
+      embeddingModel: 'EmbeddingModel',
+      knowledgeBaseCount: 'KnowledgeBaseCount',
+      knowledgeSpaceId: 'KnowledgeSpaceId',
+      LLMModel: 'LLMModel',
+      name: 'Name',
+      OSSBucket: 'OSSBucket',
+      requestId: 'RequestId',
+      rerankModel: 'RerankModel',
+      shardSize: 'ShardSize',
+      shardingStrategyConfig: 'ShardingStrategyConfig',
+      status: 'Status',
+      strategy: 'Strategy',
+      totalDocs: 'TotalDocs',
+      totalSizeBytes: 'TotalSizeBytes',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ACLMode: 'string',
+      creationTime: 'string',
+      DBClusterId: 'string',
+      DBName: 'string',
+      DBType: 'string',
+      description: 'string',
+      embeddingDimension: 'number',
+      embeddingModel: 'string',
+      knowledgeBaseCount: 'number',
+      knowledgeSpaceId: 'string',
+      LLMModel: 'string',
+      name: 'string',
+      OSSBucket: 'string',
+      requestId: 'string',
+      rerankModel: 'string',
+      shardSize: 'number',
+      shardingStrategyConfig: DescribeKnowledgeSpaceAttributeResponseBodyShardingStrategyConfig,
+      status: 'string',
+      strategy: 'string',
+      totalDocs: 'number',
+      totalSizeBytes: 'number',
+    };
+  }
+
+  validate() {
+    if(this.shardingStrategyConfig && typeof (this.shardingStrategyConfig as any).validate === 'function') {
+      (this.shardingStrategyConfig as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DisableDbclusterServerlessRequest.ts

@@ -14,6 +14,12 @@ export class DisableDBClusterServerlessRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * Specifies whether to immediately run the task or run it during a scheduled time window. Valid values:
+   * 
+   * - false (default): The task is run during a scheduled time window.
+   * - true: The task is immediately run.
+   * 
    * @example
    * false
    */
@@ -21,11 +27,17 @@ export class DisableDBClusterServerlessRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The latest time to start running the scheduled task. Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
+   * 
    * @example
    * 2022-04-28T14:30:00Z
    */
   plannedEndTime?: string;
   /**
+   * @remarks
+   * The earliest time to start running the scheduled task (that is, the task is run within the specified time range). Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
+   * 
    * @example
    * 2022-04-28T14:00:00Z
    */

package/src/models/EnableDbclusterServerlessRequest.ts

@@ -14,6 +14,12 @@ export class EnableDBClusterServerlessRequest extends $dara.Model {
    */
   DBClusterId?: string;
   /**
+   * @remarks
+   * Specifies whether to immediately execute or schedule the parameter modification and restart. Valid values:
+   * 
+   * - false (default): Schedule the execution.
+   * - true: Immediately execute.
+   * 
    * @example
    * false
    */
@@ -21,11 +27,17 @@ export class EnableDBClusterServerlessRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The latest time to start executing the target scheduled task. Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
+   * 
    * @example
    * 2022-04-28T14:30:00Z
    */
   plannedEndTime?: string;
   /**
+   * @remarks
+   * The earliest time to start executing the scheduled task (that is, the task is executed within the target time period). Specify the time in the YYYY-MM-DDThh:mm:ssZ format (UTC).
+   * 
    * @example
    * 2022-04-28T14:00:00Z
    */

package/src/models/ModifyDbclusterAccessWhitelistRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   /**
    * @remarks
-   * The attribute of the IP whitelist group. If this parameter is set to **hidden**, the group is not displayed in the console.
+   * The attribute of the IP whitelist group. If you set this parameter to **hidden**, the group is not displayed in the console.
    * 
    * > - IP whitelist groups that are already displayed in the console cannot be hidden.
    * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
@@ -22,7 +22,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
    * - If the specified whitelist group name already exists, the whitelist group is modified.
    * - If this parameter is not specified, the default group is modified. 
    * 
-   * > - A maximum of 50 IP whitelist groups are supported for a cluster.
+   * > - A cluster supports up to 50 IP whitelist groups.
    * > - This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
    * @example
@@ -42,9 +42,9 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   /**
    * @remarks
    * The method used to modify the IP whitelist. Valid values:
-   * - **Cover**: overwrites the original IP whitelist (default value).
-   * - **Append**: appends IP addresses to the whitelist.
-   * - **Delete**: removes IP addresses from the whitelist.
+   * - **Cover**: overwrites the original IP whitelist. This is the default value.
+   * - **Append**: appends IP addresses to the IP whitelist.
+   * - **Delete**: removes IP addresses from the IP whitelist.
    * 
    * > This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 
@@ -55,6 +55,9 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The file system instance ID.
+   * 
    * @example
    * pfs-xxx
    */
@@ -65,7 +68,7 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
    * @remarks
    * The security group IDs. Separate multiple security group IDs with commas (,).
    * 
-   * > - A maximum of 3 security groups are supported for a cluster.
+   * > - A cluster supports up to 3 security groups.
    * > - This parameter takes effect only when **WhiteListType** is set to **SecurityGroup**.
    * 
    * @example
@@ -74,10 +77,10 @@ export class ModifyDBClusterAccessWhitelistRequest extends $dara.Model {
   securityGroupIds?: string;
   /**
    * @remarks
-   * The IP addresses or CIDR blocks in the IP whitelist group. A maximum of 1,000 IP addresses or CIDR blocks can be added to all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported: 
+   * The IP addresses or CIDR blocks in the IP whitelist group. You can add up to 1,000 IP addresses or CIDR blocks across all IP whitelist groups. Separate multiple IP addresses with commas (,). The following two formats are supported: 
    * 
    * - IP address format, such as 10.23.12.24.
-   * - CIDR format, such as 10.23.12.24/24, where 24 indicates the prefix length of the CIDR block. The prefix length ranges from 1 to 32.
+   * - CIDR format, such as 10.23.12.24/24, where 24 indicates the length of the prefix in the IP address. The prefix length ranges from 1 to 32.
    * 
    * > This parameter takes effect only when **WhiteListType** is set to **IP**.
    * 

package/src/models/ModifyDbclusterArchRequest.ts

@@ -3,6 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ModifyDBClusterArchRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): Uses coupons.
+   * * false: Does not use coupons.
+   */
   autoUseCoupon?: boolean;
   /**
    * @remarks
@@ -14,17 +20,19 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * Specifies whether to enable a hot standby cluster. Valid values:
-   * 
-   * - **on**: Enables a hot standby cluster.
+   * Specifies whether to enable the hot standby cluster. Valid values:
    * 
-   * - **equal**: Enables a peer cluster.
+   * - **on**: Enables the hot standby cluster.
+   * - **equal**: Enables the peer cluster.
    * 
    * @example
    * on
    */
   hotStandbyCluster?: string;
   /**
+   * @remarks
+   * The coupon code. If this parameter is not specified, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
@@ -33,7 +41,7 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
    * @remarks
    * The region ID.
    * 
-   * > For more information, see [DescribeRegions](https://help.aliyun.com/document_detail/98041.html).
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/98041.html) operation to query region information.
    * 
    * @example
    * cn-beijing
@@ -41,11 +49,10 @@ export class ModifyDBClusterArchRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The zone for the hot standby storage cluster. Valid values:
-   * 
-   * - **auto** (default): The system automatically selects a zone.
+   * The zone of the hot standby storage cluster. Valid values:
    * 
-   * > The default value is valid only when \\`HotStandbyCluster\\` is set to \\`on\\`. A specific zone is required when \\`HotStandbyCluster\\` is set to \\`equal\\`. For more information about zones, see [DescribeZones](https://help.aliyun.com/document_detail/98041.html).
+   * - **auto** (default): Automatically selected.
+   * > When the HotStandbyCluster parameter is set to on, you can use the default value. When the HotStandbyCluster parameter is set to equal, you must specify a specific zone. You can call the [DescribeZones](https://help.aliyun.com/document_detail/98041.html) operation to query zone details.
    * 
    * @example
    * cn-beijing-i