Class ChatCompletionChunk.Moderation.Output
-
- All Implemented Interfaces:
public final class ChatCompletionChunk.Moderation.OutputModeration for the generated output.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceChatCompletionChunk.Moderation.Output.VisitorAn interface that defines how to map each variant of Output to a value of type T.
public final classChatCompletionChunk.Moderation.Output.ModerationResultsSuccessful moderation results for the request input or generated output.
public final classChatCompletionChunk.Moderation.Output.ErrorAn error produced while attempting moderation.
-
Method Summary
Modifier and Type Method Description final Optional<ChatCompletionChunk.Moderation.Output.ModerationResults>moderationResults()Successful moderation results for the request input or generated output. final Optional<ChatCompletionChunk.Moderation.Output.Error>error()An error produced while attempting moderation. final BooleanisModerationResults()final BooleanisError()final ChatCompletionChunk.Moderation.Output.ModerationResultsasModerationResults()Successful moderation results for the request input or generated output. final ChatCompletionChunk.Moderation.Output.ErrorasError()An error produced while attempting moderation. final Optional<JsonValue>_json()final <T extends Any> Taccept(ChatCompletionChunk.Moderation.Output.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ChatCompletionChunk.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 ChatCompletionChunk.Moderation.OutputofModerationResults(ChatCompletionChunk.Moderation.Output.ModerationResults moderationResults)Successful moderation results for the request input or generated output. final static ChatCompletionChunk.Moderation.OutputofError(ChatCompletionChunk.Moderation.Output.Error error)An error produced while attempting moderation. -
-
Method Detail
-
moderationResults
final Optional<ChatCompletionChunk.Moderation.Output.ModerationResults> moderationResults()
Successful moderation results for the request input or generated output.
-
error
final Optional<ChatCompletionChunk.Moderation.Output.Error> error()
An error produced while attempting moderation.
-
isModerationResults
final Boolean isModerationResults()
-
asModerationResults
final ChatCompletionChunk.Moderation.Output.ModerationResults asModerationResults()
Successful moderation results for the request input or generated output.
-
asError
final ChatCompletionChunk.Moderation.Output.Error asError()
An error produced while attempting moderation.
-
accept
final <T extends Any> T accept(ChatCompletionChunk.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> visitModerationResults(ModerationResults moderationResults) { return Optional.of(moderationResults.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final ChatCompletionChunk.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.
-
ofModerationResults
final static ChatCompletionChunk.Moderation.Output ofModerationResults(ChatCompletionChunk.Moderation.Output.ModerationResults moderationResults)
Successful moderation results for the request input or generated output.
-
ofError
final static ChatCompletionChunk.Moderation.Output ofError(ChatCompletionChunk.Moderation.Output.Error error)
An error produced while attempting moderation.
-
-
-
-