@alicloud/polardb20170801 8.4.0 → 8.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/client.d.ts +8 -8
  2. package/dist/client.js +23 -8
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AnswerKnowledgeBaseRequest.d.ts +5 -5
  5. package/dist/models/CreateApplicationRequest.d.ts +30 -22
  6. package/dist/models/CreateApplicationRequest.js +2 -0
  7. package/dist/models/CreateApplicationRequest.js.map +1 -1
  8. package/dist/models/CreateApplicationResponseBody.d.ts +1 -1
  9. package/dist/models/CreateApplicationShrinkRequest.d.ts +14 -6
  10. package/dist/models/CreateApplicationShrinkRequest.js +2 -0
  11. package/dist/models/CreateApplicationShrinkRequest.js.map +1 -1
  12. package/dist/models/CreateKbsyncLinkRequest.d.ts +12 -4
  13. package/dist/models/CreateKbsyncLinkRequest.js +2 -0
  14. package/dist/models/CreateKbsyncLinkRequest.js.map +1 -1
  15. package/dist/models/CreateKbsyncLinkResponseBody.d.ts +2 -2
  16. package/dist/models/DescribeKnowledgeBaseAnswerResponseBody.d.ts +64 -7
  17. package/dist/models/DescribeKnowledgeBaseAnswerResponseBody.js +33 -1
  18. package/dist/models/DescribeKnowledgeBaseAnswerResponseBody.js.map +1 -1
  19. package/dist/models/DescribeKnowledgeBaseFileShardsResponseBody.d.ts +68 -1
  20. package/dist/models/DescribeKnowledgeBaseFileShardsResponseBody.js +43 -1
  21. package/dist/models/DescribeKnowledgeBaseFileShardsResponseBody.js.map +1 -1
  22. package/dist/models/ModifyAidbclusterModelRequest.d.ts +20 -2
  23. package/dist/models/ModifyAidbclusterModelRequest.js +4 -0
  24. package/dist/models/ModifyAidbclusterModelRequest.js.map +1 -1
  25. package/dist/models/ModifyAidbclusterModelResponseBody.d.ts +3 -3
  26. package/dist/models/UpdateKbsyncLinkRequest.d.ts +12 -4
  27. package/dist/models/UpdateKbsyncLinkRequest.js +2 -0
  28. package/dist/models/UpdateKbsyncLinkRequest.js.map +1 -1
  29. package/dist/models/UpdateKbsyncLinkResponseBody.d.ts +1 -1
  30. package/dist/models/model.d.ts +2 -0
  31. package/dist/models/model.js +44 -40
  32. package/dist/models/model.js.map +1 -1
  33. package/package.json +1 -1
  34. package/src/client.ts +28 -8
  35. package/src/models/AnswerKnowledgeBaseRequest.ts +5 -5
  36. package/src/models/CreateApplicationRequest.ts +32 -22
  37. package/src/models/CreateApplicationResponseBody.ts +1 -1
  38. package/src/models/CreateApplicationShrinkRequest.ts +16 -6
  39. package/src/models/CreateKbsyncLinkRequest.ts +14 -4
  40. package/src/models/CreateKbsyncLinkResponseBody.ts +2 -2
  41. package/src/models/DescribeKnowledgeBaseAnswerResponseBody.ts +87 -7
  42. package/src/models/DescribeKnowledgeBaseFileShardsResponseBody.ts +101 -1
  43. package/src/models/ModifyAidbclusterModelRequest.ts +24 -2
  44. package/src/models/ModifyAidbclusterModelResponseBody.ts +3 -3
  45. package/src/models/UpdateKbsyncLinkRequest.ts +14 -4
  46. package/src/models/UpdateKbsyncLinkResponseBody.ts +1 -1
  47. package/src/models/model.ts +2 -0
@@ -93,7 +93,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
93
93
  componentClass?: string;
94
94
  /**
95
95
  * @remarks
96
- * The maximum number of replicas for the application subcomponent with the same specification. Default value: the value of ComponentReplica.
96
+ * The maximum number of application subcomponents with the same specification. Default value: the value of ComponentReplica.
97
97
  *
98
98
  * - Only raycluster supports this parameter.
99
99
  *
@@ -130,7 +130,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
130
130
  componentType?: string;
131
131
  /**
132
132
  * @remarks
133
- * The maximum number of replicas for component scaling.
133
+ * The upper limit for component scaling.
134
134
  *
135
135
  * @example
136
136
  * 16
@@ -138,7 +138,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
138
138
  scaleMax?: string;
139
139
  /**
140
140
  * @remarks
141
- * The minimum number of replicas for component scaling.
141
+ * The lower limit for component scaling.
142
142
  *
143
143
  * @example
144
144
  * 1
@@ -146,7 +146,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
146
146
  scaleMin?: string;
147
147
  /**
148
148
  * @remarks
149
- * The list of security groups for the application subcomponent, separated by commas (,).
149
+ * The list of security groups for the application subcomponent. Separate multiple security groups with commas (,).
150
150
  *
151
151
  * @example
152
152
  * sg-********************
@@ -154,7 +154,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
154
154
  securityGroups?: string;
155
155
  /**
156
156
  * @remarks
157
- * The name of the whitelist IP address group for the application subcomponent. Default value: default.
157
+ * The name of the IP whitelist group for the application subcomponent. Default value: default.
158
158
  *
159
159
  * @example
160
160
  * default
@@ -162,7 +162,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
162
162
  securityIPArrayName?: string;
163
163
  /**
164
164
  * @remarks
165
- * The whitelist IP addresses of the application subcomponent, separated by commas (,).
165
+ * The whitelisted IP addresses for the application subcomponent. Separate multiple IP addresses with commas (,).
166
166
  *
167
167
  * @example
168
168
  * 127.0.0.1
@@ -170,7 +170,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
170
170
  securityIPList?: string;
171
171
  /**
172
172
  * @remarks
173
- * The type of the whitelist IP addresses for the application subcomponent. Default value: ipv4.
173
+ * The type of the whitelisted IP addresses for the application subcomponent. Default value: ipv4.
174
174
  *
175
175
  * @example
176
176
  * ipv4
@@ -218,7 +218,7 @@ export class CreateApplicationRequestComponents extends $dara.Model {
218
218
  export class CreateApplicationRequestDnatEntries extends $dara.Model {
219
219
  /**
220
220
  * @remarks
221
- * The frontend port. This parameter is optional. If not specified, the system automatically assigns a port that does not conflict with ports already in use on the gateway. You can query the assignment result by calling the DescribeApplicationAttribute operation.
221
+ * The frontend port. This parameter is optional. If not specified, the control plane automatically assigns a port that does not conflict with ports already in use on the gateway. You can query the assignment result by calling the DescribeApplicationAttribute operation.
222
222
  *
223
223
  * @example
224
224
  * 10001
@@ -226,7 +226,7 @@ export class CreateApplicationRequestDnatEntries extends $dara.Model {
226
226
  frontPort?: number;
227
227
  /**
228
228
  * @remarks
229
- * The port name. Valid values: webui, hermesagent, dashboard, and ssh.
229
+ * The port name. Valid values: webui | hermesagent | dashboard | ssh.
230
230
  *
231
231
  * @example
232
232
  * webui
@@ -308,7 +308,7 @@ export class CreateApplicationRequestKnowledgeApplicationSpec extends $dara.Mode
308
308
  dbPassword?: string;
309
309
  /**
310
310
  * @remarks
311
- * Required for knowledge applications. The LLM model name, such as qwen3-max.
311
+ * The LLM model name. This parameter is required for knowledge applications, such as qwen3-max.
312
312
  */
313
313
  llmModel?: string;
314
314
  static names(): { [key: string]: string } {
@@ -363,7 +363,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
363
363
  dbUser?: string;
364
364
  /**
365
365
  * @remarks
366
- * Required for mem0 applications. The embedder model name, such as text-embedding-v4.
366
+ * The embedder model name. This parameter is required for mem0 applications, such as text-embedding-v4.
367
367
  *
368
368
  * @example
369
369
  * text-embedding-v4
@@ -387,7 +387,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
387
387
  graphLlmModel?: string;
388
388
  /**
389
389
  * @remarks
390
- * Required for mem0 applications. The LLM model name, such as qwen3-max.
390
+ * The LLM model name. This parameter is required for mem0 applications, such as qwen3-max.
391
391
  *
392
392
  * @example
393
393
  * qwen3-max
@@ -395,7 +395,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
395
395
  llmModel?: string;
396
396
  /**
397
397
  * @remarks
398
- * The project name, which corresponds to the database schema that stores project data.
398
+ * The project name, which corresponds to the schema in the database where project data is stored.
399
399
  *
400
400
  * @example
401
401
  * test-project-name
@@ -403,7 +403,7 @@ export class CreateApplicationRequestMemApplicationSpec extends $dara.Model {
403
403
  projectName?: string;
404
404
  /**
405
405
  * @remarks
406
- * Required for mem0 applications. The reranker model name, such as qwen3-rerank.
406
+ * The reranker model name. This parameter is required for mem0 applications, such as qwen3-rerank.
407
407
  *
408
408
  * @example
409
409
  * qwen3-rerank
@@ -507,7 +507,7 @@ export class CreateApplicationRequestStorages extends $dara.Model {
507
507
  containerMountPath?: string;
508
508
  /**
509
509
  * @remarks
510
- * The storage endpoint ID.
510
+ * The ID of the storage endpoint.
511
511
  *
512
512
  * @example
513
513
  * pe-xxxx
@@ -531,7 +531,7 @@ export class CreateApplicationRequestStorages extends $dara.Model {
531
531
  storageCapacity?: string;
532
532
  /**
533
533
  * @remarks
534
- * The storage access endpoint.
534
+ * The storage access address.
535
535
  *
536
536
  * @example
537
537
  * polarfs.example.com
@@ -653,6 +653,14 @@ export class CreateApplicationRequest extends $dara.Model {
653
653
  * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
654
654
  */
655
655
  agenticDBBranchSpec?: CreateApplicationRequestAgenticDBBranchSpec;
656
+ /**
657
+ * @remarks
658
+ * The AgenticDB cluster ID.
659
+ *
660
+ * @example
661
+ * pagc-xxx
662
+ */
663
+ agenticDBClusterId?: string;
656
664
  /**
657
665
  * @remarks
658
666
  * The application type. Valid values:
@@ -697,7 +705,7 @@ export class CreateApplicationRequest extends $dara.Model {
697
705
  authProviderConfig?: string;
698
706
  /**
699
707
  * @remarks
700
- * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
708
+ * Specifies whether to automatically create an elastic IP address (EIP) and associate it with the instance.
701
709
  *
702
710
  * @example
703
711
  * qwen3-max
@@ -705,7 +713,7 @@ export class CreateApplicationRequest extends $dara.Model {
705
713
  autoAllocatePublicEip?: boolean;
706
714
  /**
707
715
  * @remarks
708
- * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
716
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase. Valid values:
709
717
  * * false (default): Automatic creation is disabled.
710
718
  * * true: Automatic creation is enabled.
711
719
  *
@@ -759,7 +767,7 @@ export class CreateApplicationRequest extends $dara.Model {
759
767
  dnatEntries?: CreateApplicationRequestDnatEntries[];
760
768
  /**
761
769
  * @remarks
762
- * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
770
+ * The DNAT-dedicated NAT IP address allocated by the customer, which must be separate from the SNAT IP address. The IP address must belong to the specified gateway and be in an available state. The vSwitch where the gateway resides must be in a primary CIDR block reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: The customer has bound an SNAT entry to the vSwitch where the application resides.
763
771
  *
764
772
  * @example
765
773
  * 10.64.0.10
@@ -816,7 +824,7 @@ export class CreateApplicationRequest extends $dara.Model {
816
824
  * @remarks
817
825
  * The model source. Valid values:
818
826
  *
819
- * * bailian: Alibaba Cloud Model Studio model.
827
+ * * bailian: Bailian model.
820
828
  * * custom: Custom model.
821
829
  * * maas: PolarDB model operator.
822
830
  *
@@ -907,7 +915,7 @@ export class CreateApplicationRequest extends $dara.Model {
907
915
  securityIPArrayName?: string;
908
916
  /**
909
917
  * @remarks
910
- * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
918
+ * The IP whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
911
919
  *
912
920
  * @example
913
921
  * 127.0.0.1,172.17.0.0/24
@@ -976,7 +984,7 @@ export class CreateApplicationRequest extends $dara.Model {
976
984
  vpcId?: string;
977
985
  /**
978
986
  * @remarks
979
- * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in an active state.
987
+ * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in active status.
980
988
  *
981
989
  * @example
982
990
  * ngw-xxx
@@ -994,6 +1002,7 @@ export class CreateApplicationRequest extends $dara.Model {
994
1002
  return {
995
1003
  AIDBClusterId: 'AIDBClusterId',
996
1004
  agenticDBBranchSpec: 'AgenticDBBranchSpec',
1005
+ agenticDBClusterId: 'AgenticDBClusterId',
997
1006
  applicationType: 'ApplicationType',
998
1007
  architecture: 'Architecture',
999
1008
  authProvider: 'AuthProvider',
@@ -1043,6 +1052,7 @@ export class CreateApplicationRequest extends $dara.Model {
1043
1052
  return {
1044
1053
  AIDBClusterId: 'string',
1045
1054
  agenticDBBranchSpec: CreateApplicationRequestAgenticDBBranchSpec,
1055
+ agenticDBClusterId: 'string',
1046
1056
  applicationType: 'string',
1047
1057
  architecture: 'string',
1048
1058
  authProvider: 'string',
@@ -48,7 +48,7 @@ export class CreateApplicationResponseBody extends $dara.Model {
48
48
  components?: CreateApplicationResponseBodyComponents[];
49
49
  /**
50
50
  * @remarks
51
- * The application description.
51
+ * The description of the application.
52
52
  *
53
53
  * @example
54
54
  * myapp
@@ -59,6 +59,14 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
59
59
  * {"DBClusterId":"pagc-2zea920mcvd5o87","TenantId":"t-cfc2d7df0e59439681f0087f51","ProjectId":"proj-d7849d0050664c758af795d468","BranchId":"br-9054b3b7649e4c0d977bd0df37","ForkFromBranch":true,"ForkFromApplicationId":"pa-source"}
60
60
  */
61
61
  agenticDBBranchSpecShrink?: string;
62
+ /**
63
+ * @remarks
64
+ * The AgenticDB cluster ID.
65
+ *
66
+ * @example
67
+ * pagc-xxx
68
+ */
69
+ agenticDBClusterId?: string;
62
70
  /**
63
71
  * @remarks
64
72
  * The application type. Valid values:
@@ -103,7 +111,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
103
111
  authProviderConfig?: string;
104
112
  /**
105
113
  * @remarks
106
- * Specifies whether to enable automatic creation of an elastic IP address (EIP) and attach it to the instance. This is equivalent to associate with an EIP.
114
+ * Specifies whether to automatically create an elastic IP address (EIP) and associate it with the instance.
107
115
  *
108
116
  * @example
109
117
  * qwen3-max
@@ -111,7 +119,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
111
119
  autoAllocatePublicEip?: boolean;
112
120
  /**
113
121
  * @remarks
114
- * Specifies whether to enable automatic creation of a cold storage Polarlakebase instance. Valid values:
122
+ * Specifies whether to enable automatic creation of a cold storage Polarlakebase. Valid values:
115
123
  * * false (default): Automatic creation is disabled.
116
124
  * * true: Automatic creation is enabled.
117
125
  *
@@ -165,7 +173,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
165
173
  dnatEntriesShrink?: string;
166
174
  /**
167
175
  * @remarks
168
- * The DNAT-dedicated NAT IP address that has been allocated (separate from the SNAT IP address) for NAT mapping. The IP address must belong to the specified gateway and be in an available state. The vSwitch of the gateway must belong to a primary CIDR block that is reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: An SNAT entry has been bound to the vSwitch where the application resides.
176
+ * The DNAT-dedicated NAT IP address allocated by the customer, which must be separate from the SNAT IP address. The IP address must belong to the specified gateway and be in an available state. The vSwitch where the gateway resides must be in a primary CIDR block reachable from the office network. Specify this parameter together with VpcNatGatewayId. Prerequisite: The customer has bound an SNAT entry to the vSwitch where the application resides.
169
177
  *
170
178
  * @example
171
179
  * 10.64.0.10
@@ -222,7 +230,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
222
230
  * @remarks
223
231
  * The model source. Valid values:
224
232
  *
225
- * * bailian: Alibaba Cloud Model Studio model.
233
+ * * bailian: Bailian model.
226
234
  * * custom: Custom model.
227
235
  * * maas: PolarDB model operator.
228
236
  *
@@ -313,7 +321,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
313
321
  securityIPArrayName?: string;
314
322
  /**
315
323
  * @remarks
316
- * The IP whitelist. If you do not specify this parameter, the default value is `127.0.0.1`.
324
+ * The IP whitelist. If you do not specify this parameter, the default value `127.0.0.1` is used.
317
325
  *
318
326
  * @example
319
327
  * 127.0.0.1,172.17.0.0/24
@@ -382,7 +390,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
382
390
  vpcId?: string;
383
391
  /**
384
392
  * @remarks
385
- * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in an active state.
393
+ * The VPC NAT gateway ID for NAT mapping. If specified, NAT mapping is enabled when the instance is created. The NAT gateway must be in the same VPC as the application, use the private network type (intranet), and be in active status.
386
394
  *
387
395
  * @example
388
396
  * ngw-xxx
@@ -400,6 +408,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
400
408
  return {
401
409
  AIDBClusterId: 'AIDBClusterId',
402
410
  agenticDBBranchSpecShrink: 'AgenticDBBranchSpec',
411
+ agenticDBClusterId: 'AgenticDBClusterId',
403
412
  applicationType: 'ApplicationType',
404
413
  architecture: 'Architecture',
405
414
  authProvider: 'AuthProvider',
@@ -449,6 +458,7 @@ export class CreateApplicationShrinkRequest extends $dara.Model {
449
458
  return {
450
459
  AIDBClusterId: 'string',
451
460
  agenticDBBranchSpecShrink: 'string',
461
+ agenticDBClusterId: 'string',
452
462
  applicationType: 'string',
453
463
  architecture: 'string',
454
464
  authProvider: 'string',
@@ -33,7 +33,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
33
33
  description?: string;
34
34
  /**
35
35
  * @remarks
36
- * The unique identifier of the knowledge base.
36
+ * The unique ID of the knowledge base.
37
37
  *
38
38
  * This parameter is required.
39
39
  *
@@ -53,7 +53,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
53
53
  linkName?: string;
54
54
  /**
55
55
  * @remarks
56
- * The DingTalk document MCP Server endpoint.
56
+ * The MCP Server address for DingTalk documents.
57
57
  *
58
58
  * @example
59
59
  * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx789?key=d5e6fxxxxxx876
@@ -71,7 +71,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
71
71
  regionId?: string;
72
72
  /**
73
73
  * @remarks
74
- * The DingTalk spreadsheet MCP Server endpoint.
74
+ * The MCP Server address for DingTalk sheets.
75
75
  *
76
76
  * @example
77
77
  * https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx567?key=d5e6fxxxxxx543
@@ -115,7 +115,15 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
115
115
  tenantId?: string;
116
116
  /**
117
117
  * @remarks
118
- * The DingTalk operator user ID.
118
+ * The Lark user access token. This token is used only when the application identity cannot expand group members because the bot is not in the group chat.
119
+ *
120
+ * @example
121
+ * ******
122
+ */
123
+ userAccessToken?: string;
124
+ /**
125
+ * @remarks
126
+ * The DingTalk user ID of the operator.
119
127
  *
120
128
  * @example
121
129
  * 123***56
@@ -135,6 +143,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
135
143
  sourceType: 'SourceType',
136
144
  syncIntervalMinutes: 'SyncIntervalMinutes',
137
145
  tenantId: 'TenantId',
146
+ userAccessToken: 'UserAccessToken',
138
147
  userId: 'UserId',
139
148
  };
140
149
  }
@@ -153,6 +162,7 @@ export class CreateKBSyncLinkRequest extends $dara.Model {
153
162
  sourceType: 'string',
154
163
  syncIntervalMinutes: 'number',
155
164
  tenantId: 'string',
165
+ userAccessToken: 'string',
156
166
  userId: 'string',
157
167
  };
158
168
  }
@@ -13,7 +13,7 @@ export class CreateKBSyncLinkResponseBody extends $dara.Model {
13
13
  clientId?: string;
14
14
  /**
15
15
  * @remarks
16
- * The creation time.
16
+ * The time when the synchronization link was created.
17
17
  *
18
18
  * @example
19
19
  * 2026-08-14T05:58:42Z
@@ -39,7 +39,7 @@ export class CreateKBSyncLinkResponseBody extends $dara.Model {
39
39
  imPlatform?: string;
40
40
  /**
41
41
  * @remarks
42
- * The synchronization link ID.
42
+ * The ID of the synchronization link.
43
43
  *
44
44
  * @example
45
45
  * pkbl-xxxxxx
@@ -2,6 +2,76 @@
2
2
  import * as $dara from '@darabonba/typescript';
3
3
 
4
4
 
5
+ export class DescribeKnowledgeBaseAnswerResponseBodySourcesImageResources extends $dara.Model {
6
+ /**
7
+ * @remarks
8
+ * The index of the source document to which the image belongs, starting from 0.
9
+ *
10
+ * @example
11
+ * 0
12
+ */
13
+ documentIndex?: number;
14
+ /**
15
+ * @remarks
16
+ * The unique ID of the image resource.
17
+ *
18
+ * @example
19
+ * document-0/pictures/1
20
+ */
21
+ id?: string;
22
+ /**
23
+ * @remarks
24
+ * The element reference of the image in the Docling source document structure.
25
+ *
26
+ * @example
27
+ * #/pictures/1
28
+ */
29
+ itemRef?: string;
30
+ /**
31
+ * @remarks
32
+ * The media type of the image resource.
33
+ *
34
+ * @example
35
+ * image/png
36
+ */
37
+ mimeType?: string;
38
+ /**
39
+ * @remarks
40
+ * The OSS URI of the image resource.
41
+ *
42
+ * @example
43
+ * oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
44
+ */
45
+ uri?: string;
46
+ static names(): { [key: string]: string } {
47
+ return {
48
+ documentIndex: 'DocumentIndex',
49
+ id: 'Id',
50
+ itemRef: 'ItemRef',
51
+ mimeType: 'MimeType',
52
+ uri: 'Uri',
53
+ };
54
+ }
55
+
56
+ static types(): { [key: string]: any } {
57
+ return {
58
+ documentIndex: 'number',
59
+ id: 'string',
60
+ itemRef: 'string',
61
+ mimeType: 'string',
62
+ uri: 'string',
63
+ };
64
+ }
65
+
66
+ validate() {
67
+ super.validate();
68
+ }
69
+
70
+ constructor(map?: { [key: string]: any }) {
71
+ super(map);
72
+ }
73
+ }
74
+
5
75
  export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model {
6
76
  /**
7
77
  * @remarks
@@ -24,9 +94,14 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
24
94
  * The file name.
25
95
  *
26
96
  * @example
27
- * financial_report.pdf
97
+ * FinancialReport.pdf
28
98
  */
29
99
  fileName?: string;
100
+ /**
101
+ * @remarks
102
+ * The list of image resources associated with the referenced chunk in the Q&A.
103
+ */
104
+ imageResources?: DescribeKnowledgeBaseAnswerResponseBodySourcesImageResources[];
30
105
  /**
31
106
  * @remarks
32
107
  * The unique ID of the knowledge base.
@@ -45,20 +120,20 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
45
120
  metadata?: { [key: string]: any };
46
121
  /**
47
122
  * @remarks
48
- * The list of page numbers to which the shard belongs.
123
+ * The list of page numbers to which the chunk belongs.
49
124
  */
50
125
  pageNumbers?: number[];
51
126
  /**
52
127
  * @remarks
53
- * The shard content.
128
+ * The chunk content.
54
129
  *
55
130
  * @example
56
- * financial_report
131
+ * FinancialReport
57
132
  */
58
133
  shardContent?: string;
59
134
  /**
60
135
  * @remarks
61
- * The shard ID.
136
+ * The chunk ID.
62
137
  *
63
138
  * @example
64
139
  * 8
@@ -85,6 +160,7 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
85
160
  chunkMetadata: 'ChunkMetadata',
86
161
  fileId: 'FileId',
87
162
  fileName: 'FileName',
163
+ imageResources: 'ImageResources',
88
164
  knowledgeBaseId: 'KnowledgeBaseId',
89
165
  metadata: 'Metadata',
90
166
  pageNumbers: 'PageNumbers',
@@ -100,6 +176,7 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
100
176
  chunkMetadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
101
177
  fileId: 'string',
102
178
  fileName: 'string',
179
+ imageResources: { 'type': 'array', 'itemType': DescribeKnowledgeBaseAnswerResponseBodySourcesImageResources },
103
180
  knowledgeBaseId: 'string',
104
181
  metadata: { 'type': 'map', 'keyType': 'string', 'valueType': 'any' },
105
182
  pageNumbers: { 'type': 'array', 'itemType': 'number' },
@@ -114,6 +191,9 @@ export class DescribeKnowledgeBaseAnswerResponseBodySources extends $dara.Model
114
191
  if(this.chunkMetadata) {
115
192
  $dara.Model.validateMap(this.chunkMetadata);
116
193
  }
194
+ if(Array.isArray(this.imageResources)) {
195
+ $dara.Model.validateArray(this.imageResources);
196
+ }
117
197
  if(this.metadata) {
118
198
  $dara.Model.validateMap(this.metadata);
119
199
  }
@@ -142,12 +222,12 @@ export class DescribeKnowledgeBaseAnswerResponseBody extends $dara.Model {
142
222
  * The answer content.
143
223
  *
144
224
  * @example
145
- * The financial report is summarized as follows: ******
225
+ * The financial report summary is as follows: ******
146
226
  */
147
227
  answer?: string;
148
228
  /**
149
229
  * @remarks
150
- * The cumulative number of tokens generated by the completion.
230
+ * The cumulative number of tokens generated for completion.
151
231
  *
152
232
  * @example
153
233
  * 3935