io.quarkiverse.langchain4j.guardrails.OutputGuardrailResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-langchain4j-core Show documentation
There is a newer version: 0.21.0
Show newest version
package io.quarkiverse.langchain4j.guardrails;

import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;

/**
 * The result of the validation of an {@link OutputGuardrail}
 *
 * @param result The result of the output guardrail validation.
 * @param failures The list of failures, empty if the validation succeeded.
 */
public record OutputGuardrailResult(Result result, List failures) implements GuardrailResult {

    private static final OutputGuardrailResult SUCCESS = new OutputGuardrailResult();

    private OutputGuardrailResult() {
        this(Result.SUCCESS, Collections.emptyList());
    }

    OutputGuardrailResult(List failures, boolean fatal) {
        this(fatal ? Result.FATAL : Result.FAILURE, failures);
    }

    public static OutputGuardrailResult success() {
        return SUCCESS;
    }

    public static OutputGuardrailResult failure(List failures) {
        return new OutputGuardrailResult((List) failures, false);
    }

    @Override
    public boolean isSuccess() {
        return result == Result.SUCCESS;
    }

    public boolean isRetry() {
        return !isSuccess() && failures.stream().anyMatch(Failure::retry);
    }

    public String getReprompt() {
        if (!isSuccess()) {
            for (Failure failure : failures) {
                if (failure.reprompt() != null) {
                    return failure.reprompt();
                }
            }
        }
        return null;
    }

    @Override
    public boolean isFatal() {
        return result == Result.FATAL;
    }

    @Override
    public OutputGuardrailResult validatedBy(Class guardrailClass) {
        if (!isSuccess()) {
            if (failures.size() != 1) {
                throw new IllegalArgumentException();
            }
            failures.set(0, failures.get(0).withGuardrailClass(guardrailClass));
        }
        return this;
    }

    @Override
    public String toString() {
        if (isSuccess()) {
            return "success";
        }
        return failures.stream().map(Failure::toString).collect(Collectors.joining(", "));
    }

    record Failure(String message, Throwable cause, Class guardrailClass, boolean retry,
            String reprompt) implements GuardrailResult.Failure {
        public Failure(String message) {
            this(message, null);
        }

        public Failure(String message, Throwable cause) {
            this(message, cause, false);
        }

        public Failure(String message, Throwable cause, boolean retry) {
            this(message, cause, null, retry, null);
        }

        public Failure(String message, Throwable cause, boolean retry, String reprompt) {
            this(message, cause, null, retry, reprompt);
        }

        @Override
        public Failure withGuardrailClass(Class guardrailClass) {
            return new Failure(message(), cause(), guardrailClass, retry, reprompt);
        }

        @Override
        public String toString() {
            return "The guardrail " + guardrailClass.getName() + " failed with this message: " + message;
        }

    }
}