io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingPolicyConfigProps Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-01T15:41:28.691Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.ContextualGroundingPolicyConfigProps")
@software.amazon.jsii.Jsii.Proxy(ContextualGroundingPolicyConfigProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface ContextualGroundingPolicyConfigProps extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) The filter details for the guardrails contextual grounding filter.
*
* GROUNDING: Validate if the model responses are grounded and factually correct based on the information provided in the reference source,
* and block responses that are below the defined threshold of grounding.
* RELEVANCE: Validate if the model responses are relevant to the user's query and block responses
* that are below the defined threshold of relevance.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType getFiltersConfigType();
/**
* (experimental) The threshold details for the guardrails contextual grounding filter.
*
* 0 blocks nothing, 0.99 blocks almost everything
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull java.lang.Number getThreshold();
/**
* @return a {@link Builder} of {@link ContextualGroundingPolicyConfigProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link ContextualGroundingPolicyConfigProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType filtersConfigType;
java.lang.Number threshold;
/**
* Sets the value of {@link ContextualGroundingPolicyConfigProps#getFiltersConfigType}
* @param filtersConfigType The filter details for the guardrails contextual grounding filter. This parameter is required.
* GROUNDING: Validate if the model responses are grounded and factually correct based on the information provided in the reference source,
* and block responses that are below the defined threshold of grounding.
* RELEVANCE: Validate if the model responses are relevant to the user's query and block responses
* that are below the defined threshold of relevance.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder filtersConfigType(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType filtersConfigType) {
this.filtersConfigType = filtersConfigType;
return this;
}
/**
* Sets the value of {@link ContextualGroundingPolicyConfigProps#getThreshold}
* @param threshold The threshold details for the guardrails contextual grounding filter. This parameter is required.
* 0 blocks nothing, 0.99 blocks almost everything
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder threshold(java.lang.Number threshold) {
this.threshold = threshold;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link ContextualGroundingPolicyConfigProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public ContextualGroundingPolicyConfigProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link ContextualGroundingPolicyConfigProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ContextualGroundingPolicyConfigProps {
private final io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType filtersConfigType;
private final java.lang.Number threshold;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.filtersConfigType = software.amazon.jsii.Kernel.get(this, "filtersConfigType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType.class));
this.threshold = software.amazon.jsii.Kernel.get(this, "threshold", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.filtersConfigType = java.util.Objects.requireNonNull(builder.filtersConfigType, "filtersConfigType is required");
this.threshold = java.util.Objects.requireNonNull(builder.threshold, "threshold is required");
}
@Override
public final io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ContextualGroundingFilterConfigType getFiltersConfigType() {
return this.filtersConfigType;
}
@Override
public final java.lang.Number getThreshold() {
return this.threshold;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("filtersConfigType", om.valueToTree(this.getFiltersConfigType()));
data.set("threshold", om.valueToTree(this.getThreshold()));
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("@cdklabs/generative-ai-cdk-constructs.bedrock.ContextualGroundingPolicyConfigProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ContextualGroundingPolicyConfigProps.Jsii$Proxy that = (ContextualGroundingPolicyConfigProps.Jsii$Proxy) o;
if (!filtersConfigType.equals(that.filtersConfigType)) return false;
return this.threshold.equals(that.threshold);
}
@Override
public final int hashCode() {
int result = this.filtersConfigType.hashCode();
result = 31 * result + (this.threshold.hashCode());
return result;
}
}
}