tencentcloud-sdk-nodejs 4.0.1022 → 4.0.1023

package/README.md

@@ -13,18 +13,47 @@
 
 安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
 
-## 通过 Npm 安装
+## 通过 NPM 安装
 
-通过 npm 获取安装是使用 NODEJS SDK 的推荐方法，npm 是 NODEJS 的包管理工具。关于 npm 详细可参考[ npm 官网](https://www.npmjs.com/) 。
+通过 NPM 获取安装是使用 NODEJS SDK 的推荐方法，NPM 是 NODEJS 的包管理工具。关于 NPM 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
 
-1. 执行以下安装命令：
-   > npm install tencentcloud-sdk-nodejs --save
-2. 在您的代码中引用对应模块代码，可参考示例。
-3. 如上引用方式会将腾讯云所有产品sdk下载到本地，可以将tencentcloud-sdk-nodejs换成tencentcloud-sdk-nodejs-cvm/cbs/vpc等，即可引用特定产品的sdk，代码中可将require("tencentcloud-sdk-nodejs")改为require("tencentcloud-sdk-nodejs-cvm/cbs/vpc")，其余不变，可参考示例，可大大节省存储空间。
+### 安装指定产品 SDK（推荐）
+
+安装 CVM SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-cvm --save
+```
+
+安装 VPC SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-vpc --save
+```
+
+具体产品的缩写表请参考 [products.md](./products.md) 中的包名字段。
+
+安装指定产品 SDK 后，注意修改引入的包名：
+
+```diff
+- const tencentcloud = require("tencentcloud-sdk-nodejs")
++ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
+
+- const CvmClient = tencentcloud.cvm.v20170312.Client
++ const CvmClient = cvm.v20170312.Client
+```
+
+### 安装全产品 SDK
+
+```
+npm install tencentcloud-sdk-nodejs --save
+```
+
+全产品 SDK 包含了所有云产品的调用代码，体积偏大，对体积敏感的场景，推荐安装指定产品 SDK。
 
 ## 通过源码包安装
 
-1. 前往 [Github 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
+1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
 2. 解压源码包到您项目合适的位置，例如 `sdk/tencentcloud-sdk-nodejs`。
 3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
 4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入sdk，具体可参考示例。
@@ -120,7 +149,7 @@ new XxxClient({
 
 # 旧版 SDK
 
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[github 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
+我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[GitHub 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
 
 # 常见问题
 - webpack打包出错/浏览器报错

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs",
-  "version": "4.0.1022",
+  "version": "4.0.1023",
   "description": "腾讯云 API NODEJS SDK",
   "main": "tencentcloud/index.js",
   "scripts": {

package/src/common/sdk_version.ts

@@ -1 +1 @@
-export const sdkVersion = "4.0.1022"
+export const sdkVersion = "4.0.1023"

package/src/services/lkeap/v20240522/lkeap_client.ts

@@ -18,13 +18,14 @@
 import { AbstractClient } from "../../../common/abstract_client"
 import { ClientConfig } from "../../../common/interface"
 import {
+  ChatCompletionsRequest,
   CreateSplitDocumentFlowRequest,
-  ImportQAsResponse,
   RetrievalRecordMetadata,
   ListQAsRequest,
   ReconstructDocumentSSEResponse,
   DocItem,
   GetEmbeddingRequest,
+  ImportQAsResponse,
   UploadDocRealtimeRequest,
   DescribeDocResponse,
   AttributeLabelReferItem,
@@ -69,6 +70,7 @@ import {
   UploadDocRealtimeResponse,
   SplitDocumentFailedPage,
   ModifyAttributeLabelResponse,
+  QueryRewriteResponse,
   UploadDocRequest,
   DeleteQAsResponse,
   CreateKnowledgeBaseResponse,
@@ -78,7 +80,7 @@ import {
   CreateSplitDocumentFlowConfig,
   RunRerankResponse,
   CreateReconstructDocumentFlowResponse,
-  QueryRewriteResponse,
+  ChatCompletionsResponse,
   CreateQARequest,
   UploadDocResponse,
   AttributeItem,
@@ -353,4 +355,14 @@ export class Client extends AbstractClient {
   ): Promise<UploadDocResponse> {
     return this.request("UploadDoc", req, cb)
   }
+
+  /**
+   * 对话
+   */
+  async ChatCompletions(
+    req: ChatCompletionsRequest,
+    cb?: (error: string, rep: ChatCompletionsResponse) => void
+  ): Promise<ChatCompletionsResponse> {
+    return this.request("ChatCompletions", req, cb)
+  }
 }

package/src/services/lkeap/v20240522/lkeap_models.ts

@@ -15,6 +15,24 @@
  * under the License.
  */
 
+/**
+ * ChatCompletions请求参数结构体
+ */
+export interface ChatCompletionsRequest {
+  /**
+   * 模型名称
+   */
+  Model: string
+  /**
+   * 会话列表
+   */
+  Messages: Array<Message>
+  /**
+   * 是否流式输出
+   */
+  Stream?: boolean
+}
+
 /**
  * CreateSplitDocumentFlow请求参数结构体
  */
@@ -69,16 +87,6 @@ export interface CreateSplitDocumentFlowRequest {
   Config?: CreateSplitDocumentFlowConfig
 }
 
-/**
- * ImportQAs返回参数结构体
- */
-export interface ImportQAsResponse {
-  /**
-   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
-   */
-  RequestId?: string
-}
-
 /**
  * 检索结果的元数据
  */
@@ -192,6 +200,16 @@ export interface GetEmbeddingRequest {
   Inputs: Array<string>
 }
 
+/**
+ * ImportQAs返回参数结构体
+ */
+export interface ImportQAsResponse {
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * UploadDocRealtime请求参数结构体
  */
@@ -860,6 +878,24 @@ export interface ModifyAttributeLabelResponse {
   RequestId?: string
 }
 
+/**
+ * QueryRewrite返回参数结构体
+ */
+export interface QueryRewriteResponse {
+  /**
+   * 改写结果
+   */
+  Content?: string
+  /**
+   * 消耗量，返回输入token数，输出token数以及总token数
+   */
+  Usage?: Usage
+  /**
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
 /**
  * UploadDoc请求参数结构体
  */
@@ -1067,19 +1103,11 @@ export interface CreateReconstructDocumentFlowResponse {
 }
 
 /**
- * QueryRewrite返回参数结构体
+ * ChatCompletions返回参数结构体
  */
-export interface QueryRewriteResponse {
+export interface ChatCompletionsResponse {
   /**
-   * 改写结果
-   */
-  Content?: string
-  /**
-   * 消耗量，返回输入token数，输出token数以及总token数
-   */
-  Usage?: Usage
-  /**
-   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+   * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
    */
   RequestId?: string
 }

package/tencentcloud/common/sdk_version.d.ts

@@ -1 +1 @@
-export declare const sdkVersion = "4.0.1022";
+export declare const sdkVersion = "4.0.1023";

package/tencentcloud/common/sdk_version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sdkVersion = void 0;
-exports.sdkVersion = "4.0.1022";
+exports.sdkVersion = "4.0.1023";

package/tencentcloud/services/lkeap/v20240522/lkeap_client.d.ts

@@ -1,6 +1,6 @@
 import { AbstractClient } from "../../../common/abstract_client";
 import { ClientConfig } from "../../../common/interface";
-import { CreateSplitDocumentFlowRequest, ImportQAsResponse, ListQAsRequest, ReconstructDocumentSSEResponse, GetEmbeddingRequest, UploadDocRealtimeRequest, DescribeDocResponse, DeleteQAsRequest, ModifyQARequest, GetReconstructDocumentResultRequest, ListQAsResponse, DeleteAttributeLabelsResponse, ListDocsRequest, CreateAttributeLabelResponse, RetrieveKnowledgeResponse, CreateSplitDocumentFlowResponse, CreateQAResponse, ModifyAttributeLabelRequest, ListDocsResponse, ListAttributeLabelsRequest, DeleteAttributeLabelsRequest, RetrieveKnowledgeRequest, GetReconstructDocumentResultResponse, RunRerankRequest, GetSplitDocumentResultRequest, ReconstructDocumentSSERequest, ListAttributeLabelsResponse, CreateAttributeLabelRequest, ImportQAsRequest, DescribeDocRequest, DeleteKnowledgeBaseResponse, DeleteDocsResponse, CreateReconstructDocumentFlowRequest, GetSplitDocumentResultResponse, ModifyQAResponse, UploadDocRealtimeResponse, ModifyAttributeLabelResponse, UploadDocRequest, DeleteQAsResponse, CreateKnowledgeBaseResponse, GetEmbeddingResponse, QueryRewriteRequest, RunRerankResponse, CreateReconstructDocumentFlowResponse, QueryRewriteResponse, CreateQARequest, UploadDocResponse, CreateKnowledgeBaseRequest, DeleteKnowledgeBaseRequest, DeleteDocsRequest } from "./lkeap_models";
+import { ChatCompletionsRequest, CreateSplitDocumentFlowRequest, ListQAsRequest, ReconstructDocumentSSEResponse, GetEmbeddingRequest, ImportQAsResponse, UploadDocRealtimeRequest, DescribeDocResponse, DeleteQAsRequest, ModifyQARequest, GetReconstructDocumentResultRequest, ListQAsResponse, DeleteAttributeLabelsResponse, ListDocsRequest, CreateAttributeLabelResponse, RetrieveKnowledgeResponse, CreateSplitDocumentFlowResponse, CreateQAResponse, ModifyAttributeLabelRequest, ListDocsResponse, ListAttributeLabelsRequest, DeleteAttributeLabelsRequest, RetrieveKnowledgeRequest, GetReconstructDocumentResultResponse, RunRerankRequest, GetSplitDocumentResultRequest, ReconstructDocumentSSERequest, ListAttributeLabelsResponse, CreateAttributeLabelRequest, ImportQAsRequest, DescribeDocRequest, DeleteKnowledgeBaseResponse, DeleteDocsResponse, CreateReconstructDocumentFlowRequest, GetSplitDocumentResultResponse, ModifyQAResponse, UploadDocRealtimeResponse, ModifyAttributeLabelResponse, QueryRewriteResponse, UploadDocRequest, DeleteQAsResponse, CreateKnowledgeBaseResponse, GetEmbeddingResponse, QueryRewriteRequest, RunRerankResponse, CreateReconstructDocumentFlowResponse, ChatCompletionsResponse, CreateQARequest, UploadDocResponse, CreateKnowledgeBaseRequest, DeleteKnowledgeBaseRequest, DeleteDocsRequest } from "./lkeap_models";
 /**
  * lkeap client
  * @class
@@ -113,4 +113,8 @@ export declare class Client extends AbstractClient {
 使用场景：适用于需要长期存储和检索的文档内容，如产品手册、用户指南等。
      */
     UploadDoc(req: UploadDocRequest, cb?: (error: string, rep: UploadDocResponse) => void): Promise<UploadDocResponse>;
+    /**
+     * 对话
+     */
+    ChatCompletions(req: ChatCompletionsRequest, cb?: (error: string, rep: ChatCompletionsResponse) => void): Promise<ChatCompletionsResponse>;
 }

package/tencentcloud/services/lkeap/v20240522/lkeap_client.js

@@ -183,5 +183,11 @@ class Client extends abstract_client_1.AbstractClient {
     async UploadDoc(req, cb) {
         return this.request("UploadDoc", req, cb);
     }
+    /**
+     * 对话
+     */
+    async ChatCompletions(req, cb) {
+        return this.request("ChatCompletions", req, cb);
+    }
 }
 exports.Client = Client;

package/tencentcloud/services/lkeap/v20240522/lkeap_models.d.ts

@@ -1,3 +1,20 @@
+/**
+ * ChatCompletions请求参数结构体
+ */
+export interface ChatCompletionsRequest {
+    /**
+     * 模型名称
+     */
+    Model: string;
+    /**
+     * 会话列表
+     */
+    Messages: Array<Message>;
+    /**
+     * 是否流式输出
+     */
+    Stream?: boolean;
+}
 /**
  * CreateSplitDocumentFlow请求参数结构体
  */
@@ -51,15 +68,6 @@ export interface CreateSplitDocumentFlowRequest {
      */
     Config?: CreateSplitDocumentFlowConfig;
 }
-/**
- * ImportQAs返回参数结构体
- */
-export interface ImportQAsResponse {
-    /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
-     */
-    RequestId?: string;
-}
 /**
  * 检索结果的元数据
  */
@@ -168,6 +176,15 @@ export interface GetEmbeddingRequest {
      */
     Inputs: Array<string>;
 }
+/**
+ * ImportQAs返回参数结构体
+ */
+export interface ImportQAsResponse {
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * UploadDocRealtime请求参数结构体
  */
@@ -792,6 +809,23 @@ export interface ModifyAttributeLabelResponse {
      */
     RequestId?: string;
 }
+/**
+ * QueryRewrite返回参数结构体
+ */
+export interface QueryRewriteResponse {
+    /**
+     * 改写结果
+     */
+    Content?: string;
+    /**
+     * 消耗量，返回输入token数，输出token数以及总token数
+     */
+    Usage?: Usage;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * UploadDoc请求参数结构体
  */
@@ -990,19 +1024,11 @@ export interface CreateReconstructDocumentFlowResponse {
     RequestId?: string;
 }
 /**
- * QueryRewrite返回参数结构体
+ * ChatCompletions返回参数结构体
  */
-export interface QueryRewriteResponse {
-    /**
-     * 改写结果
-     */
-    Content?: string;
+export interface ChatCompletionsResponse {
     /**
-     * 消耗量，返回输入token数，输出token数以及总token数
-     */
-    Usage?: Usage;
-    /**
-     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
      */
     RequestId?: string;
 }