tencentcloud-sdk-es 3.0.1052 → 3.0.1054

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 356c87343c364d29ce098675451183ed851d699b
-  data.tar.gz: acbc07117f49d578d78765e3da30339ffa9b92db
+  metadata.gz: 5dab5b1ee798fa5e34821526dffbcfeab334eac4
+  data.tar.gz: 56ba793eac5c6e356f90dd8f06d0e9a6151bf418
 SHA512:
-  metadata.gz: 5c86b60b6fc8810a20c8290d75545a2c3e3cc74aadea656bfbb4e5292ecaea64d7a8d5411d5de6a1d25f9cef5b8ea4f1f29349eefac50d0b2adc3d769a836599
-  data.tar.gz: 339ea02b4bc9e308ffa4418b14f2cabbef92bb53526cedb6e36bf80c48bba582cc2422dadeab99f6ec30dedfc1aff38d7de83552614443fcae8223336f85adb8
+  metadata.gz: 693bcbf7633a0680d186e6b2f341a82410da3b4956c44a0a9f9765a6c778e3855916503a64500fdde10527b4725132fd7a73f7efac115e492e339cc3db2cecb4
+  data.tar.gz: 94065f5c10d8bd9fdaaaf3e44dcc4bb730108f8ec4d8532c556ac239f0b92efa11606c3551204fbe96760f9f5c20c07fae36e770722c8ec5fda0bdcad6a2d0a9

data/lib/VERSION

@@ -1 +1 @@
-3.0.1052
+3.0.1054

data/lib/v20250101/client.rb

@@ -54,7 +54,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 实时文档切片
+        # 文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。
+        # 本接口为分隔符规则切片接口，有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service)  。
 
         # @param request: Request instance for ChunkDocument.
         # @type request: :class:`Tencentcloud::es::V20250101::ChunkDocumentRequest`
@@ -226,7 +227,8 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 重排序
+        # 重排是指在 RAG 过程中，通过评估文档与查询之间的相关性，将最相关的文档放在前面，确保语言模型在生成回答时优先考虑排名靠前的上下文，提高生成结果的准确性和可信度，也可以通过这种方式进行过滤，减少大模型成本。
+        # 本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service)  。
 
         # @param request: Request instance for RunRerank.
         # @type request: :class:`Tencentcloud::es::V20250101::RunRerankRequest`

data/lib/v20250101/models.rb

@@ -19,15 +19,15 @@ module TencentCloud
     module V20250101
       # ChatCompletions请求参数结构体
       class ChatCompletionsRequest < TencentCloud::Common::AbstractModel
-        # @param Messages: 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制
+        # @param Messages: 会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。
         # @type Messages: Array
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。
         # @type ModelName: String
-        # @param Stream: 是否以流式接口的形式返回数据，默认true
+        # @param Stream: 是否以流式接口的形式返回数据，默认true。
         # @type Stream: Boolean
-        # @param TopP: 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果
+        # @param TopP: 取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。
         # @type TopP: Float
-        # @param Temperature: 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果
+        # @param Temperature: 取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。
         # @type Temperature: Float
         # @param OnlineSearch: 是否开启联网搜索。默认为 false。
         # @type OnlineSearch: Boolean
@@ -194,9 +194,9 @@ module TencentCloud
 
       # 切片文档信息
       class ChunkDocument < TencentCloud::Common::AbstractModel
-        # @param FileType: 文件类型
+        # @param FileType: 文件类型，支持 MD，TXT 格式。
         # @type FileType: String
-        # @param FileContent: 文件的 base64值
+        # @param FileContent: 文本原文，使用字符串格式输入。
         # @type FileContent: String
 
         attr_accessor :FileType, :FileContent
@@ -214,11 +214,11 @@ module TencentCloud
 
       # ChunkDocumentAsync请求参数结构体
       class ChunkDocumentAsyncRequest < TencentCloud::Common::AbstractModel
-        # @param Document: 文件信息
+        # @param Document: 文件信息。
         # @type Document: :class:`Tencentcloud::Es.v20250101.models.Document`
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：doc-tree-chunk。
         # @type ModelName: String
-        # @param Config: 文件切片配置
+        # @param Config: 文件切片配置。
         # @type Config: :class:`Tencentcloud::Es.v20250101.models.ChunkConfigAsync`
 
         attr_accessor :Document, :ModelName, :Config
@@ -264,11 +264,11 @@ module TencentCloud
 
       # ChunkDocument请求参数结构体
       class ChunkDocumentRequest < TencentCloud::Common::AbstractModel
-        # @param Document: 文件切片文件信息
+        # @param Document: 切片文件信息。
         # @type Document: :class:`Tencentcloud::Es.v20250101.models.ChunkDocument`
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：doc-chunk。
         # @type ModelName: String
-        # @param Config: 文件切片配置
+        # @param Config: 文件切片配置。
         # @type Config: :class:`Tencentcloud::Es.v20250101.models.ChunkConfig`
 
         attr_accessor :Document, :ModelName, :Config
@@ -414,11 +414,11 @@ module TencentCloud
 
       # GetDocumentChunkResult返回参数结构体
       class GetDocumentChunkResultResponse < TencentCloud::Common::AbstractModel
