tencentcloud-sdk-nodejs 4.0.1027 → 4.0.1028

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 (46) hide show
  1. package/README.md +21 -23
  2. package/package.json +1 -1
  3. package/src/common/sdk_version.ts +1 -1
  4. package/src/services/cdn/v20180606/cdn_models.ts +5 -5
  5. package/src/services/cls/v20201016/cls_models.ts +1 -1
  6. package/src/services/cvm/v20170312/cvm_models.ts +4 -0
  7. package/src/services/ess/v20201111/ess_models.ts +0 -6
  8. package/src/services/lcic/v20220817/lcic_models.ts +0 -4
  9. package/src/services/lkeap/v20240522/lkeap_client.ts +8 -8
  10. package/src/services/lkeap/v20240522/lkeap_models.ts +199 -8
  11. package/src/services/mongodb/v20190725/mongodb_client.ts +14 -1
  12. package/src/services/mongodb/v20190725/mongodb_models.ts +52 -4
  13. package/src/services/rum/v20210622/rum_models.ts +5 -1
  14. package/src/services/ssl/v20191205/ssl_models.ts +17 -11
  15. package/src/services/teo/v20220901/teo_models.ts +1 -2
  16. package/src/services/tke/v20180525/tke_models.ts +8 -0
  17. package/src/services/vms/v20200902/vms_models.ts +4 -4
  18. package/src/services/vpc/v20170312/vpc_client.ts +1 -1
  19. package/src/services/vpc/v20170312/vpc_models.ts +1 -1
  20. package/src/services/waf/v20180125/waf_models.ts +8 -0
  21. package/src/services/wedata/v20210820/wedata_client.ts +12 -0
  22. package/src/services/wedata/v20210820/wedata_models.ts +52 -0
  23. package/tencentcloud/common/sdk_version.d.ts +1 -1
  24. package/tencentcloud/common/sdk_version.js +1 -1
  25. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +5 -5
  26. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  27. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +4 -0
  28. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +0 -6
  29. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +0 -4
  30. package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts +8 -8
  31. package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts +199 -8
  32. package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +5 -1
  33. package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +6 -0
  34. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +49 -4
  35. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +5 -1
  36. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +17 -11
  37. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -2
  38. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +8 -0
  39. package/tencentcloud/services/vms/v20200902/vms_models.d.ts +4 -4
  40. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +1 -1
  41. package/tencentcloud/services/vpc/v20170312/vpc_client.js +1 -1
  42. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +1 -1
  43. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +8 -0
  44. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +5 -1
  45. package/tencentcloud/services/wedata/v20210820/wedata_client.js +6 -0
  46. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +50 -0
package/README.md CHANGED
@@ -1,21 +1,20 @@
1
1
  # 简介
2
2
 
3
- 欢迎使用腾讯云开发者工具套件(SDK),NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。
4
- 为方便 NODEJS 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 NODEJS 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
3
+ 欢迎使用腾讯云开发者工具套件(SDK),Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
4
+ 为方便 Node.js 开发者调试和接入腾讯云产品 API,这里向您介绍适用于 Node.js 的腾讯云开发工具包,并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
5
5
 
6
6
  # 依赖环境
7
7
 
8
- 1. NODEJS 10.0.0 版本及以上
9
- 2. 从腾讯云控制台 开通相应产品
10
- 3. 获取 SecretID、SecretKey 以及调用地址(endpoint),endpoint 一般形式为\*.tencentcloudapi.com,如 CVM 的调用地址为 cvm.tencentcloudapi.com,具体参考各产品说明。
8
+ 1. Node.js 10.0.0 版本及以上。
9
+ 2. 注意:部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
11
10
 
12
11
  # 获取安装
13
12
 
14
- 安装 NODEJS SDK 前,先获取安全凭证。在第一次使用云 API 之前,用户首先需要在腾讯云控制台上申请安全凭证,安全凭证包括 SecretID SecretKey, SecretID 是用于标识 API 调用者的身份,SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管,避免泄露。
13
+ 使用 SDK 需要 API 密钥,可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请,API 密钥包括 SecretID SecretKey,密钥须严格保管,避免泄露。
15
14
 
16
- ## 通过 NPM 安装
15
+ ## 通过 npm 安装
17
16
 
18
- 通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法,NPM NODEJS 的包管理工具。关于 NPM 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
17
+ 通过 npm 获取安装是使用 Node.js SDK 的推荐方法,关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
19
18
 
20
19
  ### 安装指定产品 SDK(推荐)
21
20
 
@@ -56,10 +55,12 @@ npm install tencentcloud-sdk-nodejs --save
56
55
  1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
57
56
  2. 解压源码包到您项目合适的位置,例如 `sdk/tencentcloud-sdk-nodejs`。
58
57
  3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
59
- 4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入SDK,具体可参考示例。
58
+ 4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK,具体可参考示例。
60
59
 
61
60
  # 示例
62
61
 
62
+ 以云服务器产品查询可用区列表接口为例。
63
+
63
64
  ```js
64
65
  const tencentcloud = require("tencentcloud-sdk-nodejs")
65
66
 
@@ -102,7 +103,7 @@ client.DescribeZones().then(
102
103
  )
103
104
  ```
104
105
 
105
- 在支持 typescript 项目中,采用如下方式调用
106
+ 在支持 TypeScript 项目中,采用如下方式调用
106
107
 
107
108
  ```js
108
109
  import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -112,10 +113,11 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
112
113
  // ...
113
114
  ```
114
115
 
115
- 实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
116
+ 实例化 `Client` 的入参支持 `clientConfig`,数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
116
117
 
117
118
  ## Common Client
118
- 从 4.0.714 版本开始腾讯云 NODEJS SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
119
+
120
+ 从 4.0.714 版本开始,腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包,即可向任何产品发起调用。
119
121
 
120
122
  **注意,您必须明确知道您调用的接口所需参数,否则可能会调用失败。**
121
123
 
@@ -123,19 +125,19 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
123
125
 
124
126
  ## 更多示例
125
127
 
126
- 更丰富的使用 demo 请在 examples 目录中寻找。
128
+ 请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
127
129
 
128
130
  # 相关配置
129
131
 
130
132
  ## 代理
131
133
 
132
- 如果是有代理的环境下,需要配置代理,请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
134
+ 如果是有代理的环境下,需要配置代理,请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数,或设置系统环境变量 `http_proxy` ,否则可能无法正常调用,抛出连接超时的异常。
133
135
 
134
136
  # 凭证管理
135
137
 
136
138
  除显式传入凭证外,从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
137
139
 
138
- 在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
140
+ 在您为实例绑定角色后,您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
139
141
  ```javascript
140
142
  // ...
141
143
  const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -147,20 +149,16 @@ new XxxClient({
147
149
  })
148
150
  ```
149
151
 
150
- # 旧版 SDK
151
-
152
- 我们推荐使用新版 NODEJS SDK,如果一定要用旧版 SDK,请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
153
-
154
152
  # 常见问题
155
- - webpack打包出错/浏览器报错
153
+ - webpack 打包出错/浏览器报错
156
154
 
157
- 请**务必不要**将此SDK直接用于web前端(包括小程序等),暴露密钥在这些环境非常不安全。
155
+ 请**务必不要**将此 SDK 直接用于 Web 前端(包括小程序等),暴露密钥在这些环境非常不安全。
158
156
 
159
- 正确的做法是在自己的服务端引用此SDK,并保存好密钥,做好请求鉴权;前端再调用服务端执行业务流程。
157
+ 正确的做法是在自己的服务端引用此 SDK,并保存好密钥,做好请求鉴权,前端再调用服务端执行业务流程。
160
158
 
161
159
  - `The "original" argument must be of type Function.`
162
160
 
163
- 通常是因为nodejs版本低于 `v10` ,或处于非node环境,请再次确认执行环境。
161
+ 通常是因为 Node.js 版本低于 `v10` ,或处于非 Node.js 环境,请再次确认执行环境。
164
162
 
165
163
  - 请求不通
166
164
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs",
3
- "version": "4.0.1027",
3
+ "version": "4.0.1028",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
@@ -1 +1 @@
1
- export const sdkVersion = "4.0.1027"
1
+ export const sdkVersion = "4.0.1028"
@@ -2197,7 +2197,7 @@ off:关闭
2197
2197
  */
2198
2198
  AccessKey?: string
2199
2199
  /**
2200
- * 密钥。
2200
+ * 密钥,字段为脱敏返回。
2201
2201
  注意:此字段可能返回 null,表示取不到有效值。
2202
2202
  */
2203
2203
  SecretKey?: string
@@ -3777,7 +3777,7 @@ off:关闭
3777
3777
  */
3778
3778
  AccessKey?: string
3779
3779
  /**
3780
- * 密钥
3780
+ * 密钥,字段为脱敏返回。
3781
3781
  */
3782
3782
  SecretKey?: string
3783
3783
  }
@@ -5219,7 +5219,7 @@ off:关闭
5219
5219
  */
5220
5220
  AccessKey?: string
5221
5221
  /**
5222
- * 密钥。
5222
+ * 密钥,字段位脱敏返回。
5223
5223
  注意:此字段可能返回 null,表示取不到有效值。
5224
5224
  */
5225
5225
  SecretKey?: string
@@ -7520,7 +7520,7 @@ off:关闭
7520
7520
  */
7521
7521
  AccessKey?: string
7522
7522
  /**
7523
- * 密钥。
7523
+ * 密钥,字段为脱敏返回。
7524
7524
  注意:此字段可能返回 null,表示取不到有效值。
7525
7525
  */
7526
7526
  SecretKey?: string
@@ -10281,7 +10281,7 @@ off:关闭
10281
10281
  */
10282
10282
  AccessKey?: string
10283
10283
  /**
10284
- * 密钥
10284
+ * 密钥,字段为脱敏返回。
10285
10285
  注意:此字段可能返回 null,表示取不到有效值。
10286
10286
  */
10287
10287
  SecretKey?: string
