com.google.cloud.vertexai.api

Class RagRetrievalConfig.Filter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vertexai.api.RagRetrievalConfig.Filter

All Implemented Interfaces:

RagRetrievalConfig.FilterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

RagRetrievalConfig

public static final class RagRetrievalConfig.Filter
extends com.google.protobuf.GeneratedMessageV3
implements RagRetrievalConfig.FilterOrBuilder

 Config for filters.
 

Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig.Filter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RagRetrievalConfig.Filter.Builder Config for filters.
static class	RagRetrievalConfig.Filter.VectorDbThresholdCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	METADATA_FILTER_FIELD_NUMBER
static int	VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER
static int	VECTOR_SIMILARITY_THRESHOLD_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static RagRetrievalConfig.Filter	getDefaultInstance()
RagRetrievalConfig.Filter	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMetadataFilter() Optional.
com.google.protobuf.ByteString	getMetadataFilterBytes() Optional.
com.google.protobuf.Parser<RagRetrievalConfig.Filter>	getParserForType()
int	getSerializedSize()
RagRetrievalConfig.Filter.VectorDbThresholdCase	getVectorDbThresholdCase()
double	getVectorDistanceThreshold() Optional.
double	getVectorSimilarityThreshold() Optional.
int	hashCode()
boolean	hasVectorDistanceThreshold() Optional.
boolean	hasVectorSimilarityThreshold() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RagRetrievalConfig.Filter.Builder	newBuilder()
static RagRetrievalConfig.Filter.Builder	newBuilder(RagRetrievalConfig.Filter prototype)
RagRetrievalConfig.Filter.Builder	newBuilderForType()
protected RagRetrievalConfig.Filter.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RagRetrievalConfig.Filter	parseDelimitedFrom(InputStream input)
static RagRetrievalConfig.Filter	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagRetrievalConfig.Filter	parseFrom(byte[] data)
static RagRetrievalConfig.Filter	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagRetrievalConfig.Filter	parseFrom(ByteBuffer data)
static RagRetrievalConfig.Filter	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagRetrievalConfig.Filter	parseFrom(com.google.protobuf.ByteString data)
static RagRetrievalConfig.Filter	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagRetrievalConfig.Filter	parseFrom(com.google.protobuf.CodedInputStream input)
static RagRetrievalConfig.Filter	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagRetrievalConfig.Filter	parseFrom(InputStream input)
static RagRetrievalConfig.Filter	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RagRetrievalConfig.Filter>	parser()
RagRetrievalConfig.Filter.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

VECTOR_SIMILARITY_THRESHOLD_FIELD_NUMBER

public static final int VECTOR_SIMILARITY_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FILTER_FIELD_NUMBER

public static final int METADATA_FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getVectorDbThresholdCase

public RagRetrievalConfig.Filter.VectorDbThresholdCase getVectorDbThresholdCase()

Specified by:

getVectorDbThresholdCase in interface RagRetrievalConfig.FilterOrBuilder

hasVectorDistanceThreshold

public boolean hasVectorDistanceThreshold()

 Optional. Only returns contexts with vector distance smaller than the
 threshold.
 

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasVectorDistanceThreshold in interface RagRetrievalConfig.FilterOrBuilder

Returns:

Whether the vectorDistanceThreshold field is set.

getVectorDistanceThreshold

public double getVectorDistanceThreshold()

 Optional. Only returns contexts with vector distance smaller than the
 threshold.
 

double vector_distance_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getVectorDistanceThreshold in interface RagRetrievalConfig.FilterOrBuilder

Returns:

The vectorDistanceThreshold.

hasVectorSimilarityThreshold

public boolean hasVectorSimilarityThreshold()

 Optional. Only returns contexts with vector similarity larger than the
 threshold.
 

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasVectorSimilarityThreshold in interface RagRetrievalConfig.FilterOrBuilder

Returns:

Whether the vectorSimilarityThreshold field is set.

getVectorSimilarityThreshold

public double getVectorSimilarityThreshold()

 Optional. Only returns contexts with vector similarity larger than the
 threshold.
 

double vector_similarity_threshold = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getVectorSimilarityThreshold in interface RagRetrievalConfig.FilterOrBuilder

Returns:

The vectorSimilarityThreshold.

getMetadataFilter

public String getMetadataFilter()

 Optional. String for metadata filtering.
 

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

Specified by:

getMetadataFilter in interface RagRetrievalConfig.FilterOrBuilder

Returns:

The metadataFilter.

getMetadataFilterBytes

public com.google.protobuf.ByteString getMetadataFilterBytes()

 Optional. String for metadata filtering.
 

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

Specified by:

getMetadataFilterBytes in interface RagRetrievalConfig.FilterOrBuilder

Returns:

The bytes for metadataFilter.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RagRetrievalConfig.Filter parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagRetrievalConfig.Filter parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagRetrievalConfig.Filter parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static RagRetrievalConfig.Filter parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public RagRetrievalConfig.Filter.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RagRetrievalConfig.Filter.Builder newBuilder()

newBuilder

public static RagRetrievalConfig.Filter.Builder newBuilder(RagRetrievalConfig.Filter prototype)

toBuilder

public RagRetrievalConfig.Filter.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RagRetrievalConfig.Filter.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RagRetrievalConfig.Filter getDefaultInstance()

parser

public static com.google.protobuf.Parser<RagRetrievalConfig.Filter> parser()

getParserForType

public com.google.protobuf.Parser<RagRetrievalConfig.Filter> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RagRetrievalConfig.Filter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder