tencentcloud-sdk-nodejs-es 4.1.23 → 4.1.32

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs-es",
-  "version": "4.1.23",
+  "version": "4.1.32",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/services/es/v20250101/es_client.d.ts

@@ -40,15 +40,17 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
        */
     ChatCompletions(req: ChatCompletionsRequest, cb?: (error: string, rep: ChatCompletionsResponse) => void): Promise<ChatCompletionsResponse>;
     /**
-     * 实时文档切片
-     */
+       * 文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。
+  本接口为分隔符规则切片接口，有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+       */
     ChunkDocument(req: ChunkDocumentRequest, cb?: (error: string, rep: ChunkDocumentResponse) => void): Promise<ChunkDocumentResponse>;
     /**
      * WebSearch API 是一个网页搜索服务，支持多种搜索引擎，可以获取网页的标题、URL、摘要和正文内容。
      */
     WebSearch(req: WebSearchRequest, cb?: (error: string, rep: WebSearchResponse) => void): Promise<WebSearchResponse>;
     /**
-     * 重排序
-     */
+       * 重排是指在 RAG 过程中，通过评估文档与查询之间的相关性，将最相关的文档放在前面，确保语言模型在生成回答时优先考虑排名靠前的上下文，提高生成结果的准确性和可信度，也可以通过这种方式进行过滤，减少大模型成本。
+  本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+       */
     RunRerank(req: RunRerankRequest, cb?: (error: string, rep: RunRerankResponse) => void): Promise<RunRerankResponse>;
 }

package/tencentcloud/services/es/v20250101/es_client.js

@@ -76,8 +76,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("ChatCompletions", req, cb);
     }
     /**
-     * 实时文档切片
-     */
+       * 文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。
+  本接口为分隔符规则切片接口，有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+       */
     async ChunkDocument(req, cb) {
         return this.request("ChunkDocument", req, cb);
     }
@@ -88,8 +89,9 @@ class Client extends TencentCloudCommon.AbstractClient {
         return this.request("WebSearch", req, cb);
     }
     /**
-     * 重排序
-     */
+       * 重排是指在 RAG 过程中，通过评估文档与查询之间的相关性，将最相关的文档放在前面，确保语言模型在生成回答时优先考虑排名靠前的上下文，提高生成结果的准确性和可信度，也可以通过这种方式进行过滤，减少大模型成本。
+  本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+       */
     async RunRerank(req, cb) {
         return this.request("RunRerank", req, cb);
     }

package/tencentcloud/services/es/v20250101/es_models.d.ts

@@ -3,23 +3,23 @@
  */
 export interface ChatCompletionsRequest {
     /**
-     * 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制
+     * 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
      */
     Messages: Array<Message>;
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
      */
     ModelName: string;
     /**
-     * 是否以流式接口的形式返回数据，默认true
+     * 是否以流式接口的形式返回数据，默认true。
      */
     Stream?: boolean;
     /**
-     * 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果
+     * 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。
      */
     TopP?: number;
     /**
-     * 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果
+     * 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。
      */
     Temperature?: number;
     /**
@@ -49,15 +49,15 @@ export interface DocumentChunkUsage {
  */
 export interface ChunkDocumentAsyncRequest {
     /**
-     * 文件信息
+     * 文件信息。
      */
     Document: Document;
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：doc-tree-chunk。
      */
     ModelName: string;
     /**
-     * 文件切片配置
+     * 文件切片配置。
      */
     Config?: ChunkConfigAsync;
 }
@@ -66,15 +66,15 @@ export interface ChunkDocumentAsyncRequest {
  */
 export interface ChunkDocumentRequest {
     /**
-     * 文件切片文件信息
+     * 切片文件信息。
      */
     Document: ChunkDocument;
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：doc-chunk。
      */
     ModelName: string;
     /**
-     * 文件切片配置
+     * 文件切片配置。
      */
     Config?: ChunkConfig;
 }
@@ -164,15 +164,15 @@ export interface Usage {
  */
 export interface ParseDocumentResponse {
     /**
-     * 进度
+     * 进度：0-100。
      */
     Progress?: string;
     /**
-     *  解析文件结果
+     *  解析文件结果。
      */
     DocumentParseResultUrl?: string;
     /**
-     * 失败页码
+     * 失败页码。
      */
     FailedPages?: Array<number | bigint>;
     /**
@@ -213,11 +213,11 @@ export interface Document {
  */
 export interface GetTextEmbeddingRequest {
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：bge-base-zh-v1.5,conan-embedding-v1,bge-m3,KaLM-embedding-multilingual-mini-v1。
      */
     ModelName: string;
     /**
-     * 需进行向量化的文本集
+     * 需进行向量化的文本集。
      */
     Texts: Array<string>;
 }
@@ -252,15 +252,15 @@ export interface ChunkDocumentResponse {
  */
 export interface GetDocumentParseResultResponse {
     /**
-     * 任务状态
+     * 任务状态，-1：失败，0：运行中，1：成功。
      */
     Status?: number;
     /**
-     * 结果文件
+     * 结果文件。
      */
     DocumentParseResultUrl?: string;
     /**
-     * 失败的页码
+     * 失败的页码。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     FailedPages?: Array<number | bigint>;
@@ -300,23 +300,23 @@ export interface Choice {
  */
 export interface RunRerankRequest {
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。
      */
     ModelName: string;
     /**
-     * 查询文本
+     * 查询文本。
      */
     Query: string;
     /**
-     * 待排序的候选doc列表
+     * 待排序的候选doc列表。
      */
     Documents: Array<string>;
     /**
-     * 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc
+     * 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。
      */
     TopN?: number;
     /**
-     * 返回的排序结果列表里面是否返回每一条document原文，默认值False
+     * 返回的排序结果列表里面是否返回每一条document原文，默认值False。
      */
     ReturnDocuments?: boolean;
 }
@@ -463,15 +463,15 @@ export interface ParseDocument {
  */
 export interface GetDocumentChunkResultResponse {
     /**
-     * 任务状态
+     * 任务状态，-1：失败，0：运行中，1：成功。
      */
     Status?: number;
     /**
-     * 切片结果
+     * 切片结果文件。
      */
     DocumentChunkResultUrl?: string;
     /**
-     * 用量
+     * Token用量。
      */
     Usage?: DocumentChunkUsage;
     /**
@@ -535,7 +535,7 @@ export interface ParseDocumentRequest {
      */
     Document: ParseDocument;
     /**
-     * 模型名称
+     * 模型名称，doc-llm。
      */
     ModelName: string;
 }
@@ -570,7 +570,7 @@ export interface GetTextEmbeddingResponse {
      */
     Data?: Array<EmbeddingData>;
     /**
-     * 消耗token数量
+     * 向量化消耗的token数量。
      */
     Usage?: Usage;
     /**
@@ -583,11 +583,11 @@ export interface GetTextEmbeddingResponse {
  */
 export interface RunRerankResponse {
     /**
-     * 输出结果集
+     * 输出结果集。
      */
     Data?: Array<RerankResult>;
     /**
-     * 消耗token数量
+     * 消耗token数量。
      */
     Usage?: Usage;
     /**
@@ -600,11 +600,11 @@ export interface RunRerankResponse {
  */
 export interface ParseDocumentAsyncRequest {
     /**
-     * 文件信息
+     * 文件信息。
      */
     Document: Document;
     /**
-     * 模型名称
+     * 模型名称，可选模型列表：doc-llm。
      */
     ModelName: string;
 }
@@ -613,11 +613,11 @@ export interface ParseDocumentAsyncRequest {
  */
 export interface ChunkDocument {
     /**
-     * 文件类型
+     * 文件类型，支持 MD，TXT 格式。
      */
     FileType?: string;
     /**
-     * 文件的 base64值
+     * 文本原文，使用字符串格式输入。
      */
     FileContent?: string;
 }