IPromptQueryConfig_EffortLevel (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

GenericOaiQueryConfig
```
public interface IPromptQueryConfig_EffortLevel
```
Mixin for a prompt query configuration model that allows the user to define amount of effort the prompt service should put into answering the prompt, sometimes also referred to as "reasoning effort" or "thinking level". It is up to implementations to define which effort levels are supported, and what their identifiers are. But see CommonEffortLevel for standard names of common effort levels. We encourage implementations to use these common names to increase interoperability between different prompt service implementations.
Use of this mixin is optional, but ensures a consistent name for property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.
See also the <xp:effortLevel/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

Since:

8.5.0

See Also:

CommonEffortLevel

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_EFFORT_LEVEL
The name of the effort level attribute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getEffortLevel()`	Gets the effort level the model should put into answering the prompt, e.g.
`void`	`setEffortLevel(String effortLevel)`	Sets the effort level the model should put into answering the prompt, e.g.

- Field Detail
  - ATTR_EFFORT_LEVEL
```
static final String ATTR_EFFORT_LEVEL
```
    The name of the effort level attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getEffortLevel
```
String getEffortLevel()
```
    Gets the effort level the model should put into answering the prompt, e.g. "low", "medium", or "high".
    
    Returns:
    
    The effort level.
  - setEffortLevel
```
void setEffortLevel(String effortLevel)
```
    Sets the effort level the model should put into answering the prompt, e.g. "low", "medium", or "high".
    
    Parameters:
    
    effortLevel - The effort level.