Package de.xima.fc.prompt.service

Interface IPromptExecutionParams<ConnectionConfig,​QueryConfig>

  • Type Parameters:
    ConnectionConfig - The type of the connection configuration model used by this prompt service.
    QueryConfig - The type of the query configuration model used by this prompt service.
    All Superinterfaces:
    Serializable
    public interface IPromptExecutionParams<ConnectionConfig,​QueryConfig>
extends Serializable
    Input parameters for executing a prompt query, see executePromptQuery.
    Since:
    8.5.0

    • Method Detail

      • connectionConfig

        ConnectionConfig connectionConfig()
        The configuration of the prompt connection selected for the query to execute.
        Returns:
        The connection configuration.

      • context

        IPromptExecutionContext context()
        Gets the context used during execution of a prompt query. Provides access to various utilities, such as for replacing placeholders or accessing contextual data.
        Returns:
        The context.

      • queryConfig

        QueryConfig queryConfig()
        The configuration of the prompt query to execute.
        Returns:
        The query configuration.

      • requestObject

        IPromptQueryRequestObject requestObject()
        Gets the data needed to execute the prompt query. Will conform to the structure defined by handler.computeQueryInput.
        Returns:
        The request object with the data for the input parameters defined in the input descriptor.