tencentcloud-sdk-nodejs 4.1.15 → 4.1.17

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

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+const abstract_client_1 = require("../../../common/abstract_client");
+/**
+ * es client
+ * @class
+ */
+class Client extends abstract_client_1.AbstractClient {
+    constructor(clientConfig) {
+        super("es.tencentcloudapi.com", "2025-01-01", clientConfig);
+    }
+    /**
+     * 文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。
+本接口为异步接口，有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。
+     */
+    async ChunkDocumentAsync(req, cb) {
+        return this.request("ChunkDocumentAsync", req, cb);
+    }
+    /**
+     * 获取文档切片结果
+     */
+    async GetDocumentChunkResult(req, cb) {
+        return this.request("GetDocumentChunkResult", req, cb);
+    }
+    /**
+     * 本服务可将各类格式文档精准转换为标准格式，满足企业知识库建设、技术文档迁移、内容平台结构化存储等需求。
+本接口为异步接口，有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+     */
+    async ParseDocumentAsync(req, cb) {
+        return this.request("ParseDocumentAsync", req, cb);
+    }
+    /**
+     * 本接口用于获取文档解析异步处理结果。
+     */
+    async GetDocumentParseResult(req, cb) {
+        return this.request("GetDocumentParseResult", req, cb);
+    }
+    /**
+     * Embedding是一种将高维数据映射到低维空间的技术，通常用于将非结构化数据，如文本、图像或音频转化为向量表示，使其更容易输入机器模型进行处理，并且向量之间的距离可以反映对象之间的相似性。
+本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+     */
+    async GetTextEmbedding(req, cb) {
+        return this.request("GetTextEmbedding", req, cb);
+    }
+    /**
+     * 本服务可将各类格式文档精准转换为标准格式，满足企业知识库建设、技术文档迁移、内容平台结构化存储等需求。
+本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)。
+     */
+    async ParseDocument(req, cb) {
+        return this.request("ParseDocument", req, cb);
+    }
+    /**
+     * 本服务支持一系列高性能的大语言模型，包括DeepSeek以及腾讯自主研发的混元大模型，结合混合搜索等先进搜索技术，快速高效实现RAG，有效解决幻觉和知识更新问题。
+本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
+     */
+    async ChatCompletions(req, cb) {
+        return this.request("ChatCompletions", req, cb);
+    }
+    /**
+     * 实时文档切片
+     */
+    async ChunkDocument(req, cb) {
+        return this.request("ChunkDocument", req, cb);
+    }
+    /**
+     * 重排序
+     */
+    async RunRerank(req, cb) {
+        return this.request("RunRerank", req, cb);
+    }
+}
+exports.Client = Client;

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

@@ -0,0 +1,568 @@
+/**
+ * ChatCompletions请求参数结构体
+ */
+export interface ChatCompletionsRequest {
+    /**
+     * 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制
+     */
+    Messages: Array<Message>;
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+    /**
+     * 是否以流式接口的形式返回数据，默认true
+     */
+    Stream?: boolean;
+    /**
+     * 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果
+     */
+    TopP?: number;
+    /**
+     * 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果
+     */
+    Temperature?: number;
+    /**
+     * 是否开启联网搜索。默认为 false。
+     */
+    OnlineSearch?: boolean;
+    /**
+     * 当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。
+     */
+    OnlineSearchOptions?: OnlineSearchOptions;
+}
+/**
+ * 文档切片用量
+ */
+export interface DocumentChunkUsage {
+    /**
+     *  解析页面数量
+     */
+    PageNumber?: number;
+    /**
+     * 消耗 token数量
+     */
+    TotalTokens?: number;
+}
+/**
+ * ChunkDocumentAsync请求参数结构体
+ */
+export interface ChunkDocumentAsyncRequest {
+    /**
+     * 文件信息
+     */
+    Document: Document;
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+    /**
+     * 文件切片配置
+     */
+    Config?: ChunkConfigAsync;
+}
+/**
+ * ChunkDocument请求参数结构体
+ */
+export interface ChunkDocumentRequest {
+    /**
+     * 文件切片文件信息
+     */
+    Document: ChunkDocument;
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+    /**
+     * 文件切片配置
+     */
+    Config?: ChunkConfig;
+}
+/**
+ * 搜索结果网页信息。
+ */
+export interface WebContent {
+    /**
+     * 搜素问题
+     */
+    Query?: string;
+    /**
+     * 标题
+     */
+    Title?: string;
+    /**
+     * 链接
+     */
+    Url?: string;
+    /**
+     * 时间
+     */
+    Time?: string;
+    /**
+     * 网页内容
+     */
+    Content?: string;
+    /**
+     * 切片索引
+     */
+    ChunkIndex?: string;
+    /**
+     * 分数
+     */
+    Score?: string;
+}
+/**
+ * GetDocumentChunkResult请求参数结构体
+ */
+export interface GetDocumentChunkResultRequest {
+    /**
+     *  任务 ID
+     */
+    TaskId: string;
+}
+/**
+ * 输出结果
+ */
+export interface RerankResult {
+    /**
+     * 对应的doc在输入候选doc数组中的位置索引值
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Index?: number;
+    /**
+     * 相似度分数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    RelevanceScore?: number;
+    /**
+     * doc原文内容
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Document?: string;
+}
+/**
+ * GetDocumentParseResult请求参数结构体
+ */
+export interface GetDocumentParseResultRequest {
+    /**
+     * 任务 Id
+     */
+    TaskId: string;
+}
+/**
+ * token消耗总数
+ */
+export interface Usage {
+    /**
+     * tokens总数
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    TotalTokens?: number;
+}
+/**
+ * ParseDocument返回参数结构体
+ */
+export interface ParseDocumentResponse {
+    /**
+     * 进度
+     */
+    Progress?: string;
+    /**
+     *  解析文件结果
+     */
+    DocumentParseResultUrl?: string;
+    /**
+     * 失败页码
+     */
+    FailedPages?: Array<number | bigint>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
+     */
+    RequestId?: string;
+}
+/**
+ * 文档信息
+ */
+export interface Document {
+    /**
+     * 文件类型。
+  支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2
+  支持的文件大小：
+  - PDF、DOC、DOCX、PPT、PPTX 支持100M
+  - MD、TXT、XLS、XLSX、CSV 支持10M
+  - 其他支持20M
+     */
+    FileType: string;
+    /**
+     * 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。
+     */
+    FileUrl?: string;
+    /**
+     * 文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。
+  支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。
+  支持的图片像素：单边介于20-10000px之间。
+     */
+    FileContent?: string;
+    /**
+     * 文件名称，当使用 base64上传的时候使用。
+     */
+    FileName?: string;
+}
+/**
+ * GetTextEmbedding请求参数结构体
+ */
+export interface GetTextEmbeddingRequest {
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+    /**
+     * 需进行向量化的文本集
+     */
+    Texts: Array<string>;
+}
+/**
+ * ParseDocumentAsync返回参数结构体
+ */
+export interface ParseDocumentAsyncResponse {
+    /**
+     * 任务 id
+     */
+    TaskId?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * ChunkDocument返回参数结构体
+ */
+export interface ChunkDocumentResponse {
+    /**
+     * 无
+     */
+    Chunks?: Array<Chunk>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * GetDocumentParseResult返回参数结构体
+ */
+export interface GetDocumentParseResultResponse {
+    /**
+     * 任务状态
+     */
+    Status?: number;
+    /**
+     * 结果文件
+     */
+    DocumentParseResultUrl?: string;
+    /**
+     * 失败的页码
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    FailedPages?: Array<number | bigint>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * token使用量
+ */
+export interface TokenUsage {
+    /**
+     * 表示prompt的tokens数，多次返回中保持不变
+     */
+    PromptTokens?: number;
+    /**
+     * 回答的token总数，在流式返回中，表示到目前为止所有completion的tokens总数，多次返回中持续累加
+     */
+    CompletionTokens?: number;
+    /**
+     * 表示prompt_tokens和completion_tokens之和
+     */
+    TotalTokens?: number;
+}
+/**
+ * 返回的回复, 支持多个。
+ */
+export interface Choice {
+    /**
+     * 返回的回复。
+     */
+    Message?: OutputMessage;
+}
+/**
+ * RunRerank请求参数结构体
+ */
+export interface RunRerankRequest {
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+    /**
+     * 查询文本
+     */
+    Query: string;
+    /**
+     * 待排序的候选doc列表
+     */
+    Documents: Array<string>;
+    /**
+     * 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc
+     */
+    TopN?: number;
+    /**
+     * 返回的排序结果列表里面是否返回每一条document原文，默认值False
+     */
+    ReturnDocuments?: boolean;
+}
+/**
+ * 向量内容
+ */
+export interface EmbeddingData {
+    /**
+     * embedding 内容
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Embedding?: Array<number>;
+    /**
+     * 索引序号
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Index?: number;
+}
+/**
+ * 文档分片配置
+ */
+export interface ChunkConfig {
+    /**
+     * 最大分片长度
+     */
+    MaxChunkSize?: number;
+    /**
+     * 分隔符列表
+     */
+    Delimiters?: Array<string>;
+}
+/**
+ * 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
+ */
+export interface OutputMessage {
+    /**
+     * 角色
+     */
+    Role?: string;
+    /**
+     * 文本内容
+     */
+    Content?: string;
+    /**
+     * 推理内容
+     */
+    ReasoningContent?: string;
+}
+/**
+ * 文档信息
+ */
+export interface ParseDocument {
+    /**
+     * 文件类型。
+  支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、IM、PCX、PPM、TIFF、XBM、HEIF、JP2
+  支持的文件大小：
+  - PDF、DOC、DOCX、PPT、PPTX 支持100M
+  - MD、TXT、XLS、XLSX、CSV 支持10M
+  - 其他支持20M
+     */
+    FileType: string;
+    /**
+     * 文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。
+     */
+    FileUrl?: string;
+    /**
+     * 文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。
+  支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。
+  支持的图片像素：单边介于20-10000px之间。
+     */
+    FileContent?: string;
+}
+/**
+ * GetDocumentChunkResult返回参数结构体
+ */
+export interface GetDocumentChunkResultResponse {
+    /**
+     * 任务状态
+     */
+    Status?: number;
+    /**
+     * 切片结果
+     */
+    DocumentChunkResultUrl?: string;
+    /**
+     * 用量
+     */
+    Usage?: DocumentChunkUsage;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * ChunkDocumentAsync返回参数结构体
+ */
+export interface ChunkDocumentAsyncResponse {
+    /**
+     * 任务 ID
+     */
+    TaskId?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * 联网搜索选项。
+ */
+export interface OnlineSearchOptions {
+    /**
+     * 搜索引擎。支持 bing 和 sogou。
+     */
+    Engine?: string;
+}
+/**
+ * ParseDocument请求参数结构体
+ */
+export interface ParseDocumentRequest {
+    /**
+     * 文件信息
+     */
+    Document: ParseDocument;
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+}
+/**
+ * 切片对象信息
+ */
+export interface Chunk {
+    /**
+     * chunk索引。切片顺序 id。
+     */
+    Index?: number;
+    /**
+     * chunk内容。
+     */
+    Content?: string;
+}
+/**
+ * 文档切片异步任务
+ */
+export interface ChunkConfigAsync {
+    /**
+     * 最大分片长度
+     */
+    MaxChunkSize?: number;
+}
+/**
+ * GetTextEmbedding返回参数结构体
+ */
+export interface GetTextEmbeddingResponse {
+    /**
+     * 结果集
+     */
+    Data?: Array<EmbeddingData>;
+    /**
+     * 消耗token数量
+     */
+    Usage?: Usage;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * RunRerank返回参数结构体
+ */
+export interface RunRerankResponse {
+    /**
+     * 输出结果集
+     */
+    Data?: Array<RerankResult>;
+    /**
+     * 消耗token数量
+     */
+    Usage?: Usage;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
+/**
+ * ParseDocumentAsync请求参数结构体
+ */
+export interface ParseDocumentAsyncRequest {
+    /**
+     * 文件信息
+     */
+    Document: Document;
+    /**
+     * 模型名称
+     */
+    ModelName: string;
+}
+/**
+ * 切片文档信息
+ */
+export interface ChunkDocument {
+    /**
+     * 文件类型
+     */
+    FileType?: string;
+    /**
+     * 文件的 base64值
+     */
+    FileContent?: string;
+}
+/**
+ * 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
+ */
+export interface Message {
+    /**
+     * 角色, ‘system', ‘user'，'assistant'或者'tool', 在message中, 除了system，其他必须是user与assistant交替(一问一答)
+     */
+    Role?: string;
+    /**
+     * 具体文本内容
+     */
+    Content?: string;
+}
+/**
+ * ChatCompletions返回参数结构体
+ */
+export interface ChatCompletionsResponse {
+    /**
+     * 此次请求的id
+     */
+    Id?: string;
+    /**
+     * 回复内容
+     */
+    Choices?: Array<Choice>;
+    /**
+     * token使用量
+     */
+    Usage?: TokenUsage;
+    /**
+     * 联网搜索结果。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    OnlineSearchContent?: Array<WebContent>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
+     */
+    RequestId?: string;
+}

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

@@ -0,0 +1,18 @@
+"use strict";
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+import * as Models from "./es_models";
+import { Client } from "./es_client";
+export declare const v20250101: {
+    Client: typeof Client;
+    Models: typeof Models;
+};

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v20250101 = void 0;
+const tslib_1 = require("tslib");
+const Models = tslib_1.__importStar(require("./es_models"));
+const es_client_1 = require("./es_client");
+exports.v20250101 = {
+    Client: es_client_1.Client,
+    Models: Models
+};