Class Response.Moderation.Output
-
- All Implemented Interfaces:
public final class Response.Moderation.OutputModeration for the response output.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceResponse.Moderation.Output.VisitorAn interface that defines how to map each variant of Output to a value of type T.
public final classResponse.Moderation.Output.ModerationResultA moderation result produced for the response input or output.
public final classResponse.Moderation.Output.ErrorAn error produced while attempting moderation for the response input or output.
-
Method Summary
Modifier and Type Method Description final Optional<Response.Moderation.Output.ModerationResult>moderationResult()A moderation result produced for the response input or output. final Optional<Response.Moderation.Output.Error>error()An error produced while attempting moderation for the response input or output. final BooleanisModerationResult()final BooleanisError()final Response.Moderation.Output.ModerationResultasModerationResult()A moderation result produced for the response input or output. final Response.Moderation.Output.ErrorasError()An error produced while attempting moderation for the response input or output. final Optional<JsonValue>_json()final <T extends Any> Taccept(Response.Moderation.Output.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final Response.Moderation.Outputvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Response.Moderation.OutputofModerationResult(Response.Moderation.Output.ModerationResult moderationResult)A moderation result produced for the response input or output. final static Response.Moderation.OutputofError(Response.Moderation.Output.Error error)An error produced while attempting moderation for the response input or output. -
-
Method Detail
-
moderationResult
final Optional<Response.Moderation.Output.ModerationResult> moderationResult()
A moderation result produced for the response input or output.
-
error
final Optional<Response.Moderation.Output.Error> error()
An error produced while attempting moderation for the response input or output.
-
isModerationResult
final Boolean isModerationResult()
-
asModerationResult
final Response.Moderation.Output.ModerationResult asModerationResult()
A moderation result produced for the response input or output.
-
asError
final Response.Moderation.Output.Error asError()
An error produced while attempting moderation for the response input or output.
-
accept
final <T extends Any> T accept(Response.Moderation.Output.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = output.accept(new Output.Visitor<Optional<String>>() { @Override public Optional<String> visitModerationResult(ModerationResult moderationResult) { return Optional.of(moderationResult.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final Response.Moderation.Output validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
ofModerationResult
final static Response.Moderation.Output ofModerationResult(Response.Moderation.Output.ModerationResult moderationResult)
A moderation result produced for the response input or output.
-
ofError
final static Response.Moderation.Output ofError(Response.Moderation.Output.Error error)
An error produced while attempting moderation for the response input or output.
-
-
-
-