Class AnswerQueryRequest.SafetySpec (0.58.0)

public static final class AnswerQueryRequest.SafetySpec extends GeneratedMessageV3 implements AnswerQueryRequest.SafetySpecOrBuilder

Safety specification. There are two use cases:

  1. when only safety_spec.enable is set, the BLOCK_LOW_AND_ABOVE threshold will be applied for all categories.
  2. when safety_spec.enable is set and some safety_settings are set, only specified safety_settings are applied.

Protobuf type google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec

Static Fields

ENABLE_FIELD_NUMBER

public static final int ENABLE_FIELD_NUMBER
Field Value
Type Description
int

SAFETY_SETTINGS_FIELD_NUMBER

public static final int SAFETY_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnswerQueryRequest.SafetySpec getDefaultInstance()
Returns
Type Description
AnswerQueryRequest.SafetySpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnswerQueryRequest.SafetySpec.Builder newBuilder()
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

newBuilder(AnswerQueryRequest.SafetySpec prototype)

public static AnswerQueryRequest.SafetySpec.Builder newBuilder(AnswerQueryRequest.SafetySpec prototype)
Parameter
Name Description
prototype AnswerQueryRequest.SafetySpec
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

parseDelimitedFrom(InputStream input)

public static AnswerQueryRequest.SafetySpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnswerQueryRequest.SafetySpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnswerQueryRequest.SafetySpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnswerQueryRequest.SafetySpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnswerQueryRequest.SafetySpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnswerQueryRequest.SafetySpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SafetySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SafetySpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnswerQueryRequest.SafetySpec> parser()
Returns
Type Description
Parser<SafetySpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AnswerQueryRequest.SafetySpec getDefaultInstanceForType()
Returns
Type Description
AnswerQueryRequest.SafetySpec

getEnable()

public boolean getEnable()

Enable the safety filtering on the answer response. It is false by default.

bool enable = 1;

Returns
Type Description
boolean

The enable.

getParserForType()

public Parser<AnswerQueryRequest.SafetySpec> getParserForType()
Returns
Type Description
Parser<SafetySpec>
Overrides

getSafetySettings(int index)

public AnswerQueryRequest.SafetySpec.SafetySetting getSafetySettings(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySetting

getSafetySettingsCount()

public int getSafetySettingsCount()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSafetySettingsList()

public List<AnswerQueryRequest.SafetySpec.SafetySetting> getSafetySettingsList()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SafetySetting>

getSafetySettingsOrBuilder(int index)

public AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder

getSafetySettingsOrBuilderList()

public List<? extends AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder> getSafetySettingsOrBuilderList()

Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySetting safety_settings = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SafetySpec.SafetySettingOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnswerQueryRequest.SafetySpec.Builder newBuilderForType()
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnswerQueryRequest.SafetySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnswerQueryRequest.SafetySpec.Builder toBuilder()
Returns
Type Description
AnswerQueryRequest.SafetySpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException