Interface IPromptComputeQueryInputRetVal

public interface IPromptComputeQueryInputRetVal
The return value of handler.computeQueryInput. 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
    IPromptQueryInputDescriptor
    inputDescriptor()
    The output descriptor that defines the structure of the data that is passed to a prompt query upon execution.

  • Method Details

    • inputDescriptor

      IPromptQueryInputDescriptor inputDescriptor()
      The output descriptor that defines the structure of the data that is passed to a prompt query upon execution. Each prompt query can take a JSON value and a map of binary files as its input. The input descriptor describes (a) the structure of that JSON value; and (b) which file types are available for which map key.
      Returns:
      The input descriptor, never null.