Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Guardrail.ContentFilter (0.1.0)

public static final class Guardrail.ContentFilter extends GeneratedMessage implements Guardrail.ContentFilterOrBuilder

Guardrail that bans certain content from being used in the conversation.

Protobuf type google.cloud.ces.v1.Guardrail.ContentFilter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Guardrail.ContentFilter

Implements

Guardrail.ContentFilterOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

BANNED_CONTENTS_FIELD_NUMBER

public static final int BANNED_CONTENTS_FIELD_NUMBER

Field Value
Type	Description
`int`

BANNED_CONTENTS_IN_AGENT_RESPONSE_FIELD_NUMBER

public static final int BANNED_CONTENTS_IN_AGENT_RESPONSE_FIELD_NUMBER

Field Value
Type	Description
`int`

BANNED_CONTENTS_IN_USER_INPUT_FIELD_NUMBER

public static final int BANNED_CONTENTS_IN_USER_INPUT_FIELD_NUMBER

Field Value
Type	Description
`int`

DISREGARD_DIACRITICS_FIELD_NUMBER

public static final int DISREGARD_DIACRITICS_FIELD_NUMBER

Field Value
Type	Description
`int`

MATCH_TYPE_FIELD_NUMBER

public static final int MATCH_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Guardrail.ContentFilter getDefaultInstance()

Returns
Type	Description
`Guardrail.ContentFilter`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Guardrail.ContentFilter.Builder newBuilder()

Returns
Type	Description
`Guardrail.ContentFilter.Builder`

newBuilder(Guardrail.ContentFilter prototype)

public static Guardrail.ContentFilter.Builder newBuilder(Guardrail.ContentFilter prototype)

Parameter
Name	Description
`prototype`	`Guardrail.ContentFilter`

Returns
Type	Description
`Guardrail.ContentFilter.Builder`

parseDelimitedFrom(InputStream input)

public static Guardrail.ContentFilter parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Guardrail.ContentFilter parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Guardrail.ContentFilter parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Guardrail.ContentFilter parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Guardrail.ContentFilter parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Guardrail.ContentFilter parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Guardrail.ContentFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Guardrail.ContentFilter`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Guardrail.ContentFilter> parser()

Returns
Type	Description
`Parser<ContentFilter>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getBannedContents(int index)

public String getBannedContents(int index)

Optional. List of banned phrases. Applies to both user inputs and agent responses.

repeated string banned_contents = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The bannedContents at the given index.

getBannedContentsBytes(int index)

public ByteString getBannedContentsBytes(int index)

Optional. List of banned phrases. Applies to both user inputs and agent responses.

repeated string banned_contents = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the bannedContents at the given index.

getBannedContentsCount()

public int getBannedContentsCount()

Optional. List of banned phrases. Applies to both user inputs and agent responses.

repeated string banned_contents = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of bannedContents.

getBannedContentsInAgentResponse(int index)

public String getBannedContentsInAgentResponse(int index)

Optional. List of banned phrases. Applies only to agent responses.

repeated string banned_contents_in_agent_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The bannedContentsInAgentResponse at the given index.

getBannedContentsInAgentResponseBytes(int index)

public ByteString getBannedContentsInAgentResponseBytes(int index)

Optional. List of banned phrases. Applies only to agent responses.

repeated string banned_contents_in_agent_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the bannedContentsInAgentResponse at the given index.

getBannedContentsInAgentResponseCount()

public int getBannedContentsInAgentResponseCount()

Optional. List of banned phrases. Applies only to agent responses.

repeated string banned_contents_in_agent_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of bannedContentsInAgentResponse.

getBannedContentsInAgentResponseList()

public ProtocolStringList getBannedContentsInAgentResponseList()

Optional. List of banned phrases. Applies only to agent responses.

repeated string banned_contents_in_agent_response = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the bannedContentsInAgentResponse.

getBannedContentsInUserInput(int index)

public String getBannedContentsInUserInput(int index)

Optional. List of banned phrases. Applies only to user inputs.

repeated string banned_contents_in_user_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The bannedContentsInUserInput at the given index.

getBannedContentsInUserInputBytes(int index)

public ByteString getBannedContentsInUserInputBytes(int index)

Optional. List of banned phrases. Applies only to user inputs.

repeated string banned_contents_in_user_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the bannedContentsInUserInput at the given index.

getBannedContentsInUserInputCount()

public int getBannedContentsInUserInputCount()

Optional. List of banned phrases. Applies only to user inputs.

repeated string banned_contents_in_user_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of bannedContentsInUserInput.

getBannedContentsInUserInputList()

public ProtocolStringList getBannedContentsInUserInputList()

Optional. List of banned phrases. Applies only to user inputs.

repeated string banned_contents_in_user_input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the bannedContentsInUserInput.

getBannedContentsList()

public ProtocolStringList getBannedContentsList()

Optional. List of banned phrases. Applies to both user inputs and agent responses.

repeated string banned_contents = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the bannedContents.

getDefaultInstanceForType()

public Guardrail.ContentFilter getDefaultInstanceForType()

Returns
Type	Description
`Guardrail.ContentFilter`

getDisregardDiacritics()

public boolean getDisregardDiacritics()

Optional. If true, diacritics are ignored during matching.

bool disregard_diacritics = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The disregardDiacritics.

getMatchType()

public Guardrail.ContentFilter.MatchType getMatchType()

Required. Match type for the content filter.

.google.cloud.ces.v1.Guardrail.ContentFilter.MatchType match_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Guardrail.ContentFilter.MatchType`	The matchType.

getMatchTypeValue()

public int getMatchTypeValue()

Required. Match type for the content filter.

.google.cloud.ces.v1.Guardrail.ContentFilter.MatchType match_type = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The enum numeric value on the wire for matchType.

getParserForType()

public Parser<Guardrail.ContentFilter> getParserForType()

Returns
Type	Description
`Parser<ContentFilter>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Guardrail.ContentFilter.Builder newBuilderForType()

Returns
Type	Description
`Guardrail.ContentFilter.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Guardrail.ContentFilter.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Guardrail.ContentFilter.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Guardrail.ContentFilter.Builder toBuilder()

Returns
Type	Description
`Guardrail.ContentFilter.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`