Package com.google.cloud.aiplatform.v1

Class RagRetrievalConfig.Filter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.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.GeneratedMessage implements RagRetrievalConfig.FilterOrBuilder
 Config for filters.
Protobuf type google.cloud.aiplatform.v1.RagRetrievalConfig.Filter
See Also:

  • Field Details

    • VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

      public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER
      See Also:

    • VECTOR_SIMILARITY_THRESHOLD_FIELD_NUMBER

      public static final int VECTOR_SIMILARITY_THRESHOLD_FIELD_NUMBER
      See Also:

    • METADATA_FILTER_FIELD_NUMBER

      public static final int METADATA_FILTER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public RagRetrievalConfig.Filter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder