Package com.google.genai.types

Class SafetySetting

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.SafetySetting

public abstract class SafetySetting
extends JsonSerializable

A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SafetySetting.Builder	Builder for SafetySetting.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
SafetySetting()

Method Summary

Modifier and Type	Method	Description
static SafetySetting.Builder	builder()	Instantiates a builder for SafetySetting.
abstract Optional<HarmCategory>	category()	Required.
static SafetySetting	fromJson(String jsonString)	Deserializes a JSON string to a SafetySetting object.
abstract Optional<HarmBlockMethod>	method()	Optional.
abstract Optional<HarmBlockThreshold>	threshold()	Required.
abstract SafetySetting.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SafetySetting

public SafetySetting()

Method Details

category

public abstract Optional<HarmCategory> category()

Required. The harm category to be blocked.

method

public abstract Optional<HarmBlockMethod> method()

Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. This field is not supported in Gemini API.

threshold

public abstract Optional<HarmBlockThreshold> threshold()

Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.

builder

public static SafetySetting.Builder builder()

Instantiates a builder for SafetySetting.

toBuilder

public abstract SafetySetting.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static SafetySetting fromJson(String jsonString)

Deserializes a JSON string to a SafetySetting object.