Package com.oracle.bmc.generativeaiinference.model

Class ApplyGuardrailsDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.generativeaiinference.model.ApplyGuardrailsDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class ApplyGuardrailsDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Details for applying guardrails to the input content.

Case 1: Use input for simple single-text moderation. Existing customers can continue to use this field for the current text-only flow. Case 2: Use multimodalInput for moderation over text, image, or a combination of both. multimodalInput supports a single text item, an array of text items only, an array of images only, or a mixed ordered combination of text and image items. Clients may provide input, multimodalInput, or both. At least one of these fields must be provided. If both input and multimodalInput are provided, the service will process input and discard multimodalInput.
Note: Objects should always be created or deserialized using the ApplyGuardrailsDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ApplyGuardrailsDetails.Builder, which maintain a set of all explicitly set fields called ApplyGuardrailsDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApplyGuardrailsDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ApplyGuardrailsDetails(GuardrailsInput input, List<GuardrailsInput> multimodalInput, GuardrailConfigs guardrailConfigs, GuardrailVersionConfig guardrailVersionConfig, String compartmentId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ApplyGuardrailsDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment to apply guardrails.
GuardrailConfigs	getGuardrailConfigs()
GuardrailVersionConfig	getGuardrailVersionConfig()
GuardrailsInput	getInput()
List<GuardrailsInput>	getMultimodalInput()	An ordered list of text and image inputs for multimodal guardrail evaluation.
int	hashCode()
ApplyGuardrailsDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApplyGuardrailsDetails

@Deprecated
@ConstructorProperties({"input","multimodalInput","guardrailConfigs","guardrailVersionConfig","compartmentId"})
public ApplyGuardrailsDetails(GuardrailsInput input,
                              List<GuardrailsInput> multimodalInput,
                              GuardrailConfigs guardrailConfigs,
                              GuardrailVersionConfig guardrailVersionConfig,
                              String compartmentId)

Deprecated.

Method Detail

builder

public static ApplyGuardrailsDetails.Builder builder()

Create a new builder.

toBuilder

public ApplyGuardrailsDetails.Builder toBuilder()

getInput

public GuardrailsInput getInput()

getMultimodalInput

public List<GuardrailsInput> getMultimodalInput()

An ordered list of text and image inputs for multimodal guardrail evaluation.

This field supports a single text item, an array of text items only, an array of images only, or a mixed ordered combination of text and image items. If both input and multimodalInput are provided, this field is ignored.

Returns:

the value

getGuardrailConfigs

public GuardrailConfigs getGuardrailConfigs()

getGuardrailVersionConfig

public GuardrailVersionConfig getGuardrailVersionConfig()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to apply guardrails.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel