Class PromptConnectionData.Builder

java.lang.Object
de.xima.fc.prompt.mgmt.service.PromptConnectionData.Builder
Enclosing class:
PromptConnectionData
public static final class PromptConnectionData.Builder extends Object
Builder for prompt connection data instances.
Since:
8.5.0

  • Method Details

    • build

      public PromptConnectionData build()
      Builds the prompt connection data instance with the current data.
      Returns:
      The new prompt connection data.

    • description

      @CanIgnoreReturnValue public PromptConnectionData.Builder description(String description)
      Sets the description of the prompt connection. The description should only be visible to backend users who configure the connection, but not to end users.
      Parameters:
      description - The description.
      Returns:
      The builder.

    • name

      @CanIgnoreReturnValue public PromptConnectionData.Builder name(String name)
      Sets the name of the prompt connection. The name is unique with the scope to which the connection is assigned.
      Parameters:
      name - The name.
      Returns:
      The builder.

    • scope

      @CanIgnoreReturnValue public PromptConnectionData.Builder scope(PromptScope scope)
      Sets the scope (assignee) of the prompt connection. Defines the scope to which the connection is assigned, e.g. the system or a tenant scope.
      Parameters:
      scope - The scope.
      Returns:
      The builder.

    • type

      @CanIgnoreReturnValue public PromptConnectionData.Builder type(String type)
      Sets the prompt service type of the prompt connection. The type defines which prompt service is being used, e.g. "openai", "azure_openai", "anthropic", etc.
      Parameters:
      type - The type.
      Returns:
      The builder.

    • uuid

      @CanIgnoreReturnValue public PromptConnectionData.Builder uuid(UUID uuid)
      Sets the UUID of the prompt connection. The UUID is unique only within the assigned scope.
      Parameters:
      uuid - The UUID.
      Returns:
      The builder.