@alicloud/polardb20170801 8.2.5 → 8.3.0

package/src/models/RegisterKnowledgeBaseFileResponse.ts

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

@@ -0,0 +1,86 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class RegisterKnowledgeBaseFileResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The file ID, which is generated by the server based on the ETL rules for native OSS files.
+   * 
+   * @example
+   * 3566626f-3cc5-57a3-904c-e777b39baa3d
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * example.pdf
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The OSS object key of the registered file.
+   * 
+   * @example
+   * pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf
+   */
+  filePath?: string;
+  /**
+   * @remarks
+   * Indicates whether an existing idempotent record is matched. Valid values:
+   * - true: An existing idempotent record is matched.
+   * - false: No existing idempotent record is matched.
+   * 
+   * @example
+   * false
+   */
+  idempotent?: boolean;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The file processing status.
+   * 
+   * @example
+   * DISPATCHED
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      fileName: 'FileName',
+      filePath: 'FilePath',
+      idempotent: 'Idempotent',
+      requestId: 'RequestId',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      fileName: 'string',
+      filePath: 'string',
+      idempotent: 'boolean',
+      requestId: 'string',
+      status: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/RetrievalKnowledgeBaseResponseBody.ts

@@ -2,7 +2,87 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class RetrievalKnowledgeBaseResponseBodyResultsImageResources extends $dara.Model {
+  /**
+   * @remarks
+   * The index of the source document that the image belongs to, starting from 0.
+   * 
+   * @example
+   * 0
+   */
+  documentIndex?: number;
+  /**
+   * @remarks
+   * The unique ID of the image resource.
+   * 
+   * @example
+   * document-0/pictures/1
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The element reference of the image in the Docling source document structure.
+   * 
+   * @example
+   * #/pictures/1
+   */
+  itemRef?: string;
+  /**
+   * @remarks
+   * The media type of the image resource.
+   * 
+   * @example
+   * image/png
+   */
+  mimeType?: string;
+  /**
+   * @remarks
+   * The OSS URI of the image resource.
+   * 
+   * @example
+   * oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
+   */
+  uri?: string;
+  static names(): { [key: string]: string } {
+    return {
+      documentIndex: 'DocumentIndex',
+      id: 'Id',
+      itemRef: 'ItemRef',
+      mimeType: 'MimeType',
+      uri: 'Uri',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      documentIndex: 'number',
+      id: 'string',
+      itemRef: 'string',
+      mimeType: 'string',
+      uri: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
+  /**
+   * @remarks
+   * The list of figure or table captions associated with the chunk.
+   */
+  captions?: string[];
+  /**
+   * @remarks
+   * The list of Docling source document structured element references associated with the chunk. You can use these references to precisely locate original elements.
+   */
+  docItems?: string[];
   /**
    * @remarks
    * The unique ID of the file.
@@ -13,7 +93,7 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   fileId?: string;
   /**
    * @remarks
-   * The file name.
+   * The name of the file.
    * 
    * @example
    * 2024FinancialReport.pdf
@@ -21,9 +101,14 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   fileName?: string;
   /**
    * @remarks
-   * The chain of section headings to which the shard belongs.
+   * The chain of section headings that the chunk belongs to.
    */
   headings?: string[];
+  /**
+   * @remarks
+   * The list of image resources referenced by the chunk.
+   */
+  imageResources?: RetrievalKnowledgeBaseResponseBodyResultsImageResources[];
   /**
    * @remarks
    * The metadata.
@@ -34,12 +119,12 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   metadata?: string;
   /**
    * @remarks
-   * The list of page numbers to which the shard belongs.
+   * The list of page numbers that the chunk belongs to.
    */
   pageNumbers?: number[];
   /**
    * @remarks
-   * The text content of the shard.
+   * The text content of the chunk.
    * 
    * @example
    * Financial report
@@ -47,7 +132,7 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   shardContent?: string;
   /**
    * @remarks
-   * The shard index.
+   * The index of the chunk.
    * 
    * @example
    * 1
@@ -63,9 +148,12 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   similarityScore?: number;
   static names(): { [key: string]: string } {
     return {
+      captions: 'Captions',
+      docItems: 'DocItems',
       fileId: 'FileId',
       fileName: 'FileName',
       headings: 'Headings',
+      imageResources: 'ImageResources',
       metadata: 'Metadata',
       pageNumbers: 'PageNumbers',
       shardContent: 'ShardContent',
@@ -76,9 +164,12 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
 
   static types(): { [key: string]: any } {
     return {
+      captions: { 'type': 'array', 'itemType': 'string' },
+      docItems: { 'type': 'array', 'itemType': 'string' },
       fileId: 'string',
       fileName: 'string',
       headings: { 'type': 'array', 'itemType': 'string' },
+      imageResources: { 'type': 'array', 'itemType': RetrievalKnowledgeBaseResponseBodyResultsImageResources },
       metadata: 'string',
       pageNumbers: { 'type': 'array', 'itemType': 'number' },
       shardContent: 'string',
@@ -88,9 +179,18 @@ export class RetrievalKnowledgeBaseResponseBodyResults extends $dara.Model {
   }
 
   validate() {
+    if(Array.isArray(this.captions)) {
+      $dara.Model.validateArray(this.captions);
+    }
+    if(Array.isArray(this.docItems)) {
+      $dara.Model.validateArray(this.docItems);
+    }
     if(Array.isArray(this.headings)) {
       $dara.Model.validateArray(this.headings);
     }
+    if(Array.isArray(this.imageResources)) {
+      $dara.Model.validateArray(this.imageResources);
+    }
     if(Array.isArray(this.pageNumbers)) {
       $dara.Model.validateArray(this.pageNumbers);
     }

package/src/models/model.ts

@@ -411,6 +411,7 @@ export { ModifyGlobalSecurityIPGroupNameResponseBodyGlobalSecurityIPGroup } from
 export { ModifyGlobalSecurityIPGroupRelationResponseBodyGlobalSecurityIPGroupRel } from './ModifyGlobalSecurityIpgroupRelationResponseBody';
 export { ModifyLogBackupPolicyRequestAdvancedLogPolicies } from './ModifyLogBackupPolicyRequest';
 export { MovePolarFsObjectsRequestObjectsToMove } from './MovePolarFsObjectsRequest';
+export { RetrievalKnowledgeBaseResponseBodyResultsImageResources } from './RetrievalKnowledgeBaseResponseBody';
 export { RetrievalKnowledgeBaseResponseBodyResults } from './RetrievalKnowledgeBaseResponseBody';
 export { RetryKnowledgeBaseFilesResponseBodyItems } from './RetryKnowledgeBaseFilesResponseBody';
 export { SearchMemoriesResponseBodyResults } from './SearchMemoriesResponseBody';
@@ -1727,6 +1728,9 @@ export { ReactivateDBClusterBackupResponse } from './ReactivateDbclusterBackupRe
 export { RefreshDBClusterStorageUsageRequest } from './RefreshDbclusterStorageUsageRequest';
 export { RefreshDBClusterStorageUsageResponseBody } from './RefreshDbclusterStorageUsageResponseBody';
 export { RefreshDBClusterStorageUsageResponse } from './RefreshDbclusterStorageUsageResponse';
+export { RegisterKnowledgeBaseFileRequest } from './RegisterKnowledgeBaseFileRequest';
+export { RegisterKnowledgeBaseFileResponseBody } from './RegisterKnowledgeBaseFileResponseBody';
+export { RegisterKnowledgeBaseFileResponse } from './RegisterKnowledgeBaseFileResponse';
 export { RejectPolarClawDevicePairRequest } from './RejectPolarClawDevicePairRequest';
 export { RejectPolarClawDevicePairResponseBody } from './RejectPolarClawDevicePairResponseBody';
 export { RejectPolarClawDevicePairResponse } from './RejectPolarClawDevicePairResponse';