Class PromptConnectionData

java.lang.Object
de.xima.fc.prompt.mgmt.service.PromptConnectionData
All Implemented Interfaces:
Serializable
public final class PromptConnectionData extends Object implements Serializable
Represents a prompt connection, i.e. the configuration needed to establish a connection to a prompt service. We support different prompt services, e.g. OpenAI, Azure OpenAI, Anthropic. Each prompt service is identified by its type(), and each type corresponds to a IPromptServiceHandler implementation which knows how to handle connections of that type.
Since:
8.5.0
See Also:

  • Method Details

    • description

      public String description()
      Gets the internal description of the prompt connection. The description should only be visible to backend users who configure the connection, but not to end users.
      Returns:
      The description of the prompt connection.

    • name

      public String name()
      Gets the name of the prompt connection. The name is unique with the scope to which the connection is assigned.
      Returns:
      The name of the prompt connection.

    • scope

      public PromptScope scope()
      Gets the scope (assignee) of the prompt connection. Defines the scope to which the connection is assigned, e.g. the system or a tenant scope.
      Returns:
      The scope.

    • type

      public String type()
      Gets the prompt service type of the prompt connection. The type defines which prompt service is being used, e.g. "openai", "azure_openai", "anthropic", etc.
      Returns:
      The type of the prompt connection.

    • uuid

      public UUID uuid()
      Gets the UUID of the prompt connection. The UUID is unique only within the assigned scope.
      Returns:
      The UUID of the prompt connection.

    • builder

      public static PromptConnectionData.Builder builder()
      Creates a new builder for a prompt connection data instance.

    • builder

      public static PromptConnectionData.Builder builder(PromptConnectionData data)
      Creates a new builder pre-configured with the data of this connection.
      Returns:
      A new builder.