@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/AiToolSelectionConfig.ts

@@ -4,6 +4,10 @@ import { AiPluginStatus } from "./AiPluginStatus";
 
 
 export class AiToolSelectionConfigEnableConditions extends $dara.Model {
+  /**
+   * @remarks
+   * The minimum number of tools required to activate tool selection.
+   */
   toolCountThreshold?: number;
   static names(): { [key: string]: string } {
     return {
@@ -27,7 +31,15 @@ export class AiToolSelectionConfigEnableConditions extends $dara.Model {
 }
 
 export class AiToolSelectionConfigQueryRewritingContextSelection extends $dara.Model {
+  /**
+   * @remarks
+   * The strategy for selecting the conversation context.
+   */
   type?: string;
+  /**
+   * @remarks
+   * The value associated with the context selection strategy, such as the number of messages to include.
+   */
   value?: number;
   static names(): { [key: string]: string } {
     return {
@@ -53,8 +65,20 @@ export class AiToolSelectionConfigQueryRewritingContextSelection extends $dara.M
 }
 
 export class AiToolSelectionConfigQueryRewritingModelService extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the model used for query rewriting.
+   */
   modelName?: string;
+  /**
+   * @remarks
+   * The ID of the model service used for query rewriting.
+   */
   serviceId?: string;
+  /**
+   * @remarks
+   * The request timeout in milliseconds for the query rewriting model service.
+   */
   timeoutMillisecond?: number;
   static names(): { [key: string]: string } {
     return {
@@ -82,7 +106,15 @@ export class AiToolSelectionConfigQueryRewritingModelService extends $dara.Model
 }
 
 export class AiToolSelectionConfigQueryRewritingPromptConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The custom prompt template for query rewriting. This parameter is required if `type` is set to `custom`.
+   */
   customPrompt?: string;
+  /**
+   * @remarks
+   * The type of prompt, such as default or custom.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -108,6 +140,10 @@ export class AiToolSelectionConfigQueryRewritingPromptConfig extends $dara.Model
 }
 
 export class AiToolSelectionConfigQueryRewritingTriggerConditions extends $dara.Model {
+  /**
+   * @remarks
+   * The minimum number of messages in the conversation history required to activate query rewriting.
+   */
   messageCountThreshold?: number;
   static names(): { [key: string]: string } {
     return {
@@ -131,12 +167,40 @@ export class AiToolSelectionConfigQueryRewritingTriggerConditions extends $dara.
 }
 
 export class AiToolSelectionConfigQueryRewriting extends $dara.Model {
+  /**
+   * @remarks
+   * Method for selecting the conversation context for query rewriting.
+   */
   contextSelection?: AiToolSelectionConfigQueryRewritingContextSelection;
+  /**
+   * @remarks
+   * Whether to enable query rewriting.
+   */
   enabled?: boolean;
+  /**
+   * @remarks
+   * The fallback strategy used if query rewriting fails or returns no results.
+   */
   fallbackStrategy?: string;
+  /**
+   * @remarks
+   * The maximum number of tokens to generate for the rewritten query.
+   */
   maxOutputTokens?: number;
+  /**
+   * @remarks
+   * Model service configuration for query rewriting.
+   */
   modelService?: AiToolSelectionConfigQueryRewritingModelService;
+  /**
+   * @remarks
+   * Prompt configuration for query rewriting.
+   */
   promptConfig?: AiToolSelectionConfigQueryRewritingPromptConfig;
+  /**
+   * @remarks
+   * Conditions for activating query rewriting.
+   */
   triggerConditions?: AiToolSelectionConfigQueryRewritingTriggerConditions;
   static names(): { [key: string]: string } {
     return {
@@ -184,8 +248,20 @@ export class AiToolSelectionConfigQueryRewriting extends $dara.Model {
 }
 
 export class AiToolSelectionConfigToolRerankingModelService extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the model used for reranking.
+   */
   modelName?: string;
+  /**
+   * @remarks
+   * The ID of the model service used for reranking.
+   */
   serviceId?: string;
+  /**
+   * @remarks
+   * The request timeout in milliseconds for the reranking model service.
+   */
   timeoutMillisecond?: number;
   static names(): { [key: string]: string } {
     return {
@@ -213,11 +289,35 @@ export class AiToolSelectionConfigToolRerankingModelService extends $dara.Model
 }
 
 export class AiToolSelectionConfigToolReranking extends $dara.Model {
+  /**
+   * @remarks
+   * The fallback strategy used if tool reranking fails or returns no results.
+   */
   fallbackStrategy?: string;
+  /**
+   * @remarks
+   * The method for filtering tools after reranking.
+   */
   filteringMethod?: string;
+  /**
+   * @remarks
+   * Model service configuration for tool reranking.
+   */
   modelService?: AiToolSelectionConfigToolRerankingModelService;
+  /**
+   * @remarks
+   * The minimum score a tool must have to be selected. Tools with scores below this threshold are filtered out.
+   */
   scoreThreshold?: number;
+  /**
+   * @remarks
+   * The percentage of top-ranked tools to select. This parameter only applies when `filteringMethod` is set to a percentage-based method.
+   */
   topKPercent?: number;
+  /**
+   * @remarks
+   * The number of top-ranked tools to select. This parameter only applies when `filteringMethod` is set to a count-based method.
+   */
   topNCount?: number;
   static names(): { [key: string]: string } {
     return {
@@ -254,13 +354,28 @@ export class AiToolSelectionConfigToolReranking extends $dara.Model {
 }
 
 export class AiToolSelectionConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Conditions for activating the tool selection feature.
+   */
   enableConditions?: AiToolSelectionConfigEnableConditions;
   /**
+   * @remarks
+   * The status of the AI tool selection plugin.
+   * 
    * **if can be null:**
    * true
    */
   pluginStatus?: AiPluginStatus;
+  /**
+   * @remarks
+   * Configuration for query rewriting, which optimizes user queries before tool selection.
+   */
   queryRewriting?: AiToolSelectionConfigQueryRewriting;
+  /**
+   * @remarks
+   * Configuration for tool reranking, which controls how tools are scored and filtered.
+   */
   toolReranking?: AiToolSelectionConfigToolReranking;
   static names(): { [key: string]: string } {
     return {

package/src/models/Attachment.ts

@@ -3,24 +3,38 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class Attachment extends $dara.Model {
+  /**
+   * @remarks
+   * The attachment point ID.
+   */
   attachResourceId?: string;
   /**
    * @remarks
-   * The resource IDs.
+   * A list of attached resource IDs.
    */
   attachResourceIds?: string[];
+  /**
+   * @remarks
+   * A list of parent resource IDs.
+   */
   attachResourceParentIds?: string[];
   /**
    * @remarks
-   * The supported mount point type. Valid values:
+   * The supported attachment point types for the policy.
+   * 
+   * - `HttpApi`: An HTTP API.
+   * 
+   * - `Operation`: An operation of an HTTP API.
+   * 
+   * - `GatewayRoute`: A gateway route.
+   * 
+   * - `GatewayService`: A gateway service.
+   * 
+   * - `GatewayServicePort`: A gateway service port.
+   * 
+   * - `Domain`: A gateway domain.
    * 
-   * *   HttpApi: an HTTP API
-   * *   Operation: an operation in an HTTP API
-   * *   GatewayRoute: a gateway route
-   * *   GatewayService: a gateway service
-   * *   GatewayServicePort: a gateway service port
-   * *   Domain: a gateway domain name
-   * *   Gateway: a gateway instance
+   * - `Gateway`: A gateway.
    * 
    * @example
    * HttpApi
@@ -28,7 +42,7 @@ export class Attachment extends $dara.Model {
   attachResourceType?: string;
   /**
    * @remarks
-   * The environment to which the mounted resource belongs. If an asterisk (\\*) is returned as the environment ID, the mounted resource is not related to the environment.
+   * The ID of the environment for the attached resource. An asterisk (`*`) indicates that the policy attachment is not environment-specific.
    * 
    * @example
    * env-cq7l5s5lhtgi6qasrdc0
@@ -36,7 +50,7 @@ export class Attachment extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The instance to which the mounted resource belongs.
+   * The ID of the gateway for the attached resource.
    * 
    * @example
    * gw-cpr4f9dlhtgq5ksfgmb0
@@ -44,7 +58,7 @@ export class Attachment extends $dara.Model {
   gatewayId?: string;
   /**
    * @remarks
-   * The mount ID.
+   * The policy attachment ID.
    * 
    * @example
    * pr-cq7l5s5lhtgi6qasrdc0

package/src/models/AuthorizationResourceInfo.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class AuthorizationResourceInfo extends $dara.Model {
   /**
+   * @remarks
+   * Environment ID.
+   * 
    * @example
    * env-cq7l5s5lhtgi6qasrdc0
    */
   environmentId?: string;
   /**
+   * @remarks
+   * Parent resource ID.
+   * 
    * @example
    * api-cujbijem1hkr4voden8g
    */
   parentResourceId?: string;
   /**
+   * @remarks
+   * Resource ID.
+   * 
    * @example
    * hr-d0mnu16m1hkgujnkgrcg
    */

package/src/models/CreateAndAttachPolicyRequest.ts

@@ -74,7 +74,7 @@ export class CreateAndAttachPolicyRequest extends $dara.Model {
    * The policy description.
    * 
    * @example
-   * This is the policy description.
+   * 这是策略描述
    */
   description?: string;
   /**

package/src/models/CreateConsumerAuthorizationRulesRequest.ts

@@ -5,15 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class CreateConsumerAuthorizationRulesRequestAuthorizationRulesResourceIdentifier extends $dara.Model {
   /**
    * @remarks
-   * The environment ID.
+   * Environment ID.
    * 
    * @example
-   * env-cti17hem1hktoruj98ug
+   * env-******
    */
   environmentId?: string;
   /**
    * @remarks
-   * Parent resource ID
+   * Parent resource ID.
    * 
    * @example
    * api-******
@@ -21,7 +21,7 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRulesResourceId
   parentResourceId?: string;
   /**
    * @remarks
-   * The resource ID.
+   * Resource ID.
    * 
    * @example
    * ha-cn-li942gy8p03
@@ -29,7 +29,7 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRulesResourceId
   resourceId?: string;
   /**
    * @remarks
-   * List of resources
+   * Resource information.
    */
   resources?: string[];
   static names(): { [key: string]: string } {
@@ -65,15 +65,15 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRulesResourceId
 export class CreateConsumerAuthorizationRulesRequestAuthorizationRules extends $dara.Model {
   /**
    * @remarks
-   * The consumer ID.
+   * Consumer ID.
    * 
    * @example
-   * cs-cu08olem1hkokaut34i0
+   * cs-******
    */
   consumerId?: string;
   /**
    * @remarks
-   * The expiration mode. Valid values: LongTerm and ShortTerm.
+   * Expiration mode. Currently only LongTerm is supported.
    * 
    * @example
    * LongTerm
@@ -81,7 +81,7 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRules extends $
   expireMode?: string;
   /**
    * @remarks
-   * The expiration timestamp.
+   * Expiration time.
    * 
    * @example
    * 174116222x
@@ -89,12 +89,12 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRules extends $
   expireTimestamp?: number;
   /**
    * @remarks
-   * The resource identifier, which is provided to non-standard code sources for space reuse.
+   * Resource identifier, provided to non-standard code sources as a unique identifier for space reuse
    */
   resourceIdentifier?: CreateConsumerAuthorizationRulesRequestAuthorizationRulesResourceIdentifier;
   /**
    * @remarks
-   * The resource type.
+   * Resource type.
    * 
    * @example
    * HttpApiRoute
@@ -135,7 +135,7 @@ export class CreateConsumerAuthorizationRulesRequestAuthorizationRules extends $
 export class CreateConsumerAuthorizationRulesRequest extends $dara.Model {
   /**
    * @remarks
-   * The consumer authentication rules to be created.
+   * Consumer authorization rules.
    */
   authorizationRules?: CreateConsumerAuthorizationRulesRequestAuthorizationRules[];
   static names(): { [key: string]: string } {

package/src/models/CreateConsumerAuthorizationRulesResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateConsumerAuthorizationRulesResponseBodyData extends $dara.Model {
   /**
    * @remarks
-   * The authentication rule IDs.
+   * List of consumer authorization rule IDs.
    */
   consumerAuthorizationRuleIds?: string[];
   static names(): { [key: string]: string } {
@@ -35,7 +35,7 @@ export class CreateConsumerAuthorizationRulesResponseBodyData extends $dara.Mode
 export class CreateConsumerAuthorizationRulesResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * Response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class CreateConsumerAuthorizationRulesResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response parameters.
+   * Response data.
    */
   data?: CreateConsumerAuthorizationRulesResponseBodyData;
   /**
    * @remarks
-   * The returned message.
+   * Response message.
    * 
    * @example
    * success

package/src/models/CreateConsumerRequest.ts

@@ -8,17 +8,17 @@ import { JwtIdentityConfig } from "./JwtIdentityConfig";
 export class CreateConsumerRequest extends $dara.Model {
   /**
    * @remarks
-   * The list of AK/SK identity configurations.
+   * A list of AK/SK identity configurations.
    */
   akSkIdentityConfigs?: AkSkIdentityConfig[];
   /**
    * @remarks
-   * The configuration for the API key authentication method.
+   * The identity configuration for API key authentication.
    */
   apikeyIdentityConfig?: ApiKeyIdentityConfig;
   /**
    * @remarks
-   * The description of the consumer.
+   * The consumer description.
    * 
    * @example
    * consumer for test
@@ -26,7 +26,7 @@ export class CreateConsumerRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Indicates if enabled.
+   * Specifies whether to enable the consumer.
    * 
    * @example
    * false
@@ -34,7 +34,11 @@ export class CreateConsumerRequest extends $dara.Model {
   enable?: boolean;
   /**
    * @remarks
-   * The type of the gateway.
+   * The gateway type. Valid values:
+   * 
+   * - API: For a cloud-native API gateway.
+   * 
+   * - AI: For an AI gateway.
    * 
    * @example
    * API
@@ -42,12 +46,12 @@ export class CreateConsumerRequest extends $dara.Model {
   gatewayType?: string;
   /**
    * @remarks
-   * The configuration of the JWT identity.
+   * The JWT identity configuration.
    */
   jwtIdentityConfig?: JwtIdentityConfig;
   /**
    * @remarks
-   * The name of the consumer.
+   * The consumer name.
    * 
    * @example
    * test

package/src/models/CreateConsumerResponseBody.ts

@@ -35,7 +35,7 @@ export class CreateConsumerResponseBodyData extends $dara.Model {
 export class CreateConsumerResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The status code.
+   * The response status code.
    * 
    * @example
    * Ok
@@ -43,12 +43,12 @@ export class CreateConsumerResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The response payload.
+   * The response data.
    */
   data?: CreateConsumerResponseBodyData;
   /**
    * @remarks
-   * The status message.
+   * The response message.
    * 
    * @example
    * success

package/src/models/CreateDomainRequest.ts

@@ -100,7 +100,7 @@ export class CreateDomainRequest extends $dara.Model {
    * The [resource group ID](https://help.aliyun.com/document_detail/151181.html).
    * 
    * @example
-   * rg-aekzoiafjtr7zyq
+   * rg-aekzhiv7derfweq
    */
   resourceGroupId?: string;
   /**

package/src/models/CreateEnvironmentRequest.ts

@@ -10,7 +10,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * The environment name.
+   * 测试环境
    */
   alias?: string;
   /**
@@ -18,7 +18,7 @@ export class CreateEnvironmentRequest extends $dara.Model {
    * The environment alias.
    * 
    * @example
-   * Test environment
+   * 这是xxx的xx项目测试环境
    */
   description?: string;
   /**

package/src/models/CreateGatewayRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateGatewayRequestLogConfigSls extends $dara.Model {
   /**
+   * @remarks
+   * Whether to enable.
+   * 
    * @example
    * false
    */
@@ -30,6 +33,10 @@ export class CreateGatewayRequestLogConfigSls extends $dara.Model {
 }
 
 export class CreateGatewayRequestLogConfig extends $dara.Model {
+  /**
+   * @remarks
+   * SLS log configuration.
+   */
   sls?: CreateGatewayRequestLogConfigSls;
   static names(): { [key: string]: string } {
     return {
@@ -87,11 +94,17 @@ export class CreateGatewayRequestNetworkAccessConfig extends $dara.Model {
 
 export class CreateGatewayRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * key
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the label.
+   * 
    * @example
    * value
    */
@@ -121,11 +134,17 @@ export class CreateGatewayRequestTag extends $dara.Model {
 
 export class CreateGatewayRequestZoneConfigZones extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the virtual switch.
+   * 
    * @example
    * vsw-xx
    */
   vSwitchId?: string;
   /**
+   * @remarks
+   * The ID of the zone.
+   * 
    * @example
    * cn-wulanchabu-a
    */
@@ -163,10 +182,17 @@ export class CreateGatewayRequestZoneConfig extends $dara.Model {
    */
   selectOption?: string;
   /**
+   * @remarks
+   * Virtual switch ID.
+   * 
    * @example
    * vsw-xxx
    */
   vSwitchId?: string;
+  /**
+   * @remarks
+   * List of supported zones.
+   */
   zones?: CreateGatewayRequestZoneConfigZones[];
   static names(): { [key: string]: string } {
     return {
@@ -206,6 +232,13 @@ export class CreateGatewayRequest extends $dara.Model {
    */
   chargeType?: string;
   /**
+   * @remarks
+   * Gateway instance edition:
+   * 
+   * - Standard instance: Professional
+   * 
+   * - Serverless: Serverless (currently supports only AI gateway)
+   * 
    * @example
    * Professional
    */
@@ -218,6 +251,10 @@ export class CreateGatewayRequest extends $dara.Model {
    * API
    */
   gatewayType?: string;
+  /**
+   * @remarks
+   * Gateway log configuration.
+   */
   logConfig?: CreateGatewayRequestLogConfig;
   /**
    * @remarks
@@ -233,6 +270,9 @@ export class CreateGatewayRequest extends $dara.Model {
    */
   networkAccessConfig?: CreateGatewayRequestNetworkAccessConfig;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-ahr5uil8raz0rq3b
    */
@@ -245,6 +285,10 @@ export class CreateGatewayRequest extends $dara.Model {
    * apigw.dev.x2
    */
   spec?: string;
+  /**
+   * @remarks
+   * The list of labels.
+   */
   tag?: CreateGatewayRequestTag[];
   /**
    * @remarks

package/src/models/CreateGatewayResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateGatewayResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Gateway ID.
+   * 
    * @example
    * gw-cq2vundlhtg***
    */
@@ -31,12 +34,22 @@ export class CreateGatewayResponseBodyData extends $dara.Model {
 
 export class CreateGatewayResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Response status code.
+   * 
    * @example
    * Ok
    */
   code?: string;
+  /**
+   * @remarks
+   * Response data.
+   */
   data?: CreateGatewayResponseBodyData;
   /**
+   * @remarks
+   * Response message.
+   * 
    * @example
    * success
    */