Package de.espirit.firstspirit.ai.dto

Interface PromptOperation

All Known Subinterfaces:
ConfigurablePromptOperation
public interface PromptOperation
An operation to be performed using AI.
Since:
5.2.240903

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static PromptOperation.Builder
    builder()
    Returns a builder to create a new operation definition with.
    static PromptOperation.Builder
    builder(@NotNull PromptOperation operation)
    Returns a builder to create a new operation definition with.
    @NotNull List<AllowedTool>
    getAllowedTools()
    Returns a list of tools to allow for this operation.
    @NotNull UUID
    getId()
    Returns the identifier of this operation.
    @NotNull String
    getName()
    Returns the name to visualize the operation with.
    @Unmodifiable @NotNull List<UUID>
    getOptions()
    Returns a list of option identifiers the operation is configurable with.
    @NotNull String
    getPrompt()
    The prompt to build the generative AI request with.
    @Unmodifiable @NotNull Set<String>
    getTags()
    Returns the tags associated with this operation.
    boolean
    isTextRequired()
    Returns whether the operation requires input text.

  • Method Details

    • builder

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

    • builder

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

    • getId

      @NotNull @NotNull UUID getId()
      Returns the identifier of this operation.
      Returns:
      The operation id.
      Since:
      5.2.240903

    • getTags

      @NotNull @Unmodifiable @NotNull Set<String> getTags()
      Returns the tags associated with this operation.
      Returns:
      The operation tags.
      Since:
      5.2.240903

    • getName

      @NotNull @NotNull String getName()
      Returns the name to visualize the operation with.
      Returns:
      The operation name.
      Since:
      5.2.240903

    • getPrompt

      @NotNull @NotNull String getPrompt()
      The prompt to build the generative AI request with.
      Returns:
      The operation prompt.
      Since:
      5.2.240903

    • isTextRequired

      boolean isTextRequired()
      Returns whether the operation requires input text.
      Returns:
      true if the operation requires input text, false otherwise.
      Since:
      5.2.240903

    • getOptions

      @NotNull @Unmodifiable @NotNull List<UUID> getOptions()
      Returns a list of option identifiers the operation is configurable with.
      Returns:
      The option identifiers of this operation.
      Since:
      5.2.240903

    • getAllowedTools

      @NotNull @NotNull List<AllowedTool> getAllowedTools()
      Returns a list of tools to allow for this operation.
      Returns:
      The allowed tools specified for this operation.
      Since:
      5.2.251104