Package de.xima.fc.prompt.service.support

Interface IPromptConnectionConfig_Model

  • All Known Implementing Classes:
    GenericOaiConnectionConfig
    public interface IPromptConnectionConfig_Model
    Mixin for a prompt query configuration model that allows the user to configure the model, i.e. the name of the model to use for the prompt service. Applicable only if the prompt service provider supports multiple models.

    Use of this mixin is optional, but ensures a consistent name for the property. When different prompt service handlers use the same property name, switching between different prompt service handlers preserves the configured data.

    See also the <xp:selectOneModel/> Faces component from the http://www.xima.de/taglib/xfc/prompt namespace, which provides a user interface for editing the data defined by this mixin.

    Since:
    8.5.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ATTR_MODEL
      The name of the model attribute.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getModel()
      Gets the name of the model to use when making requests to the prompt service provider.
      void setModel​(String apiKey)
      Sets the name of the model to use when making requests to the prompt service provider.

    • Field Detail

      • ATTR_MODEL

        static final String ATTR_MODEL
        The name of the model attribute. If you implement a custom serialization / deserialization, use this name for the attribute to increase compatibility with other prompt service handlers.
        See Also:
        Constant Field Values

    • Method Detail

      • getModel

        String getModel()
        Gets the name of the model to use when making requests to the prompt service provider.
        Returns:
        The name of the model to use when making requests to the prompt service provider.

      • setModel

        void setModel​(String apiKey)
        Sets the name of the model to use when making requests to the prompt service provider.
        Parameters:
        apiKey - The name of the model to use when making requests to the prompt service provider.