com.tencentcloudapi.lkeap.v20240522.models

Class GetEmbeddingRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lkeap.v20240522.models.GetEmbeddingRequest

public class GetEmbeddingRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
GetEmbeddingRequest()
GetEmbeddingRequest(GetEmbeddingRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String[]	getInputs() Get 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条
String	getInstruction() Get 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效
String	getModel() Get 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]
String	getTextType() Get 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。
void	setInputs(String[] Inputs) Set 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条
void	setInstruction(String Instruction) Set 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效
void	setModel(String Model) Set 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]
void	setTextType(String TextType) Set 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetEmbeddingRequest

public GetEmbeddingRequest()

GetEmbeddingRequest

public GetEmbeddingRequest(GetEmbeddingRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getModel

public String getModel()

Get 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]

Returns:

Model 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]

setModel

public void setModel(String Model)

Set 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]

Parameters:

Model - 说明：选择生成向量的模型备注：可选[lke-text-embedding-v1,lke-text-embedding-v2,youtu-embedding-llm-v1]

getInputs

public String[] getInputs()

Get 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条

Returns:

Inputs 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条

setInputs

public void setInputs(String[] Inputs)

Set 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条

Parameters:

Inputs - 说明：需要 embedding 的文本 备注：单条query最多2000个字符，总条数最多7条

getTextType

public String getTextType()

Get 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。

Returns:

TextType 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。

setTextType

public void setTextType(String TextType)

Set 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。

Parameters:

TextType - 说明：文本向量化的类型，为使得检索任务有更好的检索效果，建议区分查询文本（query）和文档文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。

getInstruction

public String getInstruction()

Get 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效

Returns:

Instruction 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效

setInstruction

public void setInstruction(String Instruction)

Set 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效

Parameters:

Instruction - 说明：自定义任务指令词，当且仅当TextType=query且Model为youtu-embedding-llm-v1时，生效

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.