Package com.polarion.alm.tracker.ai

Interface IUseCaseResult

public interface IUseCaseResult
Since:
3.26.6

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IUseCaseResult.Error
     
    static enum 
    IUseCaseResult.ErrorCode
    More specific error codes may be added in the future; clients should be prepared to handle unknown values.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    content()
    Returns the content of the response message from the model if the use case execution succeeds.
    IUseCaseResult.Error
    error()
    If the use case execution fails, it returns the error details.
    String
    role()
    Returns the role (such as "assistant" or "system") associated with the response message if the use case execution succeeds.

  • Method Details

    • role

      @NotNull String role()
      Returns the role (such as "assistant" or "system") associated with the response message if the use case execution succeeds. If the execution fails (see error()), it returns an empty string.

    • content

      @NotNull String content()
      Returns the content of the response message from the model if the use case execution succeeds. If the execution fails (see error()), it returns an empty string.

    • error

      @Nullable IUseCaseResult.Error error()
      If the use case execution fails, it returns the error details.