Package de.xima.fc.prompt.ms.impl.service.generic_oai.service.model

Class GenericOaiQueryConfig

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.service.model.GenericOaiQueryConfig

All Implemented Interfaces:

IPromptQueryConfig_CumulativeProbabilityThreshold, IPromptQueryConfig_EffortLevel, IPromptQueryConfig_Files, IPromptQueryConfig_FrequencyPenalty, IPromptQueryConfig_GeneratedTokenLimit, IPromptQueryConfig_JsonSchemaOutput, IPromptQueryConfig_PresencePenalty, IPromptQueryConfig_SystemPrompt, IPromptQueryConfig_Temperature, IPromptQueryConfig_TextParameters, IPromptQueryConfig_UserPrompt, Serializable

public class GenericOaiQueryConfig
extends Object
implements Serializable, IPromptQueryConfig_CumulativeProbabilityThreshold, IPromptQueryConfig_EffortLevel, IPromptQueryConfig_GeneratedTokenLimit, IPromptQueryConfig_Files, IPromptQueryConfig_FrequencyPenalty, IPromptQueryConfig_PresencePenalty, IPromptQueryConfig_TextParameters, IPromptQueryConfig_JsonSchemaOutput, IPromptQueryConfig_SystemPrompt, IPromptQueryConfig_Temperature, IPromptQueryConfig_UserPrompt

Model class for the configuration of a generic OAI prompt query.

Since:

8.5.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_CumulativeProbabilityThreshold

ATTR_CUMULATIVE_PROBABILITY_THRESHOLD

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_EffortLevel

ATTR_EFFORT_LEVEL

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_Files

ATTR_FILES

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_FrequencyPenalty

ATTR_FREQUENCY_PENALTY

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_GeneratedTokenLimit

ATTR_GENERATED_TOKEN_LIMIT

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_JsonSchemaOutput

ATTR_JSON_SCHEMA_OUTPUT

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_PresencePenalty

ATTR_PRESENCE_PENALTY

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_SystemPrompt

ATTR_SYSTEM_PROMPT

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_Temperature

ATTR_TEMPERATURE

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_TextParameters

ATTR_TEXT_PARAMETERS

Fields inherited from interface de.xima.fc.prompt.service.support.IPromptQueryConfig_UserPrompt

ATTR_USER_PROMPT

Constructor Summary

Constructors

Constructor	Description
GenericOaiQueryConfig()

Method Summary

Modifier and Type	Method	Description
Double	getCumulativeProbabilityThreshold()	Gets the cumulative probability threshold for the prompt query.
String	getEffortLevel()	Gets the effort level the model should put into answering the prompt, e.g.
PromptFiles	getFiles()	Gets the configuration for the files needed by the prompt query.
Double	getFrequencyPenalty()	Gets the frequency penalty for the prompt query.
Long	getGeneratedTokenLimit()	Gets the maximum number of tokens the model should generate in its response to the prompt.
JsonSchemaOutput	getJsonSchemaOutput()	Gets the JSON schema output for the prompt query.
Double	getPresencePenalty()	Gets the presence penalty for the prompt query.
SystemPrompt	getSystemPrompt()	Gets the system prompt for the prompt query.
String	getTask()	Gets the task to be performed by the prompt service.
Double	getTemperature()	Gets the temperature for the prompt query.
List<PromptTextParameter>	getTextParameters()	Gets the list of text parameters accepted by the prompt query.
String	getUserPrompt()	Gets the user prompt for the prompt query.
void	setCumulativeProbabilityThreshold(Double cumulativeProbabilityThreshold)	Sets the cumulative probability threshold for the prompt query.
void	setEffortLevel(String effortLevel)	Sets the effort level the model should put into answering the prompt, e.g.
void	setFiles(PromptFiles files)	Sets the configuration for the files needed by the prompt query.
void	setFrequencyPenalty(Double frequencyPenalty)	Sets the frequency penalty for the prompt query.
void	setGeneratedTokenLimit(Long generatedTokenLimit)	Sets the maximum number of tokens the model should generate in its response to the prompt.
void	setJsonSchemaOutput(JsonSchemaOutput jsonSchemaOutput)	Sets the JSON schema output for the prompt query.
void	setPresencePenalty(Double presencePenalty)	Sets the presence penalty for the prompt query.
void	setSystemPrompt(SystemPrompt systemPrompt)	Sets the system prompt for the prompt query.
void	setTask(String task)	Sets the task to be performed by the prompt service.
void	setTemperature(Double temperature)	Sets the temperature for the prompt query.
void	setTextParameters(List<PromptTextParameter> textParameters)	Sets the list of text parameters accepted by the prompt query.
void	setUserPrompt(String userPrompt)	Sets the user prompt for the prompt query.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericOaiQueryConfig

public GenericOaiQueryConfig()

Method Detail

getCumulativeProbabilityThreshold

public Double getCumulativeProbabilityThreshold()

Description copied from interface: IPromptQueryConfig_CumulativeProbabilityThreshold

Gets the cumulative probability threshold for the prompt query. This is a value that controls the diversity of the output by limiting the selection of tokens to a subset whose cumulative probability exceeds the top-p value.

Specified by:

getCumulativeProbabilityThreshold in interface IPromptQueryConfig_CumulativeProbabilityThreshold

Returns:

The top probability.

setCumulativeProbabilityThreshold

public void setCumulativeProbabilityThreshold(Double cumulativeProbabilityThreshold)

Description copied from interface: IPromptQueryConfig_CumulativeProbabilityThreshold

Sets the cumulative probability threshold for the prompt query. This is a value that controls the diversity of the output by limiting the selection of tokens to a subset whose cumulative probability exceeds the top-p value.

Specified by:

setCumulativeProbabilityThreshold in interface IPromptQueryConfig_CumulativeProbabilityThreshold

Parameters:

cumulativeProbabilityThreshold - The top probability to set.

getEffortLevel

public String getEffortLevel()

Description copied from interface: IPromptQueryConfig_EffortLevel

Gets the effort level the model should put into answering the prompt, e.g. "low", "medium", or "high".

Specified by:

getEffortLevel in interface IPromptQueryConfig_EffortLevel

Returns:

The effort level.

setEffortLevel

public void setEffortLevel(String effortLevel)

Description copied from interface: IPromptQueryConfig_EffortLevel

Sets the effort level the model should put into answering the prompt, e.g. "low", "medium", or "high".

Specified by:

setEffortLevel in interface IPromptQueryConfig_EffortLevel

Parameters:

effortLevel - The effort level.

getFiles

public PromptFiles getFiles()

Description copied from interface: IPromptQueryConfig_Files

Gets the configuration for the files needed by the prompt query.

Specified by:

getFiles in interface IPromptQueryConfig_Files

Returns:

The configuration for the files.

setFiles

public void setFiles(PromptFiles files)

Description copied from interface: IPromptQueryConfig_Files

Sets the configuration for the files needed by the prompt query.

Specified by:

setFiles in interface IPromptQueryConfig_Files

Parameters:

files - The configuration for the files.

getFrequencyPenalty

public Double getFrequencyPenalty()

Description copied from interface: IPromptQueryConfig_FrequencyPenalty

Gets the frequency penalty for the prompt query. The frequency penalty is a value that penalizes new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

Specified by:

getFrequencyPenalty in interface IPromptQueryConfig_FrequencyPenalty

Returns:

The frequency penalty.

setFrequencyPenalty

public void setFrequencyPenalty(Double frequencyPenalty)

Description copied from interface: IPromptQueryConfig_FrequencyPenalty

Sets the frequency penalty for the prompt query. The frequency penalty is a value that penalizes new tokens

Specified by:

setFrequencyPenalty in interface IPromptQueryConfig_FrequencyPenalty

Parameters:

frequencyPenalty - The frequency penalty to set.

getGeneratedTokenLimit

public Long getGeneratedTokenLimit()

Description copied from interface: IPromptQueryConfig_GeneratedTokenLimit

Gets the maximum number of tokens the model should generate in its response to the prompt.

Specified by:

getGeneratedTokenLimit in interface IPromptQueryConfig_GeneratedTokenLimit

Returns:

The maximum number of generated tokens.

setGeneratedTokenLimit

public void setGeneratedTokenLimit(Long generatedTokenLimit)

Description copied from interface: IPromptQueryConfig_GeneratedTokenLimit

Sets the maximum number of tokens the model should generate in its response to the prompt.

Specified by:

setGeneratedTokenLimit in interface IPromptQueryConfig_GeneratedTokenLimit

Parameters:

generatedTokenLimit - The maximum number of generated tokens to set.

getJsonSchemaOutput

public JsonSchemaOutput getJsonSchemaOutput()

Description copied from interface: IPromptQueryConfig_JsonSchemaOutput

Gets the JSON schema output for the prompt query. The prompt provider will ensure that the response conforms to the configured JSON schema.

Specified by:

getJsonSchemaOutput in interface IPromptQueryConfig_JsonSchemaOutput

Returns:

The JSON schema output

