@alicloud/polardb20170801 8.4.3 → 9.0.1

package/src/models/RegisterAidbclusterCustomModelResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RegisterAIDBClusterCustomModelResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the registration is newly created. A value of false indicates that an existing registration was updated.
+   * Indicates whether a new registration is created. A value of false indicates that an existing registration is updated.
    * 
    * @example
    * true
@@ -13,12 +13,20 @@ export class RegisterAIDBClusterCustomModelResponseBody extends $dara.Model {
   created?: boolean;
   /**
    * @remarks
-   * The display name and initial client-facing invocation name.
+   * The display name and the initial invocation name for clients.
    * 
    * @example
    * my-qwen3
    */
   displayModelName?: string;
+  /**
+   * @remarks
+   * The image import status. The initial value is Importing after an image is registered.
+   * 
+   * @example
+   * Importing
+   */
+  imageImportStatus?: string;
   /**
    * @remarks
    * The model registration ID.
@@ -63,6 +71,7 @@ export class RegisterAIDBClusterCustomModelResponseBody extends $dara.Model {
     return {
       created: 'Created',
       displayModelName: 'DisplayModelName',
+      imageImportStatus: 'ImageImportStatus',
       modelId: 'ModelId',
       modelName: 'ModelName',
       modelType: 'ModelType',
@@ -75,6 +84,7 @@ export class RegisterAIDBClusterCustomModelResponseBody extends $dara.Model {
     return {
       created: 'boolean',
       displayModelName: 'string',
+      imageImportStatus: 'string',
       modelId: 'number',
       modelName: 'string',
       modelType: 'string',

package/src/models/RegisterAidbclusterCustomModelShrinkRequest.ts

@@ -0,0 +1,162 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterAIDBClusterCustomModelShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The container startup environment variables. Variable names cannot be empty or contain whitespace. Variable values can be empty strings.
+   * 
+   * @example
+   * {"HF_HOME":"/cache/hf","EMPTY_VALUE":""}
+   */
+  containerEnvShrink?: string;
+  /**
+   * @remarks
+   * The name of the OSS bucket.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * my-model-bucket
+   */
+  customOssBucketName?: string;
+  /**
+   * @remarks
+   * The model path in the OSS bucket.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * models/qwen3
+   */
+  customOssBucketPath?: string;
+  /**
+   * @remarks
+   * The GPU instance type used for model deployment. Required when configuring deployment parameters.
+   * 
+   * @example
+   * polardb.gpu.gn8is.4xlarge
+   */
+  DBInstanceClass?: string;
+  /**
+   * @remarks
+   * The direct startup command for the model container.
+   * 
+   * @example
+   * python -m vllm.entrypoints.openai.api_server
+   */
+  directCommand?: string;
+  /**
+   * @remarks
+   * The display name in the candidate list and the initial invocation name for clients.
+   * 
+   * @example
+   * my-qwen3
+   */
+  displayModelName?: string;
+  /**
+   * @remarks
+   * The full reference of the customer-owned inference image, in the format of registry/repository:tag.
+   * 
+   * @example
+   * registry.example.com/customer/model:v1
+   */
+  imageName?: string;
+  /**
+   * @remarks
+   * The inference engine. Required when configuring deployment parameters. Valid values: vllm and sglang.
+   * 
+   * @example
+   * vllm
+   */
+  inferenceEngine?: string;
+  /**
+   * @remarks
+   * The custom model registration key and model directory name.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * Qwen3-32B
+   */
+  modelName?: string;
+  /**
+   * @remarks
+   * The model startup parameters. Parameter keys must start with --.
+   * 
+   * @example
+   * {"--max-model-len":"32768"}
+   */
+  modelParamsShrink?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The password or temporary token for the customer image repository. Required when ImageName is specified.
+   * 
+   * @example
+   * temporary-token
+   */
+  registryPassword?: string;
+  /**
+   * @remarks
+   * The username for the customer image repository. Required when ImageName is specified.
+   * 
+   * @example
+   * temporary-user
+   */
+  registryUsername?: string;
+  static names(): { [key: string]: string } {
+    return {
+      containerEnvShrink: 'ContainerEnv',
+      customOssBucketName: 'CustomOssBucketName',
+      customOssBucketPath: 'CustomOssBucketPath',
+      DBInstanceClass: 'DBInstanceClass',
+      directCommand: 'DirectCommand',
+      displayModelName: 'DisplayModelName',
+      imageName: 'ImageName',
+      inferenceEngine: 'InferenceEngine',
+      modelName: 'ModelName',
+      modelParamsShrink: 'ModelParams',
+      regionId: 'RegionId',
+      registryPassword: 'RegistryPassword',
+      registryUsername: 'RegistryUsername',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      containerEnvShrink: 'string',
+      customOssBucketName: 'string',
+      customOssBucketPath: 'string',
+      DBInstanceClass: 'string',
+      directCommand: 'string',
+      displayModelName: 'string',
+      imageName: 'string',
+      inferenceEngine: 'string',
+      modelName: 'string',
+      modelParamsShrink: 'string',
+      regionId: 'string',
+      registryPassword: 'string',
+      registryUsername: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RemovePolarClawMcpserverRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RemovePolarClawMCPServerRequest extends $dara.Model {
   /**
    * @remarks
-   * The application ID.
+   * The PolarClaw application ID.
    * 
    * This parameter is required.
    * 

package/src/models/RemovePolarClawMcpserverResponseBody.ts

@@ -13,7 +13,7 @@ export class RemovePolarClawMCPServerResponseBody extends $dara.Model {
   applicationId?: string;
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * 200
@@ -29,7 +29,7 @@ export class RemovePolarClawMCPServerResponseBody extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. A value of `true` indicates success.
+   * Indicates whether the operation was successful.
    * 
    * @example
    * true
@@ -37,7 +37,7 @@ export class RemovePolarClawMCPServerResponseBody extends $dara.Model {
   ok?: boolean;
   /**
    * @remarks
-   * The request ID.
+   * Id of the request
    * 
    * @example
    * E56531A4-E552-40BA-9C58-137B80******

package/src/models/ResetAgenticDbtenantApiKeyRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ResetAgenticDBTenantApiKeyRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the target API key.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ResetAgenticDBTenantApiKeyRequest extends $dara.Model {
   apiKeyId?: string;
   /**
    * @remarks
+   * The AgenticDB cluster ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ResetAgenticDBTenantApiKeyRequest extends $dara.Model {
   DBClusterId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,6 +35,8 @@ export class ResetAgenticDBTenantApiKeyRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The ID of the target tenant.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ResetAgenticDbtenantApiKeyResponseBody.ts

@@ -4,36 +4,61 @@ import * as $dara from '@darabonba/typescript';
 
 export class ResetAgenticDBTenantApiKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The new API key in plaintext. This value is returned only in this response.
+   * 
    * @example
    * pagc_key_cGFnYy1icDFh...newSignature22ch
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The resource ID of the API key. This value remains unchanged after the reset.
+   * 
    * @example
    * ak-71304e39c7e841a1
    */
   apiKeyId?: string;
   /**
+   * @remarks
+   * The reset time, which is the effective period of the new key.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2026-06-10T14:00:00Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The expiration time.
+   * 
+   * The time is in ISO 8601 format in UTC (format: YYYY-MM-DDTHH:mm:ssZ).
+   * 
    * @example
    * 2027-01-01T00:00:00Z
    */
   expireTime?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * B2C3D4E5-F6A7-8901-BCDE-F12345678901
    */
   requestId?: string;
   /**
+   * @remarks
+   * The tenant ID.
+   * 
    * @example
    * t-4b83e0da66674951
    */
   tenantId?: string;
   /**
+   * @remarks
+   * The tenant name.
+   * 
    * @example
    * my-saas-app
    */

package/src/models/ResizeAidbclusterModelRequest.ts

@@ -0,0 +1,70 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ResizeAIDBClusterModelRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the PolarDB AI 3.0 logical instance.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pm-2ze4x2mwo81knj08a
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * Specifies whether to perform only a read-only capacity dry run.
+   * 
+   * @example
+   * true
+   */
+  dryRun?: boolean;
+  /**
+   * @remarks
+   * The region ID. Requests are routed to the region where the instance resides.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The target total capacity. An abstract capacity unit of 1000 is equivalent to one L20N card. The value must be a positive integer.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * 12000
+   */
+  targetCapacity?: number;
+  static names(): { [key: string]: string } {
+    return {
+      DBClusterId: 'DBClusterId',
+      dryRun: 'DryRun',
+      regionId: 'RegionId',
+      targetCapacity: 'TargetCapacity',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBClusterId: 'string',
+      dryRun: 'boolean',
+      regionId: 'string',
+      targetCapacity: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ResizeAidbclusterModelResponse.ts

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

@@ -0,0 +1,104 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ResizeAIDBClusterModelResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The current measured capacity of the instance. This parameter is returned only when DryRun is set to true.
+   * 
+   * @example
+   * 8000
+   */
+  currentCapacity?: number;
+  /**
+   * @remarks
+   * The ID of the PolarDB AI 3.0 logical instance.
+   * 
+   * @example
+   * pm-2ze4x2mwo81knj08a
+   */
+  DBClusterId?: string;
+  /**
+   * @remarks
+   * Indicates whether the current request performed only a capacity dry run.
+   * 
+   * @example
+   * true
+   */
+  dryRun?: boolean;
+  /**
+   * @remarks
+   * The capacity that can be directly borrowed from the global pool without reshaping. This parameter is returned only when DryRun is set to true.
+   * 
+   * @example
+   * 3000
+   */
+  poolHitCapacity?: number;
+  /**
+   * @remarks
+   * The direct hit ratio of the global pool. Valid values: 0 to 1. This parameter is returned only when DryRun is set to true.
+   * 
+   * @example
+   * 0.75
+   */
+  poolHitRatio?: number;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * 3AA6E0E4-1234-5678-90AB-1234567890AB
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The positive difference between the target capacity and the current capacity. This parameter is returned only when DryRun is set to true.
+   * 
+   * @example
+   * 4000
+   */
+  requiredDelta?: number;
+  /**
+   * @remarks
+   * The target total capacity.
+   * 
+   * @example
+   * 12000
+   */
+  targetCapacity?: number;
+  static names(): { [key: string]: string } {
+    return {
+      currentCapacity: 'CurrentCapacity',
+      DBClusterId: 'DBClusterId',
+      dryRun: 'DryRun',
+      poolHitCapacity: 'PoolHitCapacity',
+      poolHitRatio: 'PoolHitRatio',
+      requestId: 'RequestId',
+      requiredDelta: 'RequiredDelta',
+      targetCapacity: 'TargetCapacity',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentCapacity: 'number',
+      DBClusterId: 'string',
+      dryRun: 'boolean',
+      poolHitCapacity: 'number',
+      poolHitRatio: 'number',
+      requestId: 'string',
+      requiredDelta: 'number',
+      targetCapacity: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RestartPolarClawGatewayRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RestartPolarClawGatewayRequest extends $dara.Model {
   /**
    * @remarks
-   * The application ID.
+   * The PolarClaw application ID. Example: pa-xxx.
    * 
    * This parameter is required.
    * 
@@ -16,8 +16,8 @@ export class RestartPolarClawGatewayRequest extends $dara.Model {
   /**
    * @remarks
    * The restart mode. Valid values:
-   * - in-process: lightweight restart without applying environment variable changes. This is the default value.
-   * - pkill: cold start that applies environment variable changes.
+   * - in-process: lightweight restart. Environment variables do not take effect. This is the default value.
+   * - pkill: cold start. Environment variables take effect.
    * 
    * @example
    * in-process

package/src/models/RestartPolarClawGatewayResponseBody.ts

@@ -53,7 +53,7 @@ export class RestartPolarClawGatewayResponseBody extends $dara.Model {
   mode?: string;
   /**
    * @remarks
-   * Indicates whether the operation was successful.
+   * Indicates whether the operation is successful.
    * 
    * @example
    * true
@@ -77,7 +77,7 @@ export class RestartPolarClawGatewayResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the gateway has been confirmed available after the restart. This value is returned synchronously.
+   * Indicates whether the gateway is confirmed available after the restart. This value is returned synchronously.
    * 
    * @example
    * true

package/src/models/RetrievalKnowledgeBaseRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RetrievalKnowledgeBaseRequest extends $dara.Model {
   /**
    * @remarks
-   * The unique identifier of the knowledge base. You can specify multiple knowledge bases separated by commas. A maximum of 50 knowledge bases can be specified.
+   * The unique identifiers of the knowledge bases. You can specify up to 50 knowledge base IDs, separated by commas.
    * 
    * This parameter is required.
    * 

package/src/models/RetrievalKnowledgeBaseResponseBody.ts

@@ -21,7 +21,7 @@ export class RetrievalKnowledgeBaseResponseBodyResultsImageResources extends $da
   id?: string;
   /**
    * @remarks
-   * The element reference of the image in the Docling source document structure.
+   * The reference to the image element in the structure of the Docling source document.
    * 
    * @example
    * #/pictures/1
@@ -29,7 +29,7 @@ export class RetrievalKnowledgeBaseResponseBodyResultsImageResources extends $da
   itemRef?: string;
   /**
    * @remarks
-   * The media type of the image resource.
+   * The MIME type of the image resource.
    * 
    * @example
    * image/png
@@ -75,12 +75,12 @@ export class RetrievalKnowledgeBaseResponseBodyResultsImageResources extends $da
 export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   /**
    * @remarks
-   * The list of figure or table captions associated with the chunk.
+   * The list of captions for figures or tables associated with the chunk.
    */
   captions?: string[];
   /**
    * @remarks
-   * The list of Docling source document structured element references associated with the chunk. You can use these references to precisely locate elements in the original document.
+   * The list of references to structured elements in the Docling source document associated with the chunk. You can use these references to precisely locate the original elements.
    */
   docItems?: string[];
   /**
@@ -96,12 +96,12 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
    * The name of the file.
    * 
    * @example
-   * 2024FinancialReport.pdf
+   * 2024 Financial Report.pdf
    */
   fileName?: string;
   /**
    * @remarks
-   * The chain of section headings to which the chunk belongs.
+   * The heading hierarchy of the section to which the chunk belongs.
    */
   headings?: string[];
   /**
@@ -146,6 +146,14 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
    * 0.8
    */
   similarityScore?: number;
+  /**
+   * @remarks
+   * The URI of the source document.
+   * 
+   * @example
+   * https://example.com/source.pdf
+   */
+  sourceUri?: string;
   static names(): { [key: string]: string } {
     return {
       captions: 'Captions',
@@ -159,6 +167,7 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
       shardContent: 'ShardContent',
       shardIndex: 'ShardIndex',
       similarityScore: 'SimilarityScore',
+      sourceUri: 'SourceUri',
     };
   }
 
@@ -175,6 +184,7 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
       shardContent: 'string',
       shardIndex: 'number',
       similarityScore: 'number',
+      sourceUri: 'string',
     };
   }