Interface IPromptComputeQueryOutputRetVal

public interface IPromptComputeQueryOutputRetVal
The return value of handler.computeQueryOutput. Currently, there is only one return value, but this is an interface that allows for extensions later on.
Since:
8.5.0

  • Method Summary

    Modifier and Type
    Method
    Description
    IPromptQueryOutputDescriptor
    outputDescriptor()
    The output descriptor that defines the structure of the data that can be returned when executing a prompt query.

  • Method Details

    • outputDescriptor

      IPromptQueryOutputDescriptor outputDescriptor()
      The output descriptor that defines the structure of the data that can be returned when executing a prompt query. Each prompt query can return a JSON value and a map of binary files. The output descriptor describes (a) the structure of that JSON value; and (b) which file types are available for which map key.
      Returns:
      The output descriptor, never null.