@alicloud/gpdb20160503 3.9.0 → 3.11.0

package/src/models/GetStatementResultRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetStatementResultRequest extends $dara.Model {
   /**
    * @remarks
-   * Instance ID. Can be obtained by calling DescribeDBInstances.
+   * The instance ID. You can call DescribeDBInstances to obtain the ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class GetStatementResultRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * Database name.
+   * The database name.
    * 
    * @example
    * test
@@ -23,7 +23,7 @@ export class GetStatementResultRequest extends $dara.Model {
   database?: string;
   /**
    * @remarks
-   * Task ID for asynchronous SQL execution.
+   * The task ID of the asynchronous SQL execution.
    * 
    * This parameter is required.
    * 
@@ -34,7 +34,7 @@ export class GetStatementResultRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * Region ID where the instance is located.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 
@@ -44,9 +44,9 @@ export class GetStatementResultRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Access credential. Created through the CreateSecret interface.
+   * The access credential. Created by calling the CreateSecret operation.
    * 
-   * > When accessing this interface with a sub-account, the sub-account must have the UseSecret or GetSecretValue permission for this SecretArn.
+   * > When you access this operation by using a RAM user, you must have the UseSecret or GetSecretValue permission on this SecretArn.
    * 
    * This parameter is required.
    * 

package/src/models/GetStatementResultResponseBody.ts

@@ -87,7 +87,7 @@ export class GetStatementResultResponseBodyData extends $dara.Model {
   records?: GetStatementResultResponseBodyDataRecords;
   /**
    * @remarks
-   * Total number of entries.
+   * The total number of rows.
    * 
    * @example
    * 10
@@ -132,7 +132,7 @@ export class GetStatementResultResponseBody extends $dara.Model {
   data?: GetStatementResultResponseBodyData;
   /**
    * @remarks
-   * Return message.
+   * The response message.
    * 
    * @example
    * success
@@ -140,7 +140,7 @@ export class GetStatementResultResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -148,10 +148,10 @@ export class GetStatementResultResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * API execution status, with values as follows:
+   * The execution status of the API operation. Valid values:
    * 
-   * - **false**: Execution failed.
-   * - **true**: Execution succeeded.
+   * - **false**: Failed.
+   * - **true**: Succeeded.
    * 
    * @example
    * success

package/src/models/GetUploadDocumentJobRequest.ts

@@ -7,7 +7,7 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
    * @remarks
    * The name of the document collection.
    * 
-   * > You can call the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation to create a document collection and call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to query a list of document collections.
+   * > A document collection is created by calling the [CreateDocumentCollection](https://help.aliyun.com/document_detail/2618448.html) operation. You can call the [ListDocumentCollections](https://help.aliyun.com/document_detail/2618452.html) operation to view existing document collections.
    * 
    * This parameter is required.
    * 
@@ -17,9 +17,9 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
   collection?: string;
   /**
    * @remarks
-   * The ID of the instance for which vector engine optimization is enabled.
+   * The ID of the instance that has the vector engine optimization feature enabled.
    * 
-   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
+   * > You can call the [DescribeDBInstances](https://help.aliyun.com/document_detail/86911.html) operation to query the details of all AnalyticDB for PostgreSQL instances in a region, including instance IDs.
    * 
    * This parameter is required.
    * 
@@ -29,7 +29,7 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The ID of the document upload job. You can call the `UploadDocumentAsync` operation to obtain the job ID.
+   * The ID of the document upload task, which is obtained from the UploadDocumentAsync operation.
    * 
    * This parameter is required.
    * 
@@ -39,9 +39,9 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
   jobId?: string;
   /**
    * @remarks
-   * The name of the namespace for tenant isolation. Default value: public.
+   * The namespace, which is used for tenant isolation. Default value: public.
    * 
-   * > You can call the [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) operation to create a namespace and call the [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html) operation to query a list of namespaces.
+   * > You can create a namespace by calling [CreateNamespace](https://help.aliyun.com/document_detail/2401495.html) and view the list of namespaces by calling [ListNamespaces](https://help.aliyun.com/document_detail/2401502.html).
    * 
    * @example
    * mynamespace
@@ -51,7 +51,7 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
    * @remarks
    * The password of the namespace.
    * 
-   * > The value of this parameter is specified when you call the CreateNamespace operation.
+   * > This value is specified by the CreateNamespace operation.
    * 
    * This parameter is required.
    * 
@@ -62,7 +62,7 @@ export class GetUploadDocumentJobRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the cluster.
+   * The region ID of the instance.
    * 
    * This parameter is required.
    * 

package/src/models/GetUploadDocumentJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetUploadDocumentJobResponseBodyChunkResult extends $dara.Model {
   /**
    * @remarks
-   * The URL of the file after chunking. The validity period of the URL is 2 hours. The file is in the JSONL format. Each line is in the `{"page_content":"*****", "metadata": {"**":"***","**":"***"}` format.
+   * The URL of the chunked file. The URL is valid for 2 hours. The file is in JSONL format, and each line is in the format `{"page_content":"*****", "metadata": {"**":"***","**":"***"}`.
    * 
    * @example
    * http://xxx/test.jsonl
@@ -13,7 +13,7 @@ export class GetUploadDocumentJobResponseBodyChunkResult extends $dara.Model {
   chunkFileUrl?: string;
   /**
    * @remarks
-   * The markdown output file that is generated by the ADBPGLoader. The validity period is 2 hours.
+   * The markdown result file parsed by ADBPGLoader. The URL is valid for 2 hours.
    * 
    * @example
    * http://oss.xxx/adbpg_loader_result.md
@@ -21,7 +21,7 @@ export class GetUploadDocumentJobResponseBodyChunkResult extends $dara.Model {
   documentLoaderResultFileUrl?: string;
   /**
    * @remarks
-   * The URL of the file that does not contain metadata after chunking. The validity period of the URL is 2 hours. The file is in the TXT format. Each line is a chunk. The file can be easily used for embedding.
+   * The URL of the chunked file without metadata. The URL is valid for 2 hours. The file is in plain text format, and each line represents a chunk. This file can be conveniently used for embedding.
    * 
    * @example
    * http://xxx/test.txt
@@ -63,7 +63,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   completed?: boolean;
   /**
    * @remarks
-   * Job creation time.
+   * The time when the task was created.
    * 
    * @example
    * 2024-01-08 16:52:04.864664
@@ -71,7 +71,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The error message that is returned when the current operation is abnormal or fails.
+   * The error message returned when the operation encounters an exception or fails.
    * 
    * @example
    * Failed to connect database.
@@ -79,7 +79,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   error?: string;
   /**
    * @remarks
-   * The error code returned.
+   * The error code.
    * 
    * @example
    * InternalError
@@ -87,7 +87,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   errorCode?: string;
   /**
    * @remarks
-   * The job ID.
+   * Job ID。
    * 
    * @example
    * 231460f8-75dc-405e-a669-0c5204887e91
@@ -95,7 +95,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   id?: string;
   /**
    * @remarks
-   * The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.
+   * The upload progress. This value is a percentage. A value of 100 indicates that the upload is complete.
    * 
    * @example
    * 20
@@ -103,15 +103,14 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   progress?: number;
   /**
    * @remarks
-   * The status of the job. Valid values:
-   * 
-   * *   Success
-   * *   Failed (See the Error parameter for failure reasons.)
-   * *   Cancelling
-   * *   Cancelled
-   * *   Start
-   * *   Running
-   * *   Pending
+   * The task status. Valid values:
+   * - Success: The task is successful.
+   * - Failed: The task failed. You can view the Error field for the failure reason.
+   * - Cancelling: The task is being canceled.
+   * - Cancelled: The task is canceled.
+   * - Start: The task has started.
+   * - Running: The task is running.
+   * - Pending: The task is pending.
    * 
    * @example
    * Running
@@ -119,7 +118,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Job last updated time
+   * The time when the task was last updated.
    * 
    * @example
    * 2024-01-08 16:53:04.864664
@@ -163,7 +162,7 @@ export class GetUploadDocumentJobResponseBodyJob extends $dara.Model {
 export class GetUploadDocumentJobResponseBodyUsage extends $dara.Model {
   /**
    * @remarks
-   * The number of entries during vectorization.
+   * The number of entries used during embedding.
    * 
    * @example
    * 10
@@ -171,9 +170,9 @@ export class GetUploadDocumentJobResponseBodyUsage extends $dara.Model {
   embeddingEntries?: number;
   /**
    * @remarks
-   * The number of tokens that are consumed during vectorization.
+   * The number of tokens used during embedding.
    * 
-   * > A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.
+   * > A token is the smallest unit into which the input text is split. A token can be a word, a phrase, a punctuation mark, or a character.
    * 
    * @example
    * 475
@@ -210,12 +209,12 @@ export class GetUploadDocumentJobResponseBody extends $dara.Model {
   chunkResult?: GetUploadDocumentJobResponseBodyChunkResult;
   /**
    * @remarks
-   * The information about the document upload job.
+   * The details of the document upload task.
    */
   job?: GetUploadDocumentJobResponseBodyJob;
   /**
    * @remarks
-   * The returned message.
+   * The detailed information returned by the operation.
    * 
    * @example
    * success
@@ -223,7 +222,7 @@ export class GetUploadDocumentJobResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * The unique ID of the request.
+   * The request ID.
    * 
    * @example
    * ABB39CC3-4488-4857-905D-2E4A051D0521
@@ -231,10 +230,9 @@ export class GetUploadDocumentJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The status of the operation. Valid values:
-   * 
-   * *   **success**
-   * *   **fail**
+   * The status of this operation. Valid values:
+   * - **success**: The operation is successful.
+   * - **fail**: The operation failed.
    * 
    * @example
    * success
@@ -242,7 +240,7 @@ export class GetUploadDocumentJobResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The number of tokens that are consumed by document understanding or embedding.
+   * The number of tokens or entries consumed by document understanding or embedding.
    */
   usage?: GetUploadDocumentJobResponseBodyUsage;
   static names(): { [key: string]: string } {

package/src/models/GetWorkspaceRequest.ts

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

package/src/models/GetWorkspaceResponse.ts

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

@@ -0,0 +1,235 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetWorkspaceResponseBodyApikeysAuthServices extends $dara.Model {
+  /**
+   * @example
+   * agdb-xxxxxx
+   */
+  serviceId?: string;
+  /**
+   * @example
+   * memory
+   */
+  serviceType?: string;
+  static names(): { [key: string]: string } {
+    return {
+      serviceId: 'ServiceId',
+      serviceType: 'ServiceType',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      serviceId: 'string',
+      serviceType: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetWorkspaceResponseBodyApikeys extends $dara.Model {
+  authServices?: GetWorkspaceResponseBodyApikeysAuthServices[];
+  /**
+   * @example
+   * Sat Mar 14 14:44:27 GMT+08:00 2026
+   */
+  createTime?: string;
+  /**
+   * @example
+   * my test key
+   */
+  description?: string;
+  /**
+   * @example
+   * api-xxxxxx
+   */
+  keyId?: string;
+  /**
+   * @example
+   * my test key
+   */
+  keyName?: string;
+  /**
+   * @example
+   * sk-1235*****
+   */
+  keyPrefix?: string;
+  static names(): { [key: string]: string } {
+    return {
+      authServices: 'AuthServices',
+      createTime: 'CreateTime',
+      description: 'Description',
+      keyId: 'KeyId',
+      keyName: 'KeyName',
+      keyPrefix: 'KeyPrefix',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      authServices: { 'type': 'array', 'itemType': GetWorkspaceResponseBodyApikeysAuthServices },
+      createTime: 'string',
+      description: 'string',
+      keyId: 'string',
+      keyName: 'string',
+      keyPrefix: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.authServices)) {
+      $dara.Model.validateArray(this.authServices);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetWorkspaceResponseBodyServices extends $dara.Model {
+  /**
+   * @example
+   * 2026-03-01T00:00:00Z
+   */
+  createTime?: string;
+  /**
+   * @example
+   * 2
+   */
+  cu?: string;
+  /**
+   * @example
+   * 2026-06-21T16:00:00Z
+   */
+  expireTime?: string;
+  /**
+   * @example
+   * Postpaid
+   */
+  payType?: string;
+  /**
+   * @example
+   * agdb-xxx
+   */
+  serviceId?: string;
+  /**
+   * @example
+   * agdb-xxx
+   */
+  serviceName?: string;
+  /**
+   * @example
+   * memory
+   */
+  serviceType?: string;
+  /**
+   * @example
+   * active
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      cu: 'Cu',
+      expireTime: 'ExpireTime',
+      payType: 'PayType',
+      serviceId: 'ServiceId',
+      serviceName: 'ServiceName',
+      serviceType: 'ServiceType',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      cu: 'string',
+      expireTime: 'string',
+      payType: 'string',
+      serviceId: 'string',
+      serviceName: 'string',
+      serviceType: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetWorkspaceResponseBody extends $dara.Model {
+  apikeys?: GetWorkspaceResponseBodyApikeys[];
+  /**
+   * @example
+   * 2026-06-01T00:00:00Z
+   */
+  createTime?: string;
+  /**
+   * @example
+   * ABB39CC3-4488-4857-905D-2E4A051D0521
+   */
+  requestId?: string;
+  services?: GetWorkspaceResponseBodyServices[];
+  /**
+   * @example
+   * ws-*****
+   */
+  workspaceId?: string;
+  /**
+   * @example
+   * my-first-workspace
+   */
+  workspaceName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      apikeys: 'Apikeys',
+      createTime: 'CreateTime',
+      requestId: 'RequestId',
+      services: 'Services',
+      workspaceId: 'WorkspaceId',
+      workspaceName: 'WorkspaceName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      apikeys: { 'type': 'array', 'itemType': GetWorkspaceResponseBodyApikeys },
+      createTime: 'string',
+      requestId: 'string',
+      services: { 'type': 'array', 'itemType': GetWorkspaceResponseBodyServices },
+      workspaceId: 'string',
+      workspaceName: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.apikeys)) {
+      $dara.Model.validateArray(this.apikeys);
+    }
+    if(Array.isArray(this.services)) {
+      $dara.Model.validateArray(this.services);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListAinodePoolsRequest.ts

@@ -15,7 +15,7 @@ export class ListAINodePoolsRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The region ID.
+   * Region ID。
    * 
    * @example
    * cn-hangzhou