IPromptQueryConfig_JsonSchemaOutput (formcycle: bom 8.5.6 API)

All Known Implementing Classes:

GenericOaiQueryConfig
```
public interface IPromptQueryConfig_JsonSchemaOutput
```
Mixin for a prompt query configuration model that allows the user to define a JSON schema for the prompt response.
Use of this mixin is optional, but ensures a consistent name for the 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:jsonSchemaOutput/> 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

Field Summary

Fields
Modifier and Type Field Description

static String ATTR_JSON_SCHEMA_OUTPUT
The name of the JSON schema output attribute.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`JsonSchemaOutput`	`getJsonSchemaOutput()`	Gets the JSON schema output for the prompt query.
`void`	`setJsonSchemaOutput(JsonSchemaOutput jsonSchemaOutput)`	Sets the JSON schema output for the prompt query.

- Field Detail
  - ATTR_JSON_SCHEMA_OUTPUT
```
static final String ATTR_JSON_SCHEMA_OUTPUT
```
    The name of the JSON schema output 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
  - getJsonSchemaOutput
```
JsonSchemaOutput getJsonSchemaOutput()
```
    Gets the JSON schema output for the prompt query. The prompt provider will ensure that the response conforms to the configured JSON schema.
    
    Returns:
    
    The JSON schema output
  - setJsonSchemaOutput
```
void setJsonSchemaOutput(JsonSchemaOutput jsonSchemaOutput)
```
    Sets the JSON schema output for the prompt query. The prompt provider will ensure that the response conforms to the configured JSON schema.
    
    Parameters:
    
    jsonSchemaOutput - The JSON schema output to set