@alicloud/apig20240327 7.0.5 → 7.2.0

package/src/models/AiPolicyRedisConfig.ts

@@ -3,11 +3,35 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiPolicyRedisConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The zero-based index of the Redis database to use. The default value is 0.
+   */
   databaseNumber?: number;
+  /**
+   * @remarks
+   * The hostname of the Redis instance.
+   */
   host?: string;
+  /**
+   * @remarks
+   * The password for Redis authentication.
+   */
   password?: string;
+  /**
+   * @remarks
+   * The port number of the Redis instance.
+   */
   port?: number;
+  /**
+   * @remarks
+   * The connection timeout in milliseconds.
+   */
   timeout?: number;
+  /**
+   * @remarks
+   * The username for Redis authentication.
+   */
   username?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiSecurityGuardConfig.ts

@@ -4,10 +4,30 @@ import { AiPluginStatus } from "./AiPluginStatus";
 
 
 export class AiSecurityGuardConfigConsumerRequestCheckService extends $dara.Model {
+  /**
+   * @remarks
+   * The match type for identifying the consumer. For example: `header` or `query`.
+   */
   matchType?: string;
+  /**
+   * @remarks
+   * The modality type for this rule. For example: `text` or `image`.
+   */
   modalityType?: string;
+  /**
+   * @remarks
+   * The identifier of the consumer.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The identifier of the request check service for text content for this consumer.
+   */
   requestCheckService?: string;
+  /**
+   * @remarks
+   * The identifier of the request check service for image content for this consumer.
+   */
   requestImageCheckService?: string;
   static names(): { [key: string]: string } {
     return {
@@ -39,10 +59,30 @@ export class AiSecurityGuardConfigConsumerRequestCheckService extends $dara.Mode
 }
 
 export class AiSecurityGuardConfigConsumerResponseCheckService extends $dara.Model {
+  /**
+   * @remarks
+   * The match type for identifying the consumer. For example: `header` or `query`.
+   */
   matchType?: string;
+  /**
+   * @remarks
+   * The modality type for this rule. For example: `text` or `image`.
+   */
   modalityType?: string;
+  /**
+   * @remarks
+   * The identifier of the consumer.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The identifier of the response check service for text content for this consumer.
+   */
   responseCheckService?: string;
+  /**
+   * @remarks
+   * The identifier of the response check service for image content for this consumer.
+   */
   responseImageCheckService?: string;
   static names(): { [key: string]: string } {
     return {
@@ -74,9 +114,25 @@ export class AiSecurityGuardConfigConsumerResponseCheckService extends $dara.Mod
 }
 
 export class AiSecurityGuardConfigConsumerRiskLevel extends $dara.Model {
+  /**
+   * @remarks
+   * The risk level to apply to the specified consumer and risk type. For example: `low`, `medium`, or `high`.
+   */
   level?: string;
+  /**
+   * @remarks
+   * The match type for identifying the consumer. For example: `header` or `query`.
+   */
   matchType?: string;
+  /**
+   * @remarks
+   * The identifier of the consumer.
+   */
   name?: string;
+  /**
+   * @remarks
+   * The type of risk to configure. For example: `profanity` or `spam`.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -106,7 +162,15 @@ export class AiSecurityGuardConfigConsumerRiskLevel extends $dara.Model {
 }
 
 export class AiSecurityGuardConfigRiskConfigConsumerRules extends $dara.Model {
+  /**
+   * @remarks
+   * The location in the request to search for the `pattern`. For example: `header` or `query`.
+   */
   matchType?: string;
+  /**
+   * @remarks
+   * The pattern for matching a consumer. This can be a regular expression.
+   */
   pattern?: string;
   static names(): { [key: string]: string } {
     return {
@@ -132,8 +196,20 @@ export class AiSecurityGuardConfigRiskConfigConsumerRules extends $dara.Model {
 }
 
 export class AiSecurityGuardConfigRiskConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Contains rules that override the default settings for specific consumers.
+   */
   consumerRules?: AiSecurityGuardConfigRiskConfigConsumerRules;
+  /**
+   * @remarks
+   * The default risk level for this risk type. For example: `low`, `medium`, or `high`.
+   */
   level?: string;
+  /**
+   * @remarks
+   * The type of risk to configure. For example: `profanity` or `spam`.
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -164,25 +240,88 @@ export class AiSecurityGuardConfigRiskConfig extends $dara.Model {
 }
 
 export class AiSecurityGuardConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The buffer limit in bytes for streaming content checks. The service buffers content up to this limit before sending it for analysis.
+   */
   bufferLimit?: number;
+  /**
+   * @remarks
+   * Specifies whether to check the content of incoming requests.
+   */
   checkRequest?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to check incoming requests for image content. Requires `checkRequest` to be `true`.
+   */
   checkRequestImage?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to check the content of outgoing responses.
+   */
   checkResponse?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to check outgoing responses for image content. Requires `checkResponse` to be `true`.
+   */
   checkResponseImage?: boolean;
+  /**
+   * @remarks
+   * Specifies consumer-specific configurations for the request check service.
+   */
   consumerRequestCheckService?: AiSecurityGuardConfigConsumerRequestCheckService[];
+  /**
+   * @remarks
+   * Specifies consumer-specific configurations for the response check service.
+   */
   consumerResponseCheckService?: AiSecurityGuardConfigConsumerResponseCheckService[];
+  /**
+   * @remarks
+   * Specifies customized risk thresholds for different consumers.
+   */
   consumerRiskLevel?: AiSecurityGuardConfigConsumerRiskLevel[];
   /**
+   * @remarks
+   * Controls whether the AI Security Guard plugin is enabled or disabled.
+   * 
    * **if can be null:**
    * true
    */
   pluginStatus?: AiPluginStatus;
+  /**
+   * @remarks
+   * The identifier of the request check service for text content.
+   */
   requestCheckService?: string;
+  /**
+   * @remarks
+   * The identifier of the request check service for image content.
+   */
   requestImageCheckService?: string;
+  /**
+   * @remarks
+   * The identifier of the response check service for text content.
+   */
   responseCheckService?: string;
+  /**
+   * @remarks
+   * The identifier of the response check service for image content.
+   */
   responseImageCheckService?: string;
+  /**
+   * @remarks
+   * The risk alert level. The service triggers an alert when a detected risk meets or exceeds this level.
+   */
   riskAlertLevel?: string;
+  /**
+   * @remarks
+   * Specifies general risk configurations.
+   */
   riskConfig?: AiSecurityGuardConfigRiskConfig[];
+  /**
+   * @remarks
+   * The service address of the security check endpoint.
+   */
   serviceAddress?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiServiceConfig.ts

@@ -16,7 +16,7 @@ export class AiServiceConfigBedrockServiceConfig extends $dara.Model {
    * AWS-Region
    * 
    * @example
-   * us-west-2
+   * us-east-1
    */
   awsRegion?: string;
   /**
@@ -66,7 +66,7 @@ export class AiServiceConfigPaiEASServiceConfig extends $dara.Model {
    * Service identifier.
    * 
    * @example
-   * svc-d33onfmm1hkn5duhuqjg
+   * svc-cvaeb0um1hkqp79k72v0
    */
   serviceId?: string;
   /**
@@ -74,7 +74,7 @@ export class AiServiceConfigPaiEASServiceConfig extends $dara.Model {
    * Name of the service.
    * 
    * @example
-   * service-hello
+   * auto-ai-service
    */
   serviceName?: string;
   /**
@@ -82,7 +82,7 @@ export class AiServiceConfigPaiEASServiceConfig extends $dara.Model {
    * Workspace identifier.
    * 
    * @example
-   * plw-d5g7qsem1hkmih54g210
+   * cb89d4de30042df4459442589664e00d
    */
   workspaceId?: string;
   static names(): { [key: string]: string } {
@@ -123,7 +123,7 @@ export class AiServiceConfigVertexServiceConfig extends $dara.Model {
    * Vertex AI authentication key.
    * 
    * @example
-   * {\\"type\\":\\"service_account\\",\\"project_id\\":\\"xxx\\",\\"private_key\\":\\"-----BEGIN PRIVATE KEY-----\\",\\"client_email\\":\\"xxx@xxx.iam.gserviceaccount.com\\",\\"token_uri\\":\\"https://oauth2.googleapis.com/token\\"}
+   * {\\"type\\":\\"service_account\\",\\"project_id\\":\\"my-project\\",\\"private_key\\":\\"-----BEGIN PRIVATE KEY-----...\\",\\"client_email\\":\\"xxx@xxx.iam.gserviceaccount.com\\",\\"token_uri\\":\\"https://oauth2.googleapis.com/token\\"}
    */
   vertexAuthKey?: string;
   /**
@@ -131,7 +131,7 @@ export class AiServiceConfigVertexServiceConfig extends $dara.Model {
    * Vertex AI auth service name.
    * 
    * @example
-   * custom-vertex-auth
+   * google-oauth2
    */
   vertexAuthServiceName?: string;
   /**
@@ -139,7 +139,7 @@ export class AiServiceConfigVertexServiceConfig extends $dara.Model {
    * Vertex AI project ID.
    * 
    * @example
-   * my-gcp-project-123
+   * my-project
    */
   vertexProjectId?: string;
   /**
@@ -198,7 +198,7 @@ export class AiServiceConfig extends $dara.Model {
    * API key generation mode.
    * 
    * @example
-   * -
+   * Custom
    */
   apiKeyGenerateMode?: string;
   /**
@@ -229,7 +229,7 @@ export class AiServiceConfig extends $dara.Model {
    * Default model name.
    * 
    * @example
-   * qwen-turbo
+   * gpt-4
    */
   defaultModelName?: string;
   /**
@@ -245,7 +245,7 @@ export class AiServiceConfig extends $dara.Model {
    * Enable outlier detection.
    * 
    * @example
-   * false
+   * true
    */
   enableOutlierDetection?: boolean;
   /**
@@ -264,6 +264,26 @@ export class AiServiceConfig extends $dara.Model {
    * 
    * @example
    * qwen
+   * moonshot
+   * baichuan
+   * yi
+   * zhipuai
+   * 360ai
+   * hunyuan
+   * stepfun
+   * spark
+   * openai
+   * claude
+   * anthropic
+   * doubao
+   * minimax
+   * gemini
+   * azure
+   * deepseek
+   * custom
+   * pai-eas
+   * bedrock
+   * vertex
    */
   provider?: string;
   /**

package/src/models/AiStatisticsConfig.ts

@@ -4,7 +4,15 @@ import { AiStatisticsPathField } from "./AiStatisticsPathField";
 
 
 export class AiStatisticsConfigPathFieldConfigs extends $dara.Model {
+  /**
+   * @remarks
+   * A key-value map for extracting fields. Keys are custom names, and values are paths to the data within the request or response body.
+   */
   fieldPaths?: { [key: string]: AiStatisticsPathField };
+  /**
+   * @remarks
+   * The API endpoint path to which this configuration applies, such as /user/id.
+   */
   path?: string;
   static names(): { [key: string]: string } {
     return {
@@ -33,8 +41,20 @@ export class AiStatisticsConfigPathFieldConfigs extends $dara.Model {
 }
 
 export class AiStatisticsConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to record the body of incoming requests.
+   */
   logRequestContent?: boolean;
+  /**
+   * @remarks
+   * Specifies whether to record the body of outgoing responses.
+   */
   logResponseContent?: boolean;
+  /**
+   * @remarks
+   * An array of configurations for extracting data from specific paths.
+   */
   pathFieldConfigs?: AiStatisticsConfigPathFieldConfigs[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AiStatisticsPathField.ts

@@ -3,15 +3,55 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiStatisticsPathField extends $dara.Model {
+  /**
+   * @remarks
+   * The category to which the field belongs, used for grouping and organizing fields.
+   */
   category?: string;
+  /**
+   * @remarks
+   * A detailed description that provides additional context about the field\\"s purpose and usage.
+   */
   description?: string;
+  /**
+   * @remarks
+   * The unique key used to identify the field in statistical results.
+   */
   fieldKey?: string;
+  /**
+   * @remarks
+   * Specifies whether the field is an input or an output. Valid values are typically `IN` or `OUT`.
+   */
   io?: string;
+  /**
+   * @remarks
+   * The JSONPath expression to extract the field value from the source data.
+   */
   jsonPath?: string;
+  /**
+   * @remarks
+   * The display name of the field, used for labeling in user interfaces or reports.
+   */
   name?: string;
+  /**
+   * @remarks
+   * Specifies whether logging is enabled for this field. If set to `true`, the system records the field\\"s value in logs.
+   */
   recordEnabled?: boolean;
+  /**
+   * @remarks
+   * A rule or condition applied to the extracted field. The rule\\"s format and effect are implementation-specific.
+   */
   rule?: string;
+  /**
+   * @remarks
+   * Indicates whether the field contains sensitive information. If set to `true`, the system may apply masking or other security measures.
+   */
   sensitive?: boolean;
+  /**
+   * @remarks
+   * The data source from which the field is extracted. For example, `Request` or `Response`.
+   */
   source?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AiTokenRateLimitConfig.ts

@@ -6,18 +6,36 @@ import { AiPolicyRedisConfig } from "./AiPolicyRedisConfig";
 
 
 export class AiTokenRateLimitConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Controls whether global rules are enabled. If set to `true`, the rules in `globalRules` are applied. Defaults to `false`.
+   */
   enableGlobalRules?: boolean;
+  /**
+   * @remarks
+   * A list of global rate limit rules. These rules are applied when no specific rule in `rules` is matched.
+   */
   globalRules?: AiTokenRateLimitConfigRule[];
   /**
+   * @remarks
+   * Specifies the status of the plugin, such as `enabled` or `disabled`.
+   * 
    * **if can be null:**
    * true
    */
   pluginStatus?: AiPluginStatus;
   /**
+   * @remarks
+   * Specifies the Redis configuration for distributed rate limiting.
+   * 
    * **if can be null:**
    * true
    */
   redisConfig?: AiPolicyRedisConfig;
+  /**
+   * @remarks
+   * A list of specific rate limit rules.
+   */
   rules?: AiTokenRateLimitConfigRule[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AiTokenRateLimitConfigRule.ts

@@ -3,11 +3,35 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AiTokenRateLimitConfigRule extends $dara.Model {
+  /**
+   * @remarks
+   * The action to take when a request exceeds the token rate limit.
+   */
   limitMode?: string;
+  /**
+   * @remarks
+   * The scope of the rate limit, such as per user or per project.
+   */
   limitType?: string;
+  /**
+   * @remarks
+   * The maximum number of tokens allowed within the defined time period. For example, if the time unit is one minute, this value represents the tokens-per-minute (TPM) limit.
+   */
   limitValue?: number;
+  /**
+   * @remarks
+   * The key that identifies the request source. Its value is extracted from the request context to apply the rule.
+   */
   matchKey?: string;
+  /**
+   * @remarks
+   * The matching logic applied to the value of `matchKey`.
+   */
   matchType?: string;
+  /**
+   * @remarks
+   * The value to match. The rate limit applies only when the value of `matchKey` in the request matches this value, according to the `matchType`.
+   */
   matchValue?: string;
   static names(): { [key: string]: string } {
     return {