Package com.google.cloud.aiplatform.v1

Class VertexRagStore.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<VertexRagStore.Builder>
com.google.cloud.aiplatform.v1.VertexRagStore.Builder
All Implemented Interfaces:
VertexRagStoreOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
VertexRagStore
public static final class VertexRagStore.Builder extends com.google.protobuf.GeneratedMessage.Builder<VertexRagStore.Builder> implements VertexRagStoreOrBuilder
 Retrieve from Vertex RAG Store for grounding.
Protobuf type google.cloud.aiplatform.v1.VertexRagStore

  • 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.Builder<VertexRagStore.Builder>

    • clear

      public VertexRagStore.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<VertexRagStore.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<VertexRagStore.Builder>

    • getDefaultInstanceForType

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

    • build

      public VertexRagStore build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public VertexRagStore buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public VertexRagStore.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexRagStore.Builder>

    • mergeFrom

      public VertexRagStore.Builder mergeFrom(VertexRagStore other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<VertexRagStore.Builder>

    • mergeFrom

      public VertexRagStore.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<VertexRagStore.Builder>
      Throws:
      IOException

    • getRagResourcesList

      public List<VertexRagStore.RagResource> getRagResourcesList()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesList in interface VertexRagStoreOrBuilder

    • getRagResourcesCount

      public int getRagResourcesCount()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesCount in interface VertexRagStoreOrBuilder

    • getRagResources

      public VertexRagStore.RagResource getRagResources(int index)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResources in interface VertexRagStoreOrBuilder

    • setRagResources

      public VertexRagStore.Builder setRagResources(int index, VertexRagStore.RagResource value)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • setRagResources

      public VertexRagStore.Builder setRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addRagResources

      public VertexRagStore.Builder addRagResources(VertexRagStore.RagResource value)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addRagResources

      public VertexRagStore.Builder addRagResources(int index, VertexRagStore.RagResource value)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addRagResources

      public VertexRagStore.Builder addRagResources(VertexRagStore.RagResource.Builder builderForValue)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addRagResources

      public VertexRagStore.Builder addRagResources(int index, VertexRagStore.RagResource.Builder builderForValue)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addAllRagResources

      public VertexRagStore.Builder addAllRagResources(Iterable<? extends VertexRagStore.RagResource> values)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • clearRagResources

      public VertexRagStore.Builder clearRagResources()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • removeRagResources

      public VertexRagStore.Builder removeRagResources(int index)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getRagResourcesBuilder

      public VertexRagStore.RagResource.Builder getRagResourcesBuilder(int index)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getRagResourcesOrBuilder

      public VertexRagStore.RagResourceOrBuilder getRagResourcesOrBuilder(int index)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesOrBuilder in interface VertexRagStoreOrBuilder

    • getRagResourcesOrBuilderList

      public List<? extends VertexRagStore.RagResourceOrBuilder> getRagResourcesOrBuilderList()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesOrBuilderList in interface VertexRagStoreOrBuilder

    • addRagResourcesBuilder

      public VertexRagStore.RagResource.Builder addRagResourcesBuilder()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • addRagResourcesBuilder

      public VertexRagStore.RagResource.Builder addRagResourcesBuilder(int index)
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getRagResourcesBuilderList

      public List<VertexRagStore.RagResource.Builder> getRagResourcesBuilderList()
       Optional. The representation of the rag source. It can be used to specify
 corpus only or ragfiles. Currently only support one corpus or multiple
 files from one corpus. In the future we may open up multiple corpora
 support.
      repeated .google.cloud.aiplatform.v1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];

    • hasSimilarityTopK

      @Deprecated public boolean hasSimilarityTopK()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=494
       Optional. Number of top k results to return from the selected corpora.
      optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSimilarityTopK in interface VertexRagStoreOrBuilder
      Returns:
      Whether the similarityTopK field is set.

    • getSimilarityTopK

      @Deprecated public int getSimilarityTopK()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=494
       Optional. Number of top k results to return from the selected corpora.
      optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSimilarityTopK in interface VertexRagStoreOrBuilder
      Returns:
      The similarityTopK.

    • setSimilarityTopK

      @Deprecated public VertexRagStore.Builder setSimilarityTopK(int value)
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=494
       Optional. Number of top k results to return from the selected corpora.
      optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The similarityTopK to set.
      Returns:
      This builder for chaining.

    • clearSimilarityTopK

      @Deprecated public VertexRagStore.Builder clearSimilarityTopK()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=494
       Optional. Number of top k results to return from the selected corpora.
      optional int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasVectorDistanceThreshold

      @Deprecated public boolean hasVectorDistanceThreshold()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
       Optional. Only return results with vector distance smaller than the
 threshold.
      optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasVectorDistanceThreshold in interface VertexRagStoreOrBuilder
      Returns:
      Whether the vectorDistanceThreshold field is set.

    • getVectorDistanceThreshold

      @Deprecated public double getVectorDistanceThreshold()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
       Optional. Only return results with vector distance smaller than the
 threshold.
      optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getVectorDistanceThreshold in interface VertexRagStoreOrBuilder
      Returns:
      The vectorDistanceThreshold.

    • setVectorDistanceThreshold

      @Deprecated public VertexRagStore.Builder setVectorDistanceThreshold(double value)
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
       Optional. Only return results with vector distance smaller than the
 threshold.
      optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The vectorDistanceThreshold to set.
      Returns:
      This builder for chaining.

    • clearVectorDistanceThreshold

      @Deprecated public VertexRagStore.Builder clearVectorDistanceThreshold()
      Deprecated.
      google.cloud.aiplatform.v1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=499
       Optional. Only return results with vector distance smaller than the
 threshold.
      optional double vector_distance_threshold = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasRagRetrievalConfig

      public boolean hasRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRagRetrievalConfig in interface VertexRagStoreOrBuilder
      Returns:
      Whether the ragRetrievalConfig field is set.

    • getRagRetrievalConfig

      public RagRetrievalConfig getRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagRetrievalConfig in interface VertexRagStoreOrBuilder
      Returns:
      The ragRetrievalConfig.

    • setRagRetrievalConfig

      public VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig value)
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setRagRetrievalConfig

      public VertexRagStore.Builder setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeRagRetrievalConfig

      public VertexRagStore.Builder mergeRagRetrievalConfig(RagRetrievalConfig value)
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearRagRetrievalConfig

      public VertexRagStore.Builder clearRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getRagRetrievalConfigBuilder

      public RagRetrievalConfig.Builder getRagRetrievalConfigBuilder()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getRagRetrievalConfigOrBuilder

      public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagRetrievalConfigOrBuilder in interface VertexRagStoreOrBuilder