Package net.thevpc.naru.api.model

Interface NaruModelProvider

All Superinterfaces:
NComponent
All Known Implementing Classes:
AbstractNaruModelProvider
public interface NaruModelProvider extends NComponent
Abstraction over any LLM backend (Ollama, OpenAI, Anthropic, …). Implement this interface to add a new provider.

  • Method Details

    • getProtocol

      NOptional<NaruModelProtocol> getProtocol(NaruModelConfig model, NaruSession session)

    • name

      String name()
      Provider name for display purposes.

    • apiKey

      NOptional<String> apiKey(NaruSession session)

    • findModelIds

      List<String> findModelIds(NaruSession session)
      Fetch the list of available models from this provider.
      Returns:
      a list of model names

    • isAvailable

      default boolean isAvailable(NaruSession session)
      Whether this provider is currently reachable/usable. Used to hide unavailable providers from model listings (e.g. /model list should not display a local server that is down).

      Default is true (assume available). Providers backed by a remote/local HTTP server may override this to probe reachability.

    • setParam

      void setParam(String name, String value)

    • getParam

      NOptional<String> getParam(String name)

    • getParamNames

      Set<String> getParamNames()

    • isEnabled

      boolean isEnabled()

    • setEnabled

      void setEnabled(boolean enabled)

    • isSupportedInstallModel

      default boolean isSupportedInstallModel()

    • installModel

      default void installModel(NaruModelKey key, NaruSession session)

    • isSupportedUninstallModel

      default boolean isSupportedUninstallModel()

    • uninstallModel

      default void uninstallModel(NaruModelKey key, NaruSession session)

    • isSupportedUnloadModel

      default boolean isSupportedUnloadModel()

    • unloadModel

      default void unloadModel(NaruModelKey key, NaruSession session)

    • isSupportedPsModel

      default boolean isSupportedPsModel()

    • psModel

      default List<NaruModelPsResult> psModel(NaruSession session)