Package de.espirit.firstspirit.ai.dto

Interface PromptOption

All Known Subinterfaces:
ConfigurablePromptOption
public interface PromptOption
An option an operation can be configured with.
Since:
5.2.240903

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    PromptOption.Builder
    A builder to create an option definition with.

  • Method Summary

    Modifier and Type
    Method
    Description
    static PromptOption.Builder
    builder()
    Returns a builder to create a new option definition with.
    static PromptOption.Builder
    builder(@NotNull PromptOption promptOption)
    Returns a builder to create a new option definition with.
    @NotNull UUID
    getId()
    Returns an identifier the option is associated with.
    @Unmodifiable @NotNull List<PromptOptionItem>
    getItems()
    Returns the list of items selectable in this option.
    @NotNull String
    getName()
    The name of the option to be shown.

  • Method Details

    • builder

      @NotNull static PromptOption.Builder builder()
      Returns a builder to create a new option definition with.
      Returns:
      The builder instance.
      Since:
      5.2.240903

    • builder

      @NotNull static PromptOption.Builder builder(@NotNull @NotNull PromptOption promptOption)
      Returns a builder to create a new option definition with.
      Parameters:
      promptOption - The option to pre-configure the builder with.
      Returns:
      The builder instance.
      Since:
      5.2.241209

    • getId

      @NotNull @NotNull UUID getId()
      Returns an identifier the option is associated with.
      Returns:
      The option identifier.
      Since:
      5.2.240903

    • getName

      @NotNull @NotNull String getName()
      The name of the option to be shown.
      Returns:
      The option name.
      Since:
      5.2.240903

    • getItems

      @NotNull @Unmodifiable @NotNull List<PromptOptionItem> getItems()
      Returns the list of items selectable in this option.
      Returns:
      The list of option items.
      Since:
      5.2.240903