@@ -6374,7 +6374,7 @@ export interface NoticeReceiver {
6374
6374
  /**
6375
6375
  * 接收者。
6376
6376
  当ReceiverType为Uin时,ReceiverIds的值为用户uid。[子用户信息查询](https://cloud.tencent.com/document/api/598/53486)
6377
- 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/14985)
6377
+ 当ReceiverType为Group时,ReceiverIds的值为用户组id。[CAM用户组](https://cloud.tencent.com/document/product/598/34589)
6378
6378
  */
6379
6379
  ReceiverIds: Array<number | bigint>
6380
6380
  /**
@@ -5064,6 +5064,10 @@ export interface ResetInstanceRequest {
5064
5064
  * ImportImage返回参数结构体
5065
5065
  */
5066
5066
  export interface ImportImageResponse {
5067
+ /**
5068
+ * 镜像 ID
5069
+ */
5070
+ ImageId?: string
5067
5071
  /**
5068
5072
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5069
5073
  */
@@ -10108,33 +10108,27 @@ export interface CreateOrganizationInfoChangeUrlRequest {
10108
10108
  export interface DescribeOrganizationGroupOrganizationsResponse {
10109
10109
  /**
10110
10110
  * 符合查询条件的资源实例总数量。
10111
- 注意:此字段可能返回 null,表示取不到有效值。
10112
10111
  */
10113
10112
  Total?: number
10114
10113
  /**
10115
10114
  * 已授权待激活的子企业总数量
10116
- 注意:此字段可能返回 null,表示取不到有效值。
10117
10115
  */
10118
10116
  JoinedTotal?: number
10119
10117
  /**
10120
10118
  * 已加入的企业数量(废弃,请使用ActivatedTotal)
10121
- 注意:此字段可能返回 null,表示取不到有效值。
10122
10119
  * @deprecated
10123
10120
  */
10124
10121
  ActivedTotal?: number
10125
10122
  /**
10126
10123
  * 如果入参Export为 true 时使用,表示导出Excel的url
10127
- 注意:此字段可能返回 null,表示取不到有效值。
10128
10124
  */
10129
10125
  ExportUrl?: string
10130
10126
  /**
10131
10127
  * 成员企业信息列表
10132
- 注意:此字段可能返回 null,表示取不到有效值。
10133
10128
  */
10134
10129
  List?: Array<GroupOrganization>
10135
10130
  /**
10136
10131
  * 已加入的子企业总数量
10137
- 注意:此字段可能返回 null,表示取不到有效值。
10138
10132
  */
10139
10133
  ActivatedTotal?: number
10140
10134
  /**
@@ -669,7 +669,6 @@ export interface LoginOriginIdRequest {
669
669
  export interface BatchRegisterResponse {
670
670
  /**
671
671
  * 注册成功的用户列表
672
- 注意:此字段可能返回 null,表示取不到有效值。
673
672
  */
674
673
  Users?: Array<BatchUserInfo>
675
674
  /**
@@ -1981,7 +1980,6 @@ export interface DescribeGroupMemberListRequest {
1981
1980
  export interface DescribeRoomForbiddenUserResponse {
1982
1981
  /**
1983
1982
  * 禁言用户信息数组,内容包括被禁言的成员 ID,及其被禁言到的时间(使用 UTC 时间,即世界协调时间)
1984
- 注意:此字段可能返回 null,表示取不到有效值。
1985
1983
  */
1986
1984
  MutedAccountList?: Array<MutedAccountList>
1987
1985
  /**
@@ -2062,7 +2060,6 @@ export interface DescribeScoreListResponse {
2062
2060
  Total?: number
2063
2061
  /**
2064
2062
  * 课堂评分列表
2065
- 注意:此字段可能返回 null,表示取不到有效值。
2066
2063
  */
2067
2064
  Scores?: Array<ClassScoreItem>
2068
2065
  /**
@@ -2536,7 +2533,6 @@ export interface DescribeSdkAppIdUsersResponse {
2536
2533
  Total?: number
2537
2534
  /**
2538
2535
  * 当前获取用户信息数组列表
2539
- 注意:此字段可能返回 null,表示取不到有效值。
2540
2536
  */
2541
2537
  Users?: Array<UserInfo>
2542
2538
  /**
@@ -147,7 +147,7 @@ export class Client extends AbstractClient {
147
147
  * 用于查询特定文档的详细信息。 使用场景:当需要查看某个文档的具体内容和属性时使用。
148
148
  */
149
149
  async DescribeDoc(
150
- req?: DescribeDocRequest,
150
+ req: DescribeDocRequest,
151
151
  cb?: (error: string, rep: DescribeDocResponse) => void
152
152
  ): Promise<DescribeDocResponse> {
153
153
  return this.request("DescribeDoc", req, cb)
@@ -167,7 +167,7 @@ export class Client extends AbstractClient {
167
167
  * 用于删除已有的文档。 使用场景:当某个文档不再需要时,可以将其删除以保持文档库的整洁。
168
168
  */
169
169
  async DeleteDocs(
170
- req?: DeleteDocsRequest,
170
+ req: DeleteDocsRequest,
171
171
  cb?: (error: string, rep: DeleteDocsResponse) => void
172
172
  ): Promise<DeleteDocsResponse> {
173
173
  return this.request("DeleteDocs", req, cb)
@@ -177,7 +177,7 @@ export class Client extends AbstractClient {
177
177
  * 用于删除已有的问答对。 使用场景:当某个问答对不再适用或需要移除时使用。
178
178
  */
179
179
  async DeleteQAs(
180
- req?: DeleteQAsRequest,
180
+ req: DeleteQAsRequest,
181
181
  cb?: (error: string, rep: DeleteQAsResponse) => void
182
182
  ): Promise<DeleteQAsResponse> {
183
183
  return this.request("DeleteQAs", req, cb)
@@ -229,7 +229,7 @@ export class Client extends AbstractClient {
229
229
  * 用于获取所有问答对的列表。 使用场景:用于查看当前系统中所有已有的问答对,方便进行管理和维护。
230
230
  */
231
231
  async ListQAs(
232
- req?: ListQAsRequest,
232
+ req: ListQAsRequest,
233
233
  cb?: (error: string, rep: ListQAsResponse) => void
234
234
  ): Promise<ListQAsResponse> {
235
235
  return this.request("ListQAs", req, cb)
@@ -239,7 +239,7 @@ export class Client extends AbstractClient {
239
239
  * 用于删除不再需要的属性标签。 使用场景:当某个标签不再使用时,可以将其删除以保持标签系统的整洁。
240
240
  */
241
241
  async DeleteAttributeLabels(
242
- req?: DeleteAttributeLabelsRequest,
242
+ req: DeleteAttributeLabelsRequest,
243
243
  cb?: (error: string, rep: DeleteAttributeLabelsResponse) => void
244
244
  ): Promise<DeleteAttributeLabelsResponse> {
245
245
  return this.request("DeleteAttributeLabels", req, cb)
@@ -272,7 +272,7 @@ export class Client extends AbstractClient {
272
272
  * 用于获取所有属性标签的列表。 使用场景:用于查看当前系统中所有已有的属性标签,方便进行管理和维护。
273
273
  */
274
274
  async ListAttributeLabels(
275
- req?: ListAttributeLabelsRequest,
275
+ req: ListAttributeLabelsRequest,
276
276
  cb?: (error: string, rep: ListAttributeLabelsResponse) => void
277
277
  ): Promise<ListAttributeLabelsResponse> {
278
278
  return this.request("ListAttributeLabels", req, cb)
@@ -282,7 +282,7 @@ export class Client extends AbstractClient {
282
282
  * 用于获取所有文档的列表。 使用场景:用于查看当前系统中所有已有的文档,方便进行管理和维护。
283
283
  */
284
284
  async ListDocs(
285
- req?: ListDocsRequest,
285
+ req: ListDocsRequest,
286
286
  cb?: (error: string, rep: ListDocsResponse) => void
287
287
  ): Promise<ListDocsResponse> {
288
288
  return this.request("ListDocs", req, cb)
@@ -302,7 +302,7 @@ export class Client extends AbstractClient {
302
302
  * 用于批量导入问答对,最多支持50,000条数据导入。通过此接口,可以将多个问答对一次性导入系统中,以便在后续的知识检索中使用。导入的问答对可以来自外部系统、文件或其他数据源。使用场景:当需要一次性导入大量的问答对时使用。例如,一个公司可能需要将其产品的常见问题解答从一个文档或外部系统批量导入到知识库中,以便用户可以通过知识检索系统进行查询。
303
303
  */
304
304
  async ImportQAs(
305
- req?: ImportQAsRequest,
305
+ req: ImportQAsRequest,
306
306
  cb?: (error: string, rep: ImportQAsResponse) => void
307
307
  ): Promise<ImportQAsResponse> {
308
308
  return this.request("ImportQAs", req, cb)
@@ -125,7 +125,20 @@ export interface RetrievalRecordMetadata {
125
125
  /**
126
126
  * ListQAs请求参数结构体
127
127
  */
128
- export type ListQAsRequest = null
128
+ export interface ListQAsRequest {
129
+ /**
130
+ * 知识库ID
131
+ */
132
+ KnowledgeBaseId: string
133
+ /**
134
+ * 页码,默认1
135
+ */
136
+ PageNumber?: number
137
+ /**
138
+ * 每页数目,最大50,默认20
139
+ */
140
+ PageSize?: number
141
+ }
129
142
 
130
143
  /**
131
144
  * ReconstructDocumentSSE返回参数结构体
@@ -173,6 +186,7 @@ export interface DocItem {
173
186
  /**
174
187
  * 状态,
175
188
  - Uploading 上传中
189
+ - Auditing 审核中
176
190
  - Parsing 解析中
177
191
  - ParseFailed 解析失败
178
192
  - Indexing 创建索引中
@@ -232,6 +246,31 @@ export type UploadDocRealtimeRequest = null
232
246
  * DescribeDoc返回参数结构体
233
247
  */
234
248
  export interface DescribeDocResponse {
249
+ /**
250
+ * 文档ID
251
+ */
252
+ DocId?: string
253
+ /**
254
+ * 状态,
255
+
256
+ - Uploading 上传中
257
+ - Auditing 审核中
258
+ - Parsing 解析中
259
+ - ParseFailed 解析失败
260
+ - Indexing 创建索引中
261
+ - IndexFailed 创建索引失败
262
+ - Success 发布成功
263
+ - Failed 失败
264
+ */
265
+ Status?: string
266
+ /**
267
+ * 文件名
268
+ */
269
+ FileName?: string
270
+ /**
271
+ * 更新时间
272
+ */
273
+ UpdateTime?: string
235
274
  /**
236
275
  * 属性标签
237
276
  */
@@ -261,12 +300,37 @@ export interface AttributeLabelReferItem {
261
300
  /**
262
301
  * DeleteQAs请求参数结构体
263
302
  */
264
- export type DeleteQAsRequest = null
303
+ export interface DeleteQAsRequest {
304
+ /**
305
+ * 知识库ID
306
+ */
307
+ KnowledgeBaseId: string
308
+ /**
309
+ * 问答对ID列表。支持批量删除,数量不超过100
310
+ */
311
+ QaIds: Array<string>
312
+ }
265
313
 
266
314
  /**
267
315
  * ModifyQA请求参数结构体
268
316
  */
269
317
  export interface ModifyQARequest {
318
+ /**
319
+ * 知识库ID
320
+ */
321
+ KnowledgeBaseId: string
322
+ /**
323
+ * 问答对ID
324
+ */
325
+ QaId: string
326
+ /**
327
+ * 问题,最大1000个英文字符
328
+ */
329
+ Question: string
330
+ /**
331
+ * 答案,最大4000个英文字符
332
+ */
333
+ Answer: string
270
334
  /**
271
335
  * 属性标签
272
336
  */
@@ -309,6 +373,10 @@ export interface GetReconstructDocumentResultRequest {
309
373
  * ListQAs返回参数结构体
310
374
  */
311
375
  export interface ListQAsResponse {
376
+ /**
377
+ * 问答对总数量
378
+ */
379
+ TotalCount?: number
312
380
  /**
313
381
  * 问答对信息
314
382
  */
@@ -354,7 +422,20 @@ export interface RetrievalSetting {
354
422
  /**
355
423
  * ListDocs请求参数结构体
356
424
  */
357
- export type ListDocsRequest = null
425
+ export interface ListDocsRequest {
426
+ /**
427
+ * 知识库ID
428
+ */
429
+ KnowledgeBaseId: string
430
+ /**
431
+ * 页码,默认1
432
+ */
433
+ PageNumber?: number
434
+ /**
435
+ * 每页数目,最大50,默认20
436
+ */
437
+ PageSize?: number
438
+ }
358
439
 
359
440
  /**
360
441
  * CreateAttributeLabel返回参数结构体
@@ -413,6 +494,10 @@ export interface SegmentationConfig {
413
494
  * CreateQA返回参数结构体
414
495
  */
415
496
  export interface CreateQAResponse {
497
+ /**
498
+ * 问答对ID
499
+ */
500
+ QaId?: string
416
501
  /**
417
502
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
418
503
  */
@@ -423,6 +508,22 @@ export interface CreateQAResponse {
423
508
  * ModifyAttributeLabel请求参数结构体
424
509
  */
425
510
  export interface ModifyAttributeLabelRequest {
511
+ /**
512
+ * 知识库ID
513
+ */
514
+ KnowledgeBaseId: string
515
+ /**
516
+ * 属性ID
517
+ */
518
+ AttributeId: string
519
+ /**
520
+ * 属性标识,最大40个英文字符,如style
521
+ */
522
+ AttributeKey: string
523
+ /**
524
+ * 属性名称,最大80个英文字符,如风格
525
+ */
526
+ AttributeName: string
426
527
  /**
427
528
  * 属性标签
428
529
  */
@@ -483,6 +584,10 @@ export interface ReconstructDocumentSSEConfig {
483
584
  * ListDocs返回参数结构体
484
585
  */
485
586
  export interface ListDocsResponse {
587
+ /**
588
+ * 文档总数
589
+ */
590
+ TotalCount?: number
486
591
  /**
487
592
  * 文档信息
488
593
  */
@@ -515,12 +620,34 @@ export interface DocumentUsage {
515
620
  /**
516
621
  * ListAttributeLabels请求参数结构体
517
622
  */
518
- export type ListAttributeLabelsRequest = null
623
+ export interface ListAttributeLabelsRequest {
624
+ /**
625
+ * 知识库ID
626
+ */
627
+ KnowledgeBaseId: string
628
+ /**
629
+ * 页码,默认1
630
+ */
631
+ PageNumber?: number
632
+ /**
633
+ * 每页数目,最大50,默认20
634
+ */
635
+ PageSize?: number
636
+ }
519
637
 
520
638
  /**
521
639
  * DeleteAttributeLabels请求参数结构体
522
640
  */
523
- export type DeleteAttributeLabelsRequest = null
641
+ export interface DeleteAttributeLabelsRequest {
642
+ /**
643
+ * 知识库ID
644
+ */
645
+ KnowledgeBaseId: string
646
+ /**
647
+ * 属性ID
648
+ */
649
+ AttributeIds: Array<string>
650
+ }
524
651
 
525
652
  /**
526
653
  * RetrieveKnowledge请求参数结构体
@@ -708,6 +835,10 @@ export interface ReconstructDocumentSSERequest {
708
835
  * ListAttributeLabels返回参数结构体
709
836
  */
710
837
  export interface ListAttributeLabelsResponse {
838
+ /**
839
+ * 属性总数
840
+ */
841
+ TotalCount?: number
711
842
  /**
712
843
  * 属性标签列表
713
844
  */
@@ -756,6 +887,18 @@ export interface AttributeLabelItem {
756
887
  * CreateAttributeLabel请求参数结构体
757
888
  */
758
889
  export interface CreateAttributeLabelRequest {
890
+ /**
891
+ * 知识库ID
892
+ */
893
+ KnowledgeBaseId: string
894
+ /**
895
+ * 属性标识,最大40个英文字符,如style
896
+ */
897
+ AttributeKey: string
898
+ /**
899
+ * 属性名称,最大80个英文字符,如风格
900
+ */
901
+ AttributeName: string
759
902
  /**
760
903
  * 属性标签信息
761
904
  */
@@ -765,12 +908,39 @@ export interface CreateAttributeLabelRequest {
765
908
  /**
766
909
  * ImportQAs请求参数结构体
767
910
  */
768
- export type ImportQAsRequest = null
911
+ export interface ImportQAsRequest {
912
+ /**
913
+ * 知识库ID
914
+ */
915
+ KnowledgeBaseId: string
916
+ /**
917
+ * 文件名
918
+ */
919
+ FileName: string
920
+ /**
921
+ * 文件的 Url 地址。文件存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议文件存储于腾讯云。 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
922
+ 导入模板:https://cdn.xiaowei.qq.com/lke/assets//static/批量导入问答模板v6.xlsx
923
+ */
924
+ FileUrl: string
925
+ /**
926
+ * 文件类型,仅支持XLSX格式,请使用模板
927
+ */
928
+ FileType?: string
929
+ }
769
930
 
770
931
  /**
771
932
  * DescribeDoc请求参数结构体
772
933
  */
773
- export type DescribeDocRequest = null
934
+ export interface DescribeDocRequest {
935
+ /**
936
+ * 知识库ID
937
+ */
938
+ KnowledgeBaseId: string
939
+ /**
940
+ * 文档ID
941
+ */
942
+ DocId: string
943
+ }
774
944
 
775
945
  /**
776
946
  * DeleteKnowledgeBase返回参数结构体
@@ -1186,6 +1356,18 @@ export interface DeleteKnowledgeBaseRequest {
1186
1356
  * CreateQA请求参数结构体
1187
1357
  */
1188
1358
  export interface CreateQARequest {
1359
+ /**
1360
+ * 知识库ID
1361
+ */
1362
+ KnowledgeBaseId: string
1363
+ /**
1364
+ * 问题,最大1000个英文字符
1365
+ */
1366
+ Question: string
1367
+ /**
1368
+ * 答案,最大4000个英文字符
1369
+ */
1370
+ Answer: string
1189
1371
  /**
1190
1372
  * 属性标签
1191
1373
  */
@@ -1300,4 +1482,13 @@ export interface ChatCompletionsResponse {
1300
1482
  /**
1301
1483
  * DeleteDocs请求参数结构体
1302
1484
  */
1303
- export type DeleteDocsRequest = null
1485
+ export interface DeleteDocsRequest {
1486
+ /**
1487
+ * 知识库ID
1488
+ */
1489
+ KnowledgeBaseId: string
1490
+ /**
1491
+ * 文档ID列表。支持批量删除,数量不超过100
1492
+ */
1493
+ DocIds: Array<string>
1494
+ }