@alicloud/apig20240327 9.2.0 → 10.0.0

package/src/models/HiMarketHttpRoute.ts

@@ -6,22 +6,34 @@ import { HiMarketDomain } from "./HiMarketDomain";
 export class HiMarketHttpRouteMatchHeaders extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether the header match is case-sensitive. Defaults to `true`.
+   * Indicates whether the matching is case-sensitive.
+   * 
+   * @example
+   * true
    */
   caseSensitive?: boolean;
   /**
    * @remarks
-   * The name of the HTTP header to match, such as `Content-Type`.
+   * The parameter name.
+   * 
+   * @example
+   * X-Agent-Type
    */
   name?: string;
   /**
    * @remarks
-   * The type of header match. Valid values are `Exact` and `RegularExpression`. Defaults to `Exact`.
+   * The matching type.
+   * 
+   * @example
+   * Exact
    */
   type?: string;
   /**
    * @remarks
-   * The value to match against the header. The match `type` determines how this value is interpreted.
+   * The matching value.
+   * 
+   * @example
+   * dashscope
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -54,22 +66,34 @@ export class HiMarketHttpRouteMatchHeaders extends $dara.Model {
 export class HiMarketHttpRouteMatchModelMatches extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether the model field match is case-sensitive. Defaults to `true`.
+   * Indicates whether the matching is case-sensitive.
+   * 
+   * @example
+   * true
    */
   caseSensitive?: boolean;
   /**
    * @remarks
-   * The name of the model field to match.
+   * The parameter name.
+   * 
+   * @example
+   * X-Agent-Type
    */
   name?: string;
   /**
    * @remarks
-   * The type of match, such as `Exact`, `Pattern`, or `Range`.
+   * The matching type.
+   * 
+   * @example
+   * Exact
    */
   type?: string;
   /**
    * @remarks
-   * The value or pattern to match against the model field.
+   * The matching value.
+   * 
+   * @example
+   * dashscope
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -102,17 +126,26 @@ export class HiMarketHttpRouteMatchModelMatches extends $dara.Model {
 export class HiMarketHttpRouteMatchPath extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether the path match is case-sensitive. Defaults to `true`.
+   * Indicates whether the matching is case-sensitive.
+   * 
+   * @example
+   * false
    */
   caseSensitive?: boolean;
   /**
    * @remarks
-   * The type of path match. Valid values are `Exact` and `Prefix`. Defaults to `Exact` if not specified.
+   * The matching type.
+   * 
+   * @example
+   * Prefix
    */
   type?: string;
   /**
    * @remarks
-   * The path value to match. The specified `type` determines how this value is interpreted.
+   * The path value.
+   * 
+   * @example
+   * /v1/agents/invoke
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -143,22 +176,34 @@ export class HiMarketHttpRouteMatchPath extends $dara.Model {
 export class HiMarketHttpRouteMatchQueryParams extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether the query parameter match is case-sensitive. Defaults to `true`.
+   * Indicates whether the matching is case-sensitive.
+   * 
+   * @example
+   * true
    */
   caseSensitive?: boolean;
   /**
    * @remarks
-   * The name of the query parameter to match.
+   * The parameter name.
+   * 
+   * @example
+   * X-Agent-Type
    */
   name?: string;
   /**
    * @remarks
-   * The type of query parameter match. Valid values are `Exact` and `RegularExpression`. Defaults to `Exact`.
+   * The matching type.
+   * 
+   * @example
+   * Exact
    */
   type?: string;
   /**
    * @remarks
-   * The value to match against the query parameter. The match `type` determines how this value is interpreted.
+   * The matching value.
+   * 
+   * @example
+   * dashscope
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -191,27 +236,27 @@ export class HiMarketHttpRouteMatchQueryParams extends $dara.Model {
 export class HiMarketHttpRouteMatch extends $dara.Model {
   /**
    * @remarks
-   * A list of HTTP header match conditions. The request must match all of these conditions.
+   * The list of header matching rules.
    */
   headers?: HiMarketHttpRouteMatchHeaders[];
   /**
    * @remarks
-   * A list of HTTP methods to match, such as `GET` or `POST`. If this field is not specified, the route matches requests with any HTTP method.
+   * The list of HTTP methods.
    */
   methods?: string[];
   /**
    * @remarks
-   * A list of conditions for matching against a data model. Use this to validate the request body or other structured data.
+   * The list of model matching rules (specific to Agent API).
    */
   modelMatches?: HiMarketHttpRouteMatchModelMatches[];
   /**
    * @remarks
-   * Specifies the conditions for matching the request path.
+   * The path matching rule.
    */
   path?: HiMarketHttpRouteMatchPath;
   /**
    * @remarks
-   * A list of URL query parameter match conditions. The request must match all of these conditions.
+   * The list of query parameter matching rules.
    */
   queryParams?: HiMarketHttpRouteMatchQueryParams[];
   static names(): { [key: string]: string } {
@@ -261,22 +306,28 @@ export class HiMarketHttpRouteMatch extends $dara.Model {
 export class HiMarketHttpRoute extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether this is a system-defined route. Users cannot modify or delete built-in routes. Defaults to `false`.
+   * Indicates whether the route is a built-in route.
+   * 
+   * @example
+   * false
    */
   builtin?: boolean;
   /**
    * @remarks
-   * An optional description for the HTTP route. This field is for informational purposes only.
+   * The route description.
+   * 
+   * @example
+   * Agent route
    */
   description?: string;
   /**
    * @remarks
-   * A list of hostnames to which this route applies. The request\\"s `Host` header must match one of the hostnames in this list.
+   * The list of associated domain names.
    */
   domains?: HiMarketDomain[];
   /**
    * @remarks
-   * Defines the matching criteria for an incoming HTTP request. The request must meet all specified conditions for this route to apply.
+   * The route matching rule.
    */
   match?: HiMarketHttpRouteMatch;
   static names(): { [key: string]: string } {

package/src/models/HiMarketIcon.ts

@@ -5,12 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketIcon extends $dara.Model {
   /**
    * @remarks
-   * Specifies the icon type. Example: `URL`.
+   * The icon type.
+   * 
+   * @example
+   * url
    */
   type?: string;
   /**
    * @remarks
-   * The value of the icon, based on the specified `type`. For example, if `type` is `URL`, this is the URL of the icon.
+   * The icon value.
+   * 
+   * @example
+   * https://example.com/icon.png
    */
   value?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketIdentityMapping.ts

@@ -5,17 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketIdentityMapping extends $dara.Model {
   /**
    * @remarks
-   * The identity provider attribute that maps to the user\\"s email address.
+   * The identity field name that corresponds to the mailbox.
+   * 
+   * @example
+   * email
    */
   emailField?: string;
   /**
    * @remarks
-   * The identity provider attribute that maps to the user\\"s unique ID.
+   * The identity field name that corresponds to the user ID.
+   * 
+   * @example
+   * sub
    */
   userIdField?: string;
   /**
    * @remarks
-   * The identity provider attribute that maps to the username.
+   * The identity field name that corresponds to the username.
+   * 
+   * @example
+   * name
    */
   userNameField?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketMcpConfig.ts

@@ -6,12 +6,15 @@ import { HiMarketDomain } from "./HiMarketDomain";
 export class HiMarketMcpConfigMcpServerConfig extends $dara.Model {
   /**
    * @remarks
-   * The domains managed by the server.
+   * The list of associated domain names.
    */
   domains?: HiMarketDomain[];
   /**
    * @remarks
-   * The base path for the service endpoint.
+   * The path exposed by the MCP server.
+   * 
+   * @example
+   * /mcp
    */
   path?: string;
   static names(): { [key: string]: string } {
@@ -43,7 +46,10 @@ export class HiMarketMcpConfigMcpServerConfig extends $dara.Model {
 export class HiMarketMcpConfigMeta extends $dara.Model {
   /**
    * @remarks
-   * The communication protocol. Can be `http` or `https`.
+   * The MCP protocol type.
+   * 
+   * @example
+   * StreamableHTTP
    */
   protocol?: string;
   static names(): { [key: string]: string } {
@@ -70,22 +76,28 @@ export class HiMarketMcpConfigMeta extends $dara.Model {
 export class HiMarketMcpConfig extends $dara.Model {
   /**
    * @remarks
-   * Configuration for the MCP server.
+   * The MCP Server configuration.
    */
   mcpServerConfig?: HiMarketMcpConfigMcpServerConfig;
   /**
    * @remarks
-   * A unique name for the MCP server.
+   * The MCP Server name.
+   * 
+   * @example
+   * my-mcp-server
    */
   mcpServerName?: string;
   /**
    * @remarks
-   * Metadata for the configuration.
+   * The metadata.
    */
   meta?: HiMarketMcpConfigMeta;
   /**
    * @remarks
-   * The tools associated with this configuration, typically provided as a JSON-formatted string.
+   * The MCP tool definitions.
+   * 
+   * @example
+   * [{\\"name\\":\\"search\\",\\"description\\":\\"搜索工具\\"}]
    */
   tools?: string;
   static names(): { [key: string]: string } {

package/src/models/HiMarketModelConfig.ts

@@ -6,17 +6,20 @@ import { HiMarketHttpRoute } from "./HiMarketHttpRoute";
 export class HiMarketModelConfigModelAPIConfig extends $dara.Model {
   /**
    * @remarks
-   * The AI protocols supported by the model.
+   * The list of AI protocols.
    */
   aiProtocols?: string[];
   /**
    * @remarks
-   * The model category.
+   * The model categorization.
+   * 
+   * @example
+   * Text
    */
   modelCategory?: string;
   /**
    * @remarks
-   * Route configurations for the model API.
+   * The list of routing configurations.
    */
   routes?: HiMarketHttpRoute[];
   static names(): { [key: string]: string } {
@@ -53,7 +56,7 @@ export class HiMarketModelConfigModelAPIConfig extends $dara.Model {
 export class HiMarketModelConfig extends $dara.Model {
   /**
    * @remarks
-   * Configuration for the model API.
+   * The Model API configuration wrapper.
    */
   modelAPIConfig?: HiMarketModelConfigModelAPIConfig;
   static names(): { [key: string]: string } {

package/src/models/HiMarketModelFeature.ts

@@ -5,37 +5,58 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketModelFeature extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether to enable multi-modal capabilities. If set to `true`, the model can process requests that include multiple data types, such as text and images.
+   * Indicates whether multimodal input is supported.
+   * 
+   * @example
+   * false
    */
   enableMultiModal?: boolean;
   /**
    * @remarks
-   * Indicates whether to include the model\\"s reasoning process in the response. If set to `true`, the output may contain intermediate steps that show how the model arrived at a conclusion.
+   * Indicates whether chain-of-thought (Thinking) is supported.
+   * 
+   * @example
+   * false
    */
   enableThinking?: boolean;
   /**
    * @remarks
-   * The maximum number of tokens to generate in the response. A token is a unit of text processed by the model.
+   * The maximum number of tokens supported by the model.
+   * 
+   * @example
+   * 8192
    */
   maxTokens?: number;
   /**
    * @remarks
-   * The identifier of the model to use for inference.
+   * The model name.
+   * 
+   * @example
+   * qwen-max
    */
   model?: string;
   /**
    * @remarks
-   * Indicates whether to deliver the response as a continuous stream. If set to `true`, results are sent incrementally.
+   * Indicates whether streaming output is supported.
+   * 
+   * @example
+   * true
    */
   streaming?: boolean;
   /**
    * @remarks
-   * Controls the randomness of the output. Valid values range from 0 to 1. Higher values, such as 0.8, make the output more random. Lower values, such as 0.2, make the output more deterministic.
+   * The temperature parameter that controls the randomness of generation.
+   * 
+   * @example
+   * 0.7
    */
   temperature?: number;
   /**
    * @remarks
-   * Indicates whether the model can search the web to provide more up-to-date responses.
+   * Indicates whether web search is supported.
+   * 
+   * @example
+   * false
    */
   webSearch?: boolean;
   static names(): { [key: string]: string } {

package/src/models/HiMarketOidcConfig.ts

@@ -5,47 +5,74 @@ import * as $dara from '@darabonba/typescript';
 export class HiMarketOidcConfigAuthCodeConfig extends $dara.Model {
   /**
    * @remarks
-   * The URL of the identity provider\\"s authorization endpoint.
+   * The authorization endpoint URL.
+   * 
+   * @example
+   * https://idaas.example.com/oauth2/authorize
    */
   authorizationEndpoint?: string;
   /**
    * @remarks
-   * The client ID obtained from the identity provider after registering your application.
+   * The OAuth2 client ID.
+   * 
+   * @example
+   * my-client-id
    */
   clientId?: string;
   /**
    * @remarks
-   * The client secret obtained from the identity provider after registering your application.
+   * The OAuth2 client secret.
+   * 
+   * @example
+   * my-client-secret
    */
   clientSecret?: string;
   /**
    * @remarks
-   * The identity provider\\"s unique issuer URL, used to validate ID tokens.
+   * The OIDC issuer URL.
+   * 
+   * @example
+   * https://idaas.example.com
    */
   issuer?: string;
   /**
    * @remarks
-   * The provider\\"s JWK Set URI. This URI provides the public keys needed to verify ID token signatures.
+   * The JWKS public key set URI.
+   * 
+   * @example
+   * https://idaas.example.com/.well-known/jwks.json
    */
   jwkSetUri?: string;
   /**
    * @remarks
-   * The application\\"s redirect URI. The provider sends the authorization code to this URI after successful authentication. You must register this URI with the identity provider.
+   * The OAuth2 redirect URI.
+   * 
+   * @example
+   * https://gateway.example.com/callback
    */
   redirectUri?: string;
   /**
    * @remarks
-   * A space-separated list of scopes to request from the provider. The `openid` scope is required for OIDC authentication. For example: `openid profile email`.
+   * The OAuth2 authorization scopes.
+   * 
+   * @example
+   * openid profile email
    */
   scopes?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s token endpoint.
+   * The token endpoint URL.
+   * 
+   * @example
+   * https://idaas.example.com/oauth2/token
    */
   tokenEndpoint?: string;
   /**
    * @remarks
-   * The URL of the identity provider\\"s user info endpoint.
+   * The UserInfo endpoint URL.
+   * 
+   * @example
+   * https://idaas.example.com/userinfo
    */
   userInfoEndpoint?: string;
   static names(): { [key: string]: string } {
@@ -88,22 +115,31 @@ export class HiMarketOidcConfigAuthCodeConfig extends $dara.Model {
 export class HiMarketOidcConfigIdentityMapping extends $dara.Model {
   /**
    * @remarks
-   * Maps additional claims from the ID token to custom user attributes. For each mapping, the key is the target attribute in your system, and the value is the name of the claim from the ID token.
+   * The custom field mappings.
    */
   customFields?: { [key: string]: string };
   /**
    * @remarks
-   * The ID token claim that maps to the user\\"s email address. The `email` claim is a common choice.
+   * The identity field name that corresponds to the email address.
+   * 
+   * @example
+   * email
    */
   emailField?: string;
   /**
    * @remarks
-   * The ID token claim that maps to the user\\"s unique ID. The `sub` claim is a common choice.
+   * The identity field name that corresponds to the user ID.
+   * 
+   * @example
+   * sub
    */
   userIdField?: string;
   /**
    * @remarks
-   * The ID token claim that maps to the user\\"s display name. Common choices include `name` and `preferred_username`.
+   * The identity field name that corresponds to the username.
+   * 
+   * @example
+   * name
    */
   userNameField?: string;
   static names(): { [key: string]: string } {
@@ -139,37 +175,52 @@ export class HiMarketOidcConfigIdentityMapping extends $dara.Model {
 export class HiMarketOidcConfig extends $dara.Model {
   /**
    * @remarks
-   * Configuration settings for the authorization code grant type.
+   * The OAuth2 Authorization Code configuration.
    */
   authCodeConfig?: HiMarketOidcConfigAuthCodeConfig;
   /**
    * @remarks
-   * Enables or disables this identity provider. If set to `false`, users cannot sign in with this provider.
+   * Indicates whether the OIDC configuration is enabled.
+   * 
+   * @example
+   * true
    */
   enabled?: boolean;
   /**
    * @remarks
-   * The OAuth 2.0 grant type. For OIDC, this must be `authorization_code`.
+   * The authorization type.
+   * 
+   * @example
+   * authorization_code
    */
   grantType?: string;
   /**
    * @remarks
-   * Specifies how to map claims from an ID token to user attributes in your system.
+   * The identity field mapping configuration.
    */
   identityMapping?: HiMarketOidcConfigIdentityMapping;
   /**
    * @remarks
-   * The URL for the provider\\"s logo. This logo appears on the sign-in page.
+   * The provider logo URL.
+   * 
+   * @example
+   * https://example.com/logo.png
    */
   logoUrl?: string;
   /**
    * @remarks
-   * The provider\\"s display name. This name appears on the sign-in page.
+   * The OIDC configuration name.
+   * 
+   * @example
+   * my-oidc-config
    */
   name?: string;
   /**
    * @remarks
-   * The unique identifier for the identity provider.
+   * The OIDC provider name.
+   * 
+   * @example
+   * 阿里云IDaaS
    */
   provider?: string;
   static names(): { [key: string]: string } {