@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/AddGatewayQuotaRuleRequest.ts

@@ -0,0 +1,119 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddGatewayQuotaRuleRequest extends $dara.Model {
+  /**
+   * @example
+   * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
+   */
+  conflictHash?: string;
+  /**
+   * @example
+   * group1,group2
+   */
+  consumerGroupIds?: string[];
+  /**
+   * @example
+   * 1001,1002,1003
+   */
+  consumerIds?: string[];
+  /**
+   * @example
+   * false
+   */
+  dryRun?: boolean;
+  /**
+   * @example
+   * false
+   */
+  overwrite?: boolean;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * week
+   */
+  periodType?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * token
+   */
+  quotaDimension?: string;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 1000
+   */
+  quotaLimit?: number;
+  /**
+   * @remarks
+   * This parameter is required.
+   * 
+   * @example
+   * 团队规则
+   */
+  ruleName?: string;
+  /**
+   * @example
+   * UTC+8
+   */
+  timezone?: string;
+  /**
+   * @example
+   * calendar
+   */
+  windowAlignment?: string;
+  static names(): { [key: string]: string } {
+    return {
+      conflictHash: 'conflictHash',
+      consumerGroupIds: 'consumerGroupIds',
+      consumerIds: 'consumerIds',
+      dryRun: 'dryRun',
+      overwrite: 'overwrite',
+      periodType: 'periodType',
+      quotaDimension: 'quotaDimension',
+      quotaLimit: 'quotaLimit',
+      ruleName: 'ruleName',
+      timezone: 'timezone',
+      windowAlignment: 'windowAlignment',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      conflictHash: 'string',
+      consumerGroupIds: { 'type': 'array', 'itemType': 'string' },
+      consumerIds: { 'type': 'array', 'itemType': 'string' },
+      dryRun: 'boolean',
+      overwrite: 'boolean',
+      periodType: 'string',
+      quotaDimension: 'string',
+      quotaLimit: 'number',
+      ruleName: 'string',
+      timezone: 'string',
+      windowAlignment: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.consumerGroupIds)) {
+      $dara.Model.validateArray(this.consumerGroupIds);
+    }
+    if(Array.isArray(this.consumerIds)) {
+      $dara.Model.validateArray(this.consumerIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AddGatewayQuotaRuleResponse.ts

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

@@ -0,0 +1,176 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems extends $dara.Model {
+  /**
+   * @example
+   * cs-xxxxxx
+   */
+  consumerId?: string;
+  /**
+   * @example
+   * consumer-a
+   */
+  consumerName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      consumerId: 'consumerId',
+      consumerName: 'consumerName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      consumerId: 'string',
+      consumerName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class AddGatewayQuotaRuleResponseBodyDataConflictPreview extends $dara.Model {
+  /**
+   * @example
+   * f8f44dc6cf369a017d56b7197eb4fb5ac4bbb6b09a92b9b41999541fxxxxxxxx
+   */
+  conflictHash?: string;
+  items?: AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems[];
+  /**
+   * @example
+   * 2
+   */
+  totalConflictCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      conflictHash: 'conflictHash',
+      items: 'items',
+      totalConflictCount: 'totalConflictCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      conflictHash: 'string',
+      items: { 'type': 'array', 'itemType': AddGatewayQuotaRuleResponseBodyDataConflictPreviewItems },
+      totalConflictCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class AddGatewayQuotaRuleResponseBodyData extends $dara.Model {
+  /**
+   * @example
+   * true
+   */
+  accepted?: string;
+  conflictPreview?: AddGatewayQuotaRuleResponseBodyDataConflictPreview;
+  /**
+   * @example
+   * false
+   */
+  dryRun?: boolean;
+  /**
+   * @example
+   * qr-xxxxx
+   */
+  ruleId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      accepted: 'accepted',
+      conflictPreview: 'conflictPreview',
+      dryRun: 'dryRun',
+      ruleId: 'ruleId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      accepted: 'string',
+      conflictPreview: AddGatewayQuotaRuleResponseBodyDataConflictPreview,
+      dryRun: 'boolean',
+      ruleId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.conflictPreview && typeof (this.conflictPreview as any).validate === 'function') {
+      (this.conflictPreview as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class AddGatewayQuotaRuleResponseBody extends $dara.Model {
+  /**
+   * @example
+   * 200, 404, 500
+   */
+  code?: string;
+  /**
+   * @example
+   * {\\"key\\": \\"value\\"}
+   */
+  data?: AddGatewayQuotaRuleResponseBodyData;
+  /**
+   * @example
+   * 你好，世界！
+   */
+  message?: string;
+  /**
+   * @example
+   * 1234567890
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      message: 'message',
+      requestId: 'requestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: AddGatewayQuotaRuleResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AddGatewaySecurityGroupRuleRequest.ts

@@ -8,7 +8,7 @@ export class AddGatewaySecurityGroupRuleRequest extends $dara.Model {
    * The description of security group rule N.
    * 
    * @example
-   * ProductCenterSG
+   * 商品中心访问安全组
    */
   description?: string;
   /**

package/src/models/AgentServiceConfig.ts

@@ -10,7 +10,7 @@ export class AgentServiceConfigCustomConfig extends $dara.Model {
    * apiKey
    * 
    * @example
-   * sk-xxx
+   * app-xxx
    */
   apiKey?: string;
   /**
@@ -120,7 +120,7 @@ export class AgentServiceConfigDifyConfig extends $dara.Model {
    * API Key
    * 
    * @example
-   * sk-xxx
+   * app-xxx
    */
   apiKey?: string;
   /**
@@ -208,7 +208,7 @@ export class AgentServiceConfig extends $dara.Model {
    * This parameter is required.
    * 
    * @example
-   * aliyun
+   * qwen
    */
   provider?: string;
   static names(): { [key: string]: string } {

package/src/models/AiCacheConfig.ts

@@ -5,9 +5,25 @@ import { AiPolicyRedisConfig } from "./AiPolicyRedisConfig";
 
 
 export class AiCacheConfigEmbeddingConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The model name to use for generating embeddings, such as `text-embedding-v1`.
+   */
   modelName?: string;
+  /**
+   * @remarks
+   * The service ID of the deployed embedding model.
+   */
   serviceId?: string;
+  /**
+   * @remarks
+   * The request timeout in milliseconds. A request to the embedding service fails if it exceeds this duration. Default: `10000`.
+   */
   timeout?: number;
+  /**
+   * @remarks
+   * The type of embedding service. For example, specify `Tongyi` for Alibaba Cloud\\"s Tongyi Qwen model series.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -37,11 +53,35 @@ export class AiCacheConfigEmbeddingConfig extends $dara.Model {
 }
 
 export class AiCacheConfigVectorConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The API key to authenticate with the vector database service.
+   */
   apiKey?: string;
+  /**
+   * @remarks
+   * The unique ID of the collection or index within the vector database for search and storage.
+   */
   collectionId?: string;
+  /**
+   * @remarks
+   * The endpoint URL of the vector database service.
+   */
   serviceHost?: string;
+  /**
+   * @remarks
+   * The similarity threshold for a vector search to qualify as a cache hit. The value must be between 0.0 and 1.0. A higher value means a stricter similarity requirement.
+   */
   threshold?: number;
+  /**
+   * @remarks
+   * The request timeout in milliseconds. A request to the vector service fails if it exceeds this duration. Default: `10000`.
+   */
   timeout?: number;
+  /**
+   * @remarks
+   * The type of vector database service. For example, specify `DashVector` for Alibaba Cloud\\"s vector search service.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -75,20 +115,46 @@ export class AiCacheConfigVectorConfig extends $dara.Model {
 }
 
 export class AiCacheConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The cache key strategy, which determines how the system generates a unique key for each cacheable request. Valid values: `DEFAULT` and `CUSTOM`.
+   */
   cacheKeyStrategy?: string;
+  /**
+   * @remarks
+   * The cache mode, which defines the caching behavior. Valid values are `NORMAL` for standard key-value caching and `SEMANTIC` for vector-based similarity caching.
+   */
   cacheMode?: string;
+  /**
+   * @remarks
+   * The cache Time-to-Live (TTL) in seconds. This specifies the duration that a cached response remains valid. After the TTL expires, the cache removes the response.
+   */
   cacheTTL?: number;
+  /**
+   * @remarks
+   * The embedding configuration. Specifies the service that converts text queries into vector embeddings for semantic search.
+   */
   embeddingConfig?: AiCacheConfigEmbeddingConfig;
   /**
+   * @remarks
+   * The plugin status. Set to `enable` to activate the plugin or `disable` to deactivate it.
+   * 
    * **if can be null:**
    * true
    */
   pluginStatus?: AiPluginStatus;
   /**
+   * @remarks
+   * The Redis configuration, required if you use a Redis instance as the cache backend.
+   * 
    * **if can be null:**
    * true
    */
   redisConfig?: AiPolicyRedisConfig;
+  /**
+   * @remarks
+   * The vector configuration for semantic caching. This enables the cache to retrieve results based on semantic similarity instead of exact matches.
+   */
   vectorConfig?: AiCacheConfigVectorConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiFallbackConfig.ts

@@ -3,9 +3,25 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiFallbackConfigServiceConfigs extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the fallback service.
+   */
   name?: string;
+  /**
+   * @remarks
+   * Determines whether to pass the original model name to the fallback service. If `true`, the model name from the original request is used. If `false`, the value of `targetModelName` is used instead.
+   */
   passThroughModelName?: boolean;
+  /**
+   * @remarks
+   * The unique ID of the fallback service.
+   */
   serviceId?: string;
+  /**
+   * @remarks
+   * The name of the model to use for the fallback request.
+   */
   targetModelName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -35,7 +51,15 @@ export class AiFallbackConfigServiceConfigs extends $dara.Model {
 }
 
 export class AiFallbackConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Determines whether fallback is triggered solely by the upstream service\\"s status code. If `true`, fallback occurs only if the upstream service returns an error code. If `false`, other conditions, such as timeouts, can also trigger the fallback.
+   */
   onlyRedirectUpstreamCode?: boolean;
+  /**
+   * @remarks
+   * A list of fallback service configurations.
+   */
   serviceConfigs?: AiFallbackConfigServiceConfigs[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AiNetworkConfigSearchEngine.ts

@@ -3,15 +3,55 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiNetworkConfigSearchEngine extends $dara.Model {
+  /**
+   * @remarks
+   * Required. The API key to authenticate requests to the search engine service.
+   */
   apiKey?: string;
+  /**
+   * @remarks
+   * The search content mode, which determines how the service interprets the query and returns results.
+   */
   contentMode?: string;
+  /**
+   * @remarks
+   * The number of search results to return. If this parameter is omitted, the service uses a default value.
+   */
   count?: number;
+  /**
+   * @remarks
+   * The endpoint URL for the search engine service.
+   */
   endpoint?: string;
+  /**
+   * @remarks
+   * The industry context for tailoring search results to a specific domain.
+   */
   industry?: string;
+  /**
+   * @remarks
+   * Optional. A key-value map for service-specific parameters not covered by the standard configuration.
+   */
   optionArgs?: { [key: string]: string };
+  /**
+   * @remarks
+   * The starting offset for the search results, used for pagination. For example, a value of 10 skips the first 10 results. The default is 0.
+   */
   start?: number;
+  /**
+   * @remarks
+   * The time range for filtering results by their creation or modification date.
+   */
   timeRange?: string;
+  /**
+   * @remarks
+   * The request timeout in milliseconds. If a request exceeds this time, the service terminates it.
+   */
   timeoutMillisecond?: number;
+  /**
+   * @remarks
+   * Specifies the search engine service to use.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiNetworkSearchConfig.ts

@@ -5,10 +5,30 @@ import { AiNetworkConfigSearchEngine } from "./AiNetworkConfigSearchEngine";
 
 
 export class AiNetworkSearchConfigSearchRewrite extends $dara.Model {
+  /**
+   * @remarks
+   * Whether to enable the search query rewrite feature.
+   */
   enable?: boolean;
+  /**
+   * @remarks
+   * The maximum number of rewritten queries to generate.
+   */
   maxCount?: number;
+  /**
+   * @remarks
+   * The name of the model to use for query rewriting.
+   */
   modelName?: string;
+  /**
+   * @remarks
+   * The ID of the query rewriting service.
+   */
   serviceId?: string;
+  /**
+   * @remarks
+   * Timeout for the query rewriting operation, in milliseconds.
+   */
   timeoutMillisecond?: number;
   static names(): { [key: string]: string } {
     return {
@@ -40,18 +60,53 @@ export class AiNetworkSearchConfigSearchRewrite extends $dara.Model {
 }
 
 export class AiNetworkSearchConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Whether the network search feature is enabled by default.
+   */
   defaultEnable?: boolean;
+  /**
+   * @remarks
+   * The default language for the search query.
+   */
   defaultLang?: string;
+  /**
+   * @remarks
+   * Whether to include references in the search results.
+   */
   needReference?: boolean;
   /**
+   * @remarks
+   * The status of the AI plugin.
+   * 
    * **if can be null:**
    * true
    */
   pluginStatus?: AiPluginStatus;
+  /**
+   * @remarks
+   * The format of the references.
+   */
   referenceFormat?: string;
+  /**
+   * @remarks
+   * The location of the references in the response.
+   */
   referenceLocation?: string;
+  /**
+   * @remarks
+   * The search engine configuration.
+   */
   searchEngineConfig?: AiNetworkConfigSearchEngine;
+  /**
+   * @remarks
+   * A list of search engine configurations for the network search.
+   */
   searchFrom?: AiNetworkConfigSearchEngine[];
+  /**
+   * @remarks
+   * Configuration for search query rewriting.
+   */
   searchRewrite?: AiNetworkSearchConfigSearchRewrite;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiPluginStatus.ts

@@ -3,8 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiPluginStatus extends $dara.Model {
+  /**
+   * @remarks
+   * An object containing error logs, where each key is a string identifying an error and the value is a string describing that error.
+   */
   errorLogs?: { [key: string]: any }[];
+  /**
+   * @remarks
+   * The unique identifier of the plugin.
+   */
   pluginId?: string;
+  /**
+   * @remarks
+   * Indicates if the service is healthy. `true` indicates normal operation, and `false` indicates an issue.
+   */
   serviceHealthy?: boolean;
   static names(): { [key: string]: string } {
     return {