setJsonSchemaOutput

public void setJsonSchemaOutput(JsonSchemaOutput jsonSchemaOutput)

Description copied from interface: IPromptQueryConfig_JsonSchemaOutput

Sets the JSON schema output for the prompt query. The prompt provider will ensure that the response conforms to the configured JSON schema.

Specified by:

setJsonSchemaOutput in interface IPromptQueryConfig_JsonSchemaOutput

Parameters:

jsonSchemaOutput - The JSON schema output to set

getPresencePenalty

public Double getPresencePenalty()

Description copied from interface: IPromptQueryConfig_PresencePenalty

Gets the presence penalty for the prompt query. The presence penalty is a value that penalizes new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

Specified by:

getPresencePenalty in interface IPromptQueryConfig_PresencePenalty

Returns:

The presence penalty.

setPresencePenalty

public void setPresencePenalty(Double presencePenalty)

Description copied from interface: IPromptQueryConfig_PresencePenalty

Sets the presence penalty for the prompt query. The presence penalty is a value that penalizes new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

Specified by:

setPresencePenalty in interface IPromptQueryConfig_PresencePenalty

Parameters:

presencePenalty - The presence penalty to set.

getSystemPrompt

public SystemPrompt getSystemPrompt()

Description copied from interface: IPromptQueryConfig_SystemPrompt

Gets the system prompt for the prompt query. The system prompt is a message that provides context or instructions to the query service, and it is given more weight than a user prompt.

Specified by:

getSystemPrompt in interface IPromptQueryConfig_SystemPrompt

Returns:

The system prompt.

setSystemPrompt

public void setSystemPrompt(SystemPrompt systemPrompt)

Description copied from interface: IPromptQueryConfig_SystemPrompt

Sets the system prompt for the prompt query. The system prompt is a message that provides context or instructions to the query service, and it is given more weight than a user prompt.

Specified by:

setSystemPrompt in interface IPromptQueryConfig_SystemPrompt

Parameters:

systemPrompt - The system prompt to set.

getTask

public String getTask()

Gets the task to be performed by the prompt service. Currently supported tasks are:

• CommonPromptTask.GENERATE_TEXT_ANSWER
• CommonPromptTask.GENERATE_JSON_ANSWER

Returns:

The task.

setTask

public void setTask(String task)

Sets the task to be performed by the prompt service. Currently supported tasks are:

• CommonPromptTask.GENERATE_TEXT_ANSWER
• CommonPromptTask.GENERATE_JSON_ANSWER

Parameters:

task - The task.

getTemperature

public Double getTemperature()

Description copied from interface: IPromptQueryConfig_Temperature

Gets the temperature for the prompt query. The temperature is a value that controls the randomness of the output. Usually higher values will make the output more random, while lower values will make it more focused and deterministic.

Specified by:

getTemperature in interface IPromptQueryConfig_Temperature

Returns:

The temperature.

setTemperature

public void setTemperature(Double temperature)

Description copied from interface: IPromptQueryConfig_Temperature

Sets the temperature for the prompt query. The temperature is a value that controls the randomness of the output. Usually higher values will make the output more random, while lower values will make it more focused and deterministic.

Specified by:

setTemperature in interface IPromptQueryConfig_Temperature

Parameters:

temperature - The temperature to set.

getTextParameters

public List<PromptTextParameter> getTextParameters()

Description copied from interface: IPromptQueryConfig_TextParameters

Gets the list of text parameters accepted by the prompt query.

Specified by:

getTextParameters in interface IPromptQueryConfig_TextParameters

Returns:

The list of text parameters.

setTextParameters

public void setTextParameters(List<PromptTextParameter> textParameters)

Description copied from interface: IPromptQueryConfig_TextParameters

Sets the list of text parameters accepted by the prompt query.

Specified by:

setTextParameters in interface IPromptQueryConfig_TextParameters

Parameters:

textParameters - The list of text parameters to set.

getUserPrompt

public String getUserPrompt()

Description copied from interface: IPromptQueryConfig_UserPrompt

Gets the user prompt for the prompt query. The user prompt is the message to which the query service should respond.

Specified by:

getUserPrompt in interface IPromptQueryConfig_UserPrompt

Returns:

The user prompt.

setUserPrompt

public void setUserPrompt(String userPrompt)

Description copied from interface: IPromptQueryConfig_UserPrompt

Sets the user prompt for the prompt query. The user prompt is the message to which the query service should respond.

Specified by:

setUserPrompt in interface IPromptQueryConfig_UserPrompt

Parameters:

userPrompt - The user prompt to set.