Interface IPromptQueryIoObject

All Known Subinterfaces:
IPromptQueryRequestObject, IPromptQueryResponseObject
public interface IPromptQueryIoObject
Base interface for all prompt query I/O objects, i.e. request and response objects.
Since:
8.5.0
See Also:

  • Method Summary

    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, see file descriptor.
    String
    json()
    A serialized JSON value that conforms to the structure defined by the corresponding I/O parameter descriptor, see JSON descriptor.

  • Method Details

    • files

      Map<String, ? extends List<? extends IPromptBinaryData>> files()
      Binary data that conforms to the structure defined by the corresponding I/O parameter descriptor, see file descriptor.

      The map contains one key for each of the files defined in the file descriptor. The value is a list of binary data objects, each conforming to the file list descriptor for that key.

      Returns:
      The binary data.
      See Also:

    • json

      String json()
      A serialized JSON value that conforms to the structure defined by the corresponding I/O parameter descriptor, see JSON 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: