Package de.xima.fc.prompt.service
Interface IPromptQueryIoObject
-
- All Known Subinterfaces:
IPromptQueryRequestObject,IPromptQueryResponseObject
public interface IPromptQueryIoObjectBase interface for all prompt query I/O objects, i.e. request and response objects.- Since:
- 8.5.0
- See Also:
IPromptQueryRequestObject,IPromptQueryResponseObject
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,? extends List<? extends IPromptBinaryData>>files()Binary data that conforms to the structure defined by the corresponding I/O parameter descriptor, seefile descriptor.Stringjson()A serialized JSON value that conforms to the structure defined by the corresponding I/O parameter descriptor, seeJSON descriptor.
-
-
-
Method Detail
-
files
Map<String,? extends List<? extends IPromptBinaryData>> files()
Binary data that conforms to the structure defined by the corresponding I/O parameter descriptor, seefile descriptor.The map contains one key for each of the
filesdefined in the file descriptor. The value is a list of binary data objects, each conforming to thefile list descriptorfor that key.- Returns:
- The binary data.
- See Also:
IFileValueDescriptor
-
json
String json()
A serialized JSON value that conforms to the structure defined by the corresponding I/O parameter descriptor, seeJSON descriptor.The exact type of the returned object depends on the JSON structure defined in the descriptor. It may be a primitive type (String, Number, Boolean), a Map (for JSON objects), a List (for JSON arrays), or null.
When the JSON descriptor is
void, this method will return null.- Returns:
- The JSON value.
- See Also:
IValueDescriptor
-
-