Class: TencentCloud::Es::V20250101::RunRerankRequest

Inherits:

Common::AbstractModel

• Object
• Common::AbstractModel
• TencentCloud::Es::V20250101::RunRerankRequest

Defined in:

lib/v20250101/models.rb

Overview

RunRerank请求参数结构体

Instance Attribute Summary

• #Documents ⇒ Object
• #ModelName ⇒ Object
• #Query ⇒ Object
• #ReturnDocuments ⇒ Object
• #TopN ⇒ Object

Instance Method Summary

• #deserialize(params) ⇒ Object
• #initialize(modelname = nil, query = nil, documents = nil, topn = nil, returndocuments = nil) ⇒ RunRerankRequest constructor

  A new instance of RunRerankRequest.

Constructor Details

#initialize(modelname = nil, query = nil, documents = nil, topn = nil, returndocuments = nil) ⇒ RunRerankRequest

Returns a new instance of RunRerankRequest.

# File 'lib/v20250101/models.rb', line 1032

def initialize(modelname=nil, query=nil, documents=nil, topn=nil, returndocuments=nil)
  @ModelName = modelname
  @Query = query
  @Documents = documents
  @TopN = topn
  @ReturnDocuments = returndocuments
end

Instance Attribute Details

#Documents ⇒ Object

Parameters:

• ModelName: —

  模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

• Query: —

  查询文本。

• Documents: —

  待排序的候选doc列表。

• TopN: —

  排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

• ReturnDocuments: —

  返回的排序结果列表里面是否返回每一条document原文，默认值False。

# File 'lib/v20250101/models.rb', line 1030

def Documents
  @Documents
end

#ModelName ⇒ Object

Parameters:

• ModelName: —

  模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

• Query: —

  查询文本。

• Documents: —

  待排序的候选doc列表。

• TopN: —

  排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

• ReturnDocuments: —

  返回的排序结果列表里面是否返回每一条document原文，默认值False。

# File 'lib/v20250101/models.rb', line 1030

def ModelName
  @ModelName
end

#Query ⇒ Object

Parameters:

• ModelName: —

  模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

• Query: —

  查询文本。

• Documents: —

  待排序的候选doc列表。

• TopN: —

  排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

• ReturnDocuments: —

  返回的排序结果列表里面是否返回每一条document原文，默认值False。

# File 'lib/v20250101/models.rb', line 1030

def Query
  @Query
end

#ReturnDocuments ⇒ Object

Parameters:

• ModelName: —

  模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

• Query: —

  查询文本。

• Documents: —

  待排序的候选doc列表。

• TopN: —

  排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

• ReturnDocuments: —

  返回的排序结果列表里面是否返回每一条document原文，默认值False。

# File 'lib/v20250101/models.rb', line 1030

def ReturnDocuments
  @ReturnDocuments
end

#TopN ⇒ Object

Parameters:

• ModelName: —

  模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。

• Query: —

  查询文本。

• Documents: —

  待排序的候选doc列表。

• TopN: —

  排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。

• ReturnDocuments: —

  返回的排序结果列表里面是否返回每一条document原文，默认值False。

# File 'lib/v20250101/models.rb', line 1030

def TopN
  @TopN
end

Instance Method Details

#deserialize(params) ⇒ Object

# File 'lib/v20250101/models.rb', line 1040

def deserialize(params)
  @ModelName = params['ModelName']
  @Query = params['Query']
  @Documents = params['Documents']
  @TopN = params['TopN']
  @ReturnDocuments = params['ReturnDocuments']
end