@alicloud/aidge20260428 5.9.0 → 5.10.0

package/src/models/QueryDisplayKnowledgeResponseBody.ts

@@ -0,0 +1,326 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryDisplayKnowledgeResponseBodyDataRecords extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the failure cause. This parameter is returned only when the status is FAILED.
+   * 
+   * @example
+   * Image is inaccessible
+   */
+  failureMessage?: string;
+  /**
+   * @remarks
+   * The code of the failure cause. This parameter is returned only when the status is FAILED.
+   * 
+   * @example
+   * Image is inaccessible
+   */
+  failureReason?: string;
+  /**
+   * @remarks
+   * The last modified time.
+   * 
+   * @example
+   * 2026-08-01T15:53:46Z
+   */
+  gmtModified?: string;
+  /**
+   * @remarks
+   * The 24-hour signed URL of the transferred image.
+   * 
+   * @example
+   * https://xxx/2190149752-0-cib.jpg
+   */
+  imageUrl?: string;
+  /**
+   * @remarks
+   * The expiration time of the signed URL.
+   * 
+   * @example
+   * Date
+   */
+  imageUrlExpireTime?: string;
+  /**
+   * @remarks
+   * The record ID.
+   * 
+   * @example
+   * 4410879640480000
+   */
+  recordId?: number;
+  /**
+   * @remarks
+   * SKU ID
+   * 
+   * @example
+   * sku-001
+   */
+  skuId?: string;
+  /**
+   * @remarks
+   * The SKU name.
+   * 
+   * @example
+   * Product side image
+   */
+  skuName?: string;
+  /**
+   * @remarks
+   * The record status.
+   * 
+   * @example
+   * UPDATING - Updating
+   * EMBEDDED - Vectorization completed
+   * FAILED - Processing failed
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      failureMessage: 'FailureMessage',
+      failureReason: 'FailureReason',
+      gmtModified: 'GmtModified',
+      imageUrl: 'ImageUrl',
+      imageUrlExpireTime: 'ImageUrlExpireTime',
+      recordId: 'RecordId',
+      skuId: 'SkuId',
+      skuName: 'SkuName',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      failureMessage: 'string',
+      failureReason: 'string',
+      gmtModified: 'string',
+      imageUrl: 'string',
+      imageUrlExpireTime: 'string',
+      recordId: 'number',
+      skuId: 'string',
+      skuName: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class QueryDisplayKnowledgeResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The business error code.
+   * 
+   * @example
+   * Success
+   */
+  errorCode?: string;
+  /**
+   * @remarks
+   * The business error message.
+   * 
+   * @example
+   * Success
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The knowledge base status.
+   * 
+   * @example
+   * AVAILABLE - Available
+   */
+  knowledgeBaseStatus?: string;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 10
+   */
+  pageNum?: number;
+  /**
+   * @remarks
+   * The number of entries per page.
+   * 
+   * @example
+   * 10
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * @example
+   * rag_xxx
+   */
+  ragId?: string;
+  /**
+   * @remarks
+   * The records on the current page.
+   */
+  records?: QueryDisplayKnowledgeResponseBodyDataRecords[];
+  /**
+   * @remarks
+   * Indicates whether the business processing is successful.
+   * 
+   * @example
+   * True
+   */
+  success?: boolean;
+  /**
+   * @remarks
+   * The asynchronous task ID. This parameter is empty for synchronous API operations.
+   * 
+   * @example
+   * a8323ada-a196-9061-976f-90e38b27323a
+   */
+  taskId?: string;
+  /**
+   * @remarks
+   * The total number of records.
+   * 
+   * @example
+   * 17
+   */
+  total?: number;
+  /**
+   * @remarks
+   * The total number of pages.
+   * 
+   * @example
+   * 20
+   */
+  totalPage?: number;
+  /**
+   * @remarks
+   * The usage information. This parameter is empty for free API operations.
+   */
+  usageMap?: { [key: string]: number };
+  static names(): { [key: string]: string } {
+    return {
+      errorCode: 'ErrorCode',
+      errorMessage: 'ErrorMessage',
+      knowledgeBaseStatus: 'KnowledgeBaseStatus',
+      pageNum: 'PageNum',
+      pageSize: 'PageSize',
+      ragId: 'RagId',
+      records: 'Records',
+      success: 'Success',
+      taskId: 'TaskId',
+      total: 'Total',
+      totalPage: 'TotalPage',
+      usageMap: 'UsageMap',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      errorCode: 'string',
+      errorMessage: 'string',
+      knowledgeBaseStatus: 'string',
+      pageNum: 'number',
+      pageSize: 'number',
+      ragId: 'string',
+      records: { 'type': 'array', 'itemType': QueryDisplayKnowledgeResponseBodyDataRecords },
+      success: 'boolean',
+      taskId: 'string',
+      total: 'number',
+      totalPage: 'number',
+      usageMap: { 'type': 'map', 'keyType': 'string', 'valueType': 'number' },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.records)) {
+      $dara.Model.validateArray(this.records);
+    }
+    if(this.usageMap) {
+      $dara.Model.validateMap(this.usageMap);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class QueryDisplayKnowledgeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The error code.
+   * 
+   * @example
+   * success
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The query result of the display knowledge base content.
+   */
+  data?: QueryDisplayKnowledgeResponseBodyData;
+  /**
+   * @remarks
+   * The returned message or failure description.
+   * 
+   * @example
+   * Success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 70CBEFDF-BB17-1EB3-8A21-569F3124738F
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the call is successful.
+   * 
+   * @example
+   * True
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      data: 'Data',
+      message: 'Message',
+      requestId: 'RequestId',
+      success: 'Success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: QueryDisplayKnowledgeResponseBodyData,
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  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/QueryDisplayKnowledgeShrinkRequest.ts

@@ -0,0 +1,83 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class QueryDisplayKnowledgeShrinkRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The page number. Default value: 1.
+   * 
+   * @example
+   * 10
+   */
+  pageNum?: number;
+  /**
+   * @remarks
+   * The number of entries per page. Default value: 20. Maximum value: 100.
+   * 
+   * @example
+   * 50
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * rag_xxx
+   */
+  ragId?: string;
+  /**
+   * @remarks
+   * The SKU ID for exact match.
+   * 
+   * @example
+   * sku-001
+   */
+  skuId?: string;
+  /**
+   * @remarks
+   * The keyword in the SKU name.
+   * 
+   * @example
+   * Product front image
+   */
+  skuName?: string;
+  /**
+   * @remarks
+   * The list of record statuses. Valid values: UPDATING, EMBEDDED, and FAILED.
+   */
+  statusesShrink?: string;
+  static names(): { [key: string]: string } {
+    return {
+      pageNum: 'PageNum',
+      pageSize: 'PageSize',
+      ragId: 'RagId',
+      skuId: 'SkuId',
+      skuName: 'SkuName',
+      statusesShrink: 'Statuses',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      pageNum: 'number',
+      pageSize: 'number',
+      ragId: 'string',
+      skuId: 'string',
+      skuName: 'string',
+      statusesShrink: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/TextTranslateAsyncRequest.ts

@@ -4,37 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class TextTranslateAsyncRequest extends $dara.Model {
   /**
+   * @remarks
+   * The business ID of the caller. The maximum length is 128 characters. This ID is passed through in the translation results.
+   * 
    * @example
    * order-20260928-001
    */
   bizId?: string;
   /**
+   * @remarks
+   * The business name of the caller. This field represents your identity and facilitates subsequent communication. If you are an internal Alibaba organization, specify this parameter based on the actual scenario, such as BU name-product or BU name-chat. If you are an external partner, specify the full name of your company. The company name must be the same as the one used when registering your Alibaba Cloud account.
+   * 
    * @example
    * BUxxx-chat
    */
   bizName?: string;
   /**
+   * @remarks
+   * The format type of the source text. Valid values: text and html.
+   * 
    * @example
    * text
    */
   formatType?: string;
   /**
+   * @remarks
+   * The ID of the intervention glossary. You must create the glossary in the console and provide its ID in the request parameters. If the intervention glossary ID is empty, the translation results are not modified.
+   * 
    * @example
    * " glossary_1"
    */
   glossary?: string;
   /**
+   * @remarks
+   * The source language code. For more information, see the supported language list below. If this parameter is not specified, the language is automatically detected.
+   * 
    * @example
    * auto
    */
   sourceLanguage?: string;
   /**
    * @remarks
+   * The list of texts to be translated.
+   * 
    * This parameter is required.
    */
   sourceTextList?: string[];
   /**
    * @remarks
+   * The target language code. For more information, see the supported language pair list below.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -42,6 +61,15 @@ export class TextTranslateAsyncRequest extends $dara.Model {
    */
   targetLanguage?: string;
   /**
+   * @remarks
+   * The business scenario identifier. You can specify only one of the following values. After you specify a value, the translation engine uses the terminology library and style policy of the corresponding industry to output industry-specific translations. If this parameter is not specified or an invalid value is specified, the general translation policy is used. Valid values:
+   * - e-commerce-title: Translates cross-border e-commerce product titles.
+   * - e-commerce-description: Translates cross-border e-commerce product descriptions.
+   * - e-commerce-chat: Translates cross-border e-commerce conversations.
+   * - e-commerce-cpv: Translates cross-border e-commerce product CPV attributes.
+   * - novel: Translates novels.
+   * - game: Translates games.
+   * 
    * @example
    * e-commerce-title
    */

package/src/models/TextTranslateAsyncResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class TextTranslateAsyncResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the asynchronous task. It is used for result queries and notification association. Do not use the example prefix as a business validation rule.
+   * 
    * @example
    * TID_550e8400-e29b-41d4-a716-446655440000
    */
@@ -31,22 +34,38 @@ export class TextTranslateAsyncResponseBodyData extends $dara.Model {
 
 export class TextTranslateAsyncResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code of the submission call. Example: success.
+   * 
    * @example
    * success
    */
   code?: string;
+  /**
+   * @remarks
+   * The submission result of the text translation asynchronous node.
+   */
   data?: TextTranslateAsyncResponseBodyData;
   /**
+   * @remarks
+   * The invocation message. Example of a successful call: Success. If the call fails, check the actual error message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The ID of the submission request. It is used for troubleshooting.
+   * 
    * @example
    * E1AD60F1-BAC7-546B-9533-E7AD02B16E3F
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the submission call is successful. A successful call does not mean that the translation is complete.
+   * 
    * @example
    * True
    */

package/src/models/TextTranslateAsyncShrinkRequest.ts

@@ -4,37 +4,56 @@ import * as $dara from '@darabonba/typescript';
 
 export class TextTranslateAsyncShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The business ID of the caller. The maximum length is 128 characters. This ID is passed through in the translation results.
+   * 
    * @example
    * order-20260928-001
    */
   bizId?: string;
   /**
+   * @remarks
+   * The business name of the caller. This field represents your identity and facilitates subsequent communication. If you are an internal Alibaba organization, specify this parameter based on the actual scenario, such as BU name-product or BU name-chat. If you are an external partner, specify the full name of your company. The company name must be the same as the one used when registering your Alibaba Cloud account.
+   * 
    * @example
    * BUxxx-chat
    */
   bizName?: string;
   /**
+   * @remarks
+   * The format type of the source text. Valid values: text and html.
+   * 
    * @example
    * text
    */
   formatType?: string;
   /**
+   * @remarks
+   * The ID of the intervention glossary. You must create the glossary in the console and provide its ID in the request parameters. If the intervention glossary ID is empty, the translation results are not modified.
+   * 
    * @example
    * " glossary_1"
    */
   glossary?: string;
   /**
+   * @remarks
+   * The source language code. For more information, see the supported language list below. If this parameter is not specified, the language is automatically detected.
+   * 
    * @example
    * auto
    */
   sourceLanguage?: string;
   /**
    * @remarks
+   * The list of texts to be translated.
+   * 
    * This parameter is required.
    */
   sourceTextListShrink?: string;
   /**
    * @remarks
+   * The target language code. For more information, see the supported language pair list below.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -42,6 +61,15 @@ export class TextTranslateAsyncShrinkRequest extends $dara.Model {
    */
   targetLanguage?: string;
   /**
+   * @remarks
+   * The business scenario identifier. You can specify only one of the following values. After you specify a value, the translation engine uses the terminology library and style policy of the corresponding industry to output industry-specific translations. If this parameter is not specified or an invalid value is specified, the general translation policy is used. Valid values:
+   * - e-commerce-title: Translates cross-border e-commerce product titles.
+   * - e-commerce-description: Translates cross-border e-commerce product descriptions.
+   * - e-commerce-chat: Translates cross-border e-commerce conversations.
+   * - e-commerce-cpv: Translates cross-border e-commerce product CPV attributes.
+   * - novel: Translates novels.
+   * - game: Translates games.
+   * 
    * @example
    * e-commerce-title
    */

package/src/models/UpdateDisplayKnowledgeRequest.ts

@@ -0,0 +1,108 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class UpdateDisplayKnowledgeRequestRecords extends $dara.Model {
+  /**
+   * @remarks
+   * The HTTP or HTTPS URL of the product image.
+   * 
+   * @example
+   * https://xxxx/96f21ebdaeeba27a.jpg
+   */
+  imageUrl?: string;
+  /**
+   * @remarks
+   * The record ID.
+   * 
+   * @example
+   * 1489638581
+   */
+  recordId?: number;
+  /**
+   * @remarks
+   * The SKU ID. If this parameter is not empty, the original value is overwritten.
+   * 
+   * @example
+   * sku-001
+   */
+  skuId?: string;
+  /**
+   * @remarks
+   * The SKU name.
+   * 
+   * @example
+   * Product front image
+   */
+  skuName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      imageUrl: 'ImageUrl',
+      recordId: 'RecordId',
+      skuId: 'SkuId',
+      skuName: 'SkuName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      imageUrl: 'string',
+      recordId: 'number',
+      skuId: 'string',
+      skuName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class UpdateDisplayKnowledgeRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The knowledge base ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * rag_xxx
+   */
+  ragId?: string;
+  /**
+   * @remarks
+   * The records to update. A maximum of 500 records can be specified.
+   * 
+   * This parameter is required.
+   */
+  records?: UpdateDisplayKnowledgeRequestRecords[];
+  static names(): { [key: string]: string } {
+    return {
+      ragId: 'RagId',
+      records: 'Records',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      ragId: 'string',
+      records: { 'type': 'array', 'itemType': UpdateDisplayKnowledgeRequestRecords },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.records)) {
+      $dara.Model.validateArray(this.records);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+