-        # @param Status: 任务状态
+        # @param Status: 任务状态，-1：失败，0：运行中，1：成功。
         # @type Status: Integer
-        # @param DocumentChunkResultUrl: 切片结果
+        # @param DocumentChunkResultUrl: 切片结果文件。
         # @type DocumentChunkResultUrl: String
-        # @param Usage: 用量
+        # @param Usage: Token用量。
         # @type Usage: :class:`Tencentcloud::Es.v20250101.models.DocumentChunkUsage`
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -461,11 +461,11 @@ module TencentCloud
 
       # GetDocumentParseResult返回参数结构体
       class GetDocumentParseResultResponse < TencentCloud::Common::AbstractModel
-        # @param Status: 任务状态
+        # @param Status: 任务状态，-1：失败，0：运行中，1：成功。
         # @type Status: Integer
-        # @param DocumentParseResultUrl: 结果文件
+        # @param DocumentParseResultUrl: 结果文件。
         # @type DocumentParseResultUrl: String
-        # @param FailedPages: 失败的页码
+        # @param FailedPages: 失败的页码。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FailedPages: Array
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
@@ -490,9 +490,9 @@ module TencentCloud
 
       # GetTextEmbedding请求参数结构体
       class GetTextEmbeddingRequest < TencentCloud::Common::AbstractModel
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：bge-base-zh-v1.5,conan-embedding-v1,bge-m3,KaLM-embedding-multilingual-mini-v1。
         # @type ModelName: String
-        # @param Texts: 需进行向量化的文本集
+        # @param Texts: 需进行向量化的文本集。
         # @type Texts: Array
 
         attr_accessor :ModelName, :Texts
@@ -512,7 +512,7 @@ module TencentCloud
       class GetTextEmbeddingResponse < TencentCloud::Common::AbstractModel
         # @param Data: 结果集
         # @type Data: Array
-        # @param Usage: 消耗token数量
+        # @param Usage: 向量化消耗的token数量。
         # @type Usage: :class:`Tencentcloud::Es.v20250101.models.Usage`
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -635,9 +635,9 @@ module TencentCloud
 
       # ParseDocumentAsync请求参数结构体
       class ParseDocumentAsyncRequest < TencentCloud::Common::AbstractModel
-        # @param Document: 文件信息
+        # @param Document: 文件信息。
         # @type Document: :class:`Tencentcloud::Es.v20250101.models.Document`
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：doc-llm。
         # @type ModelName: String
 
         attr_accessor :Document, :ModelName
@@ -680,7 +680,7 @@ module TencentCloud
       class ParseDocumentRequest < TencentCloud::Common::AbstractModel
         # @param Document: 文件信息
         # @type Document: :class:`Tencentcloud::Es.v20250101.models.ParseDocument`
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，doc-llm。
         # @type ModelName: String
 
         attr_accessor :Document, :ModelName
@@ -701,11 +701,11 @@ module TencentCloud
 
       # ParseDocument返回参数结构体
       class ParseDocumentResponse < TencentCloud::Common::AbstractModel
-        # @param Progress: 进度
+        # @param Progress: 进度：0-100。
         # @type Progress: String
-        # @param DocumentParseResultUrl:  解析文件结果
+        # @param DocumentParseResultUrl:  解析文件结果。
         # @type DocumentParseResultUrl: String
-        # @param FailedPages: 失败页码
+        # @param FailedPages: 失败页码。
         # @type FailedPages: Array
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。本接口为流式响应接口，当请求成功时，RequestId 会被放在 HTTP 响应的 Header "X-TC-RequestId" 中。
         # @type RequestId: String
@@ -756,15 +756,15 @@ module TencentCloud
 
       # RunRerank请求参数结构体
       class RunRerankRequest < TencentCloud::Common::AbstractModel
-        # @param ModelName: 模型名称
+        # @param ModelName: 模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。
         # @type ModelName: String
-        # @param Query: 查询文本
+        # @param Query: 查询文本。
         # @type Query: String
-        # @param Documents: 待排序的候选doc列表
+        # @param Documents: 待排序的候选doc列表。
         # @type Documents: Array
-        # @param TopN: 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc
+        # @param TopN: 排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。
         # @type TopN: Integer
-        # @param ReturnDocuments: 返回的排序结果列表里面是否返回每一条document原文，默认值False
+        # @param ReturnDocuments: 返回的排序结果列表里面是否返回每一条document原文，默认值False。
         # @type ReturnDocuments: Boolean
 
         attr_accessor :ModelName, :Query, :Documents, :TopN, :ReturnDocuments
@@ -788,9 +788,9 @@ module TencentCloud
 
       # RunRerank返回参数结构体
       class RunRerankResponse < TencentCloud::Common::AbstractModel
-        # @param Data: 输出结果集
+        # @param Data: 输出结果集。
         # @type Data: Array
-        # @param Usage: 消耗token数量
+        # @param Usage: 消耗token数量。
         # @type Usage: :class:`Tencentcloud::Es.v20250101.models.Usage`
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-es
 version: !ruby/object:Gem::Version
-  version: 3.0.1052
+  version: 3.0.1054
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-30 00:00:00.000000000 Z
+date: 2025-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common