@alicloud/polardb20170801 8.1.1 → 8.2.1

package/src/models/AnswerKnowledgeBaseRequest.ts

@@ -0,0 +1,140 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AnswerKnowledgeBaseRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The maximum number of context characters. Valid values: 1000 to 32000.
+   * 
+   * @example
+   * 16000
+   */
+  maxContextChars?: number;
+  /**
+   * @remarks
+   * The user query text.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Summarize this year\\"s financial report
+   */
+  queryText?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable reranking. Default value: false.
+   * 
+   * @example
+   * false
+   */
+  rerankEnabled?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to return citation sources. Default value: true.
+   * 
+   * @example
+   * true
+   */
+  returnSources?: boolean;
+  /**
+   * @remarks
+   * The similarity score threshold.
+   * 
+   * @example
+   * 0.7
+   */
+  scoreThreshold?: number;
+  /**
+   * @remarks
+   * The search mode. Valid values: knn, rrf, precise, semantic, and balanced.
+   * 
+   * @example
+   * semantic
+   */
+  searchMode?: string;
+  /**
+   * @remarks
+   * The system prompt.
+   * 
+   * @example
+   * This is a minimal test prompt for security verification.
+   */
+  systemPrompt?: string;
+  /**
+   * @remarks
+   * The number of results to recall during retrieval.
+   * 
+   * @example
+   * 10
+   */
+  topK?: number;
+  /**
+   * @remarks
+   * The supplementary user instructions.
+   * 
+   * @example
+   * Return a short summary and test result.
+   */
+  userInstructions?: string;
+  static names(): { [key: string]: string } {
+    return {
+      knowledgeBaseId: 'KnowledgeBaseId',
+      maxContextChars: 'MaxContextChars',
+      queryText: 'QueryText',
+      regionId: 'RegionId',
+      rerankEnabled: 'RerankEnabled',
+      returnSources: 'ReturnSources',
+      scoreThreshold: 'ScoreThreshold',
+      searchMode: 'SearchMode',
+      systemPrompt: 'SystemPrompt',
+      topK: 'TopK',
+      userInstructions: 'UserInstructions',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      knowledgeBaseId: 'string',
+      maxContextChars: 'number',
+      queryText: 'string',
+      regionId: 'string',
+      rerankEnabled: 'boolean',
+      returnSources: 'boolean',
+      scoreThreshold: 'number',
+      searchMode: 'string',
+      systemPrompt: 'string',
+      topK: 'number',
+      userInstructions: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AnswerKnowledgeBaseResponse.ts

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

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AnswerKnowledgeBaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the Q&A task.
+   * 
+   * @example
+   * R3BGbnBqcXN******.2a5a23c9-******-179970533d30
+   */
+  queryId?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * A7E6A8FD-C50B-46B2-BA85-D8B8D3******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The status of the Q&A task.
+   * 
+   * @example
+   * Running
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      queryId: 'QueryId',
+      requestId: 'RequestId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      queryId: 'string',
+      requestId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateKbsyncLinkRequest.ts

@@ -0,0 +1,124 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateKBSyncLinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * cli_xxxxxxbe8
+   */
+  clientId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * ******
+   */
+  clientSecret?: string;
+  /**
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * testName
+   */
+  linkName?: string;
+  mcpEndpoint?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  sheetMcpEndpoint?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * https://example.feishu.cn/wiki/space/xxxxxx
+   */
+  sourceDir?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * FEISHU
+   */
+  sourceType?: string;
+  /**
+   * @example
+   * 30
+   */
+  syncIntervalMinutes?: number;
+  /**
+   * @example
+   * 63eexxxx-xxxx-xxxx-xxxx-xxxxxx090f82
+   */
+  tenantId?: string;
+  userId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      clientId: 'ClientId',
+      clientSecret: 'ClientSecret',
+      description: 'Description',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      linkName: 'LinkName',
+      mcpEndpoint: 'McpEndpoint',
+      regionId: 'RegionId',
+      sheetMcpEndpoint: 'SheetMcpEndpoint',
+      sourceDir: 'SourceDir',
+      sourceType: 'SourceType',
+      syncIntervalMinutes: 'SyncIntervalMinutes',
+      tenantId: 'TenantId',
+      userId: 'UserId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      clientId: 'string',
+      clientSecret: 'string',
+      description: 'string',
+      knowledgeBaseId: 'string',
+      linkName: 'string',
+      mcpEndpoint: 'string',
+      regionId: 'string',
+      sheetMcpEndpoint: 'string',
+      sourceDir: 'string',
+      sourceType: 'string',
+      syncIntervalMinutes: 'number',
+      tenantId: 'string',
+      userId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateKbsyncLinkResponse.ts

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

@@ -0,0 +1,94 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class CreateKBSyncLinkResponseBody extends $dara.Model {
+  /**
+   * @example
+   * cli_xxxxxxbe8
+   */
+  clientId?: string;
+  /**
+   * @example
+   * 2026-08-14T05:58:42Z
+   */
+  creationTime?: string;
+  /**
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @example
+   * FEISHU
+   */
+  imPlatform?: string;
+  /**
+   * @example
+   * pkbl-xxxxxx
+   */
+  linkId?: string;
+  /**
+   * @example
+   * testName
+   */
+  linkName?: string;
+  /**
+   * @example
+   * 24A1990B-4F6E-482B-B8CB-75C612******
+   */
+  requestId?: string;
+  /**
+   * @example
+   * https://example.feishu.cn/wiki/space/xxxxxx
+   */
+  sourceDir?: string;
+  /**
+   * @example
+   * 30
+   */
+  syncIntervalMinutes?: number;
+  /**
+   * @example
+   * CREATING
+   */
+  syncStatus?: string;
+  static names(): { [key: string]: string } {
+    return {
+      clientId: 'ClientId',
+      creationTime: 'CreationTime',
+      description: 'Description',
+      imPlatform: 'ImPlatform',
+      linkId: 'LinkId',
+      linkName: 'LinkName',
+      requestId: 'RequestId',
+      sourceDir: 'SourceDir',
+      syncIntervalMinutes: 'SyncIntervalMinutes',
+      syncStatus: 'SyncStatus',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      clientId: 'string',
+      creationTime: 'string',
+      description: 'string',
+      imPlatform: 'string',
+      linkId: 'string',
+      linkName: 'string',
+      requestId: 'string',
+      sourceDir: 'string',
+      syncIntervalMinutes: 'number',
+      syncStatus: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/CreateStoragePlanRequest.ts

@@ -3,10 +3,16 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateStoragePlanRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to automatically use coupons. Valid values:
+   * * true (default): Uses coupons.
+   * * false: Does not use coupons.
+   */
   autoUseCoupon?: boolean;
   /**
    * @remarks
-   * A client token to ensure the idempotence of the request. Generate this token on your client. The token must be unique across different requests. It is case-sensitive and can contain up to 64 ASCII characters.
+   * The client token that is used to ensure the idempotency 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. The token is case-sensitive and can contain only ASCII characters. The token can be up to 64 characters in length.
    * 
    * @example
    * 6000170000591aed949d0f5********************
@@ -16,11 +22,11 @@ export class CreateStoragePlanRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The unit of the subscription duration for the storage plan. Valid values:
+   * The unit of the storage plan duration. Valid values:
    * 
-   * - **Month**
+   * - **Month**: month.
    * 
-   * - **Year**
+   * - **Year**: year.
    * 
    * This parameter is required.
    * 
@@ -29,6 +35,9 @@ export class CreateStoragePlanRequest extends $dara.Model {
    */
   period?: string;
   /**
+   * @remarks
+   * The coupon code. If this parameter is not specified, the default coupon is used.
+   * 
    * @example
    * 727xxxxxx934
    */
@@ -37,7 +46,7 @@ export class CreateStoragePlanRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The capacity of the storage plan, in GB. Valid values: 50, 100, 200, 300, 500, 1,000, 2,000, 3,000, 5,000, 10,000, 15,000, 20,000, 25,000, 30,000, 50,000, 100,000, and 200,000.
+   * The capacity of the storage plan. Unit: GB. Valid values: 50, 100, 200, 300, 500, 1000, 2000, 3000, 5000, 10000, 15000, 20000, 25000, 30000, 50000, 100000, and 200000.
    * 
    * This parameter is required.
    * 
@@ -49,9 +58,9 @@ export class CreateStoragePlanRequest extends $dara.Model {
    * @remarks
    * The type of the storage plan. Valid values:
    * 
-   * - **Mainland**: For use in the Chinese mainland.
+   * - **Mainland**: general-purpose, applicable in the Chinese mainland.
    * 
-   * - **Overseas**: For use in China (Hong Kong) and regions outside China.
+   * - **Overseas**: general-purpose, applicable in Hong Kong (China) and outside China.
    * 
    * This parameter is required.
    * 
@@ -61,11 +70,11 @@ export class CreateStoragePlanRequest extends $dara.Model {
   storageType?: string;
   /**
    * @remarks
-   * The subscription duration of the storage plan.
+   * The duration of the storage plan.
    * 
    * - If **Period** is set to **Month**, the value ranges from 1 to 9.
    * 
-   * - If **Period** is set to **Year**, the valid values are 1, 2, 3, and 5.
+   * - If **Period** is set to **Year**, valid values are 1, 2, 3, and 5.
    * 
    * This parameter is required.
    * 

package/src/models/DeleteDbclusterEndpointRequest.ts

@@ -15,7 +15,7 @@ export class DeleteDBClusterEndpointRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
-   * The ID of the custom cluster endpoint.
+   * The custom cluster endpoint ID.
    * 
    * This parameter is required.
    * 
@@ -26,6 +26,9 @@ export class DeleteDBClusterEndpointRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The PolarFs instance ID.
+   * 
    * @example
    * pfs-test*****
    */

package/src/models/DeleteKbsyncLinkRequest.ts

@@ -0,0 +1,54 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DeleteKBSyncLinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * pkbl-xxxxx
+   */
+  linkId?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      knowledgeBaseId: 'KnowledgeBaseId',
+      linkId: 'LinkId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      knowledgeBaseId: 'string',
+      linkId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DeleteKbsyncLinkResponse.ts

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