@alicloud/polardb20170801 8.1.1 → 8.2.1

package/src/models/DescribeKbsyncLinksResponseBody.ts

@@ -0,0 +1,120 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKBSyncLinksResponseBodyItems extends $dara.Model {
+  /**
+   * @example
+   * cli_xxxxxxbe8
+   */
+  clientId?: string;
+  /**
+   * @example
+   * 2026-08-11T09:55:19Z
+   */
+  creationTime?: string;
+  /**
+   * @example
+   * testDesc
+   */
+  description?: string;
+  /**
+   * @example
+   * FEISHU
+   */
+  imPlatform?: string;
+  /**
+   * @example
+   * pkbl-xxxxx
+   */
+  linkId?: string;
+  /**
+   * @example
+   * testName
+   */
+  linkName?: string;
+  /**
+   * @example
+   * https://example.feishu.cn/wiki/space/xxxxxx
+   */
+  sourceDir?: string;
+  /**
+   * @example
+   * 30
+   */
+  syncIntervalMinutes?: number;
+  /**
+   * @example
+   * RUNNING
+   */
+  syncStatus?: string;
+  static names(): { [key: string]: string } {
+    return {
+      clientId: 'ClientId',
+      creationTime: 'CreationTime',
+      description: 'Description',
+      imPlatform: 'ImPlatform',
+      linkId: 'LinkId',
+      linkName: 'LinkName',
+      sourceDir: 'SourceDir',
+      syncIntervalMinutes: 'SyncIntervalMinutes',
+      syncStatus: 'SyncStatus',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      clientId: 'string',
+      creationTime: 'string',
+      description: 'string',
+      imPlatform: 'string',
+      linkId: 'string',
+      linkName: 'string',
+      sourceDir: 'string',
+      syncIntervalMinutes: 'number',
+      syncStatus: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKBSyncLinksResponseBody extends $dara.Model {
+  items?: DescribeKBSyncLinksResponseBodyItems[];
+  /**
+   * @example
+   * EB07CFF0-D8A4-5C76-AED7-D00E26FC2***
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      items: 'Items',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      items: { 'type': 'array', 'itemType': DescribeKBSyncLinksResponseBodyItems },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.items)) {
+      $dara.Model.validateArray(this.items);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBaseAnswerRequest.ts

@@ -0,0 +1,60 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBaseAnswerRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The unique ID of the Q&A task.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * R3BGbnBqcXN******.2a5a23c9-******-179970533d30
+   */
+  queryId?: string;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      knowledgeBaseId: 'KnowledgeBaseId',
+      queryId: 'QueryId',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      knowledgeBaseId: 'string',
+      queryId: 'string',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBaseAnswerResponse.ts

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

@@ -0,0 +1,262 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model {
+  /**
+   * @remarks
+   * The chunk metadata.
+   * 
+   * @example
+   * {}
+   */
+  chunkMetadata?: { [key: string]: any };
+  /**
+   * @remarks
+   * The file ID.
+   * 
+   * @example
+   * 91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The file name.
+   * 
+   * @example
+   * financial_report.pdf
+   */
+  fileName?: string;
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The document metadata.
+   * 
+   * @example
+   * {}
+   */
+  metadata?: { [key: string]: any };
+  /**
+   * @remarks
+   * The list of page numbers to which the shard belongs.
+   */
+  pageNumbers?: number[];
+  /**
+   * @remarks
+   * The shard content.
+   * 
+   * @example
+   * financial_report
+   */
+  shardContent?: string;
+  /**
+   * @remarks
+   * The shard ID.
+   * 
+   * @example
+   * 8
+   */
+  shardIndex?: number;
+  /**
+   * @remarks
+   * The similarity score.
+   * 
+   * @example
+   * 0.75
+   */
+  similarityScore?: number;
+  /**
+   * @remarks
+   * The source ID.
+   * 
+   * @example
+   * 1
+   */
+  sourceId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      chunkMetadata: 'ChunkMetadata',
+      fileId: 'FileId',
+      fileName: 'FileName',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      metadata: 'Metadata',
+      pageNumbers: 'PageNumbers',
+      shardContent: 'ShardContent',
+      shardIndex: 'ShardIndex',
+      similarityScore: 'SimilarityScore',
+      sourceId: 'SourceId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      chunkMetadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
+      fileId: 'string',
+      fileName: 'string',
+      knowledgeBaseId: 'string',
+      metadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
+      pageNumbers: { 'type': 'array', 'itemType': 'number' },
+      shardContent: 'string',
+      shardIndex: 'number',
+      similarityScore: 'number',
+      sourceId: 'number',
+    };
+  }
+
+  validate() {
+    if(this.chunkMetadata) {
+      $dara.Model.validateMap(this.chunkMetadata);
+    }
+    if(this.metadata) {
+      $dara.Model.validateMap(this.metadata);
+    }
+    if(Array.isArray(this.pageNumbers)) {
+      $dara.Model.validateArray(this.pageNumbers);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeKnowledgeBaseAnswerResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Agent ID
+   * 
+   * @example
+   * ******
+   */
+  agentId?: string;
+  /**
+   * @remarks
+   * The answer content.
+   * 
+   * @example
+   * The financial report is summarized as follows: ******
+   */
+  answer?: string;
+  /**
+   * @remarks
+   * The cumulative number of tokens generated by the completion.
+   * 
+   * @example
+   * 3935
+   */
+  completionTokens?: number;
+  /**
+   * @remarks
+   * The error message.
+   * 
+   * @example
+   * Space not found: pks-xxxx
+   */
+  errorMessage?: string;
+  /**
+   * @remarks
+   * The error type.
+   * 
+   * @example
+   * not_found
+   */
+  errorType?: string;
+  /**
+   * @remarks
+   * The large language model ID.
+   * 
+   * @example
+   * OO1A6p8B******_xPUC
+   */
+  LLMModelId?: string;
+  /**
+   * @remarks
+   * The cumulative number of tokens consumed by the prompt.
+   * 
+   * @example
+   * 2459
+   */
+  promptTokens?: number;
+  /**
+   * @remarks
+   * The unique ID of the Q&A task.
+   * 
+   * @example
+   * R3BGbnBqcXN******.2a5a23c9-******-179970533d30
+   */
+  queryId?: string;
+  /**
+   * @remarks
+   * Id of the request
+   * 
+   * @example
+   * CDB3258F-B5DE-43C4-8935-CBA0CA******
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The list of reference sources for the answer.
+   */
+  sources?: DescribeKnowledgeBaseAnswerResponseBodySources[];
+  /**
+   * @remarks
+   * The status of the Q&A task. Valid values:
+   * - RUNNING: In progress.
+   * - COMPLETED: Completed.
+   * 
+   * @example
+   * COMPLETED
+   */
+  status?: string;
+  static names(): { [key: string]: string } {
+    return {
+      agentId: 'AgentId',
+      answer: 'Answer',
+      completionTokens: 'CompletionTokens',
+      errorMessage: 'ErrorMessage',
+      errorType: 'ErrorType',
+      LLMModelId: 'LLMModelId',
+      promptTokens: 'PromptTokens',
+      queryId: 'QueryId',
+      requestId: 'RequestId',
+      sources: 'Sources',
+      status: 'Status',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      agentId: 'string',
+      answer: 'string',
+      completionTokens: 'number',
+      errorMessage: 'string',
+      errorType: 'string',
+      LLMModelId: 'string',
+      promptTokens: 'number',
+      queryId: 'string',
+      requestId: 'string',
+      sources: { 'type': 'array', 'itemType': DescribeKnowledgeBaseAnswerResponseBodySources },
+      status: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.sources)) {
+      $dara.Model.validateArray(this.sources);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBaseFileShardsRequest.ts

@@ -0,0 +1,80 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeKnowledgeBaseFileShardsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The file ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * xxxx-xxxx-xxxx-xxxx
+   */
+  fileId?: string;
+  /**
+   * @remarks
+   * The unique ID of the knowledge base.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * pkb-xxxxx
+   */
+  knowledgeBaseId?: string;
+  /**
+   * @remarks
+   * The page number.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of records per page.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The region ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-beijing
+   */
+  regionId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      fileId: 'FileId',
+      knowledgeBaseId: 'KnowledgeBaseId',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      regionId: 'RegionId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      fileId: 'string',
+      knowledgeBaseId: 'string',
+      pageNumber: 'number',
+      pageSize: 'number',
+      regionId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeKnowledgeBaseFileShardsResponse.ts

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