Package com.google.cloud.aiplatform.v1beta1

Class VertexRagStore

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.VertexRagStore
All Implemented Interfaces:
VertexRagStoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class VertexRagStore extends com.google.protobuf.GeneratedMessage implements VertexRagStoreOrBuilder
 Retrieve from Vertex RAG Store for grounding.
Protobuf type google.cloud.aiplatform.v1beta1.VertexRagStore
See Also:

  • Field Details

    • RAG_CORPORA_FIELD_NUMBER

      public static final int RAG_CORPORA_FIELD_NUMBER
      See Also:

    • RAG_RESOURCES_FIELD_NUMBER

      public static final int RAG_RESOURCES_FIELD_NUMBER
      See Also:

    • SIMILARITY_TOP_K_FIELD_NUMBER

      public static final int SIMILARITY_TOP_K_FIELD_NUMBER
      See Also:

    • VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER

      public static final int VECTOR_DISTANCE_THRESHOLD_FIELD_NUMBER
      See Also:

    • RAG_RETRIEVAL_CONFIG_FIELD_NUMBER

      public static final int RAG_RETRIEVAL_CONFIG_FIELD_NUMBER
      See Also:

    • STORE_CONTEXT_FIELD_NUMBER

      public static final int STORE_CONTEXT_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

    • getRagCorporaList

      @Deprecated public com.google.protobuf.ProtocolStringList getRagCorporaList()
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=534
       Optional. Deprecated. Please use rag_resources instead.
      repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getRagCorporaList in interface VertexRagStoreOrBuilder
      Returns:
      A list containing the ragCorpora.

    • getRagCorporaCount

      @Deprecated public int getRagCorporaCount()
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=534
       Optional. Deprecated. Please use rag_resources instead.
      repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getRagCorporaCount in interface VertexRagStoreOrBuilder
      Returns:
      The count of ragCorpora.

    • getRagCorpora

      @Deprecated public String getRagCorpora(int index)
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=534
       Optional. Deprecated. Please use rag_resources instead.
      repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getRagCorpora in interface VertexRagStoreOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The ragCorpora at the given index.

    • getRagCorporaBytes

      @Deprecated public com.google.protobuf.ByteString getRagCorporaBytes(int index)
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.rag_corpora is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=534
       Optional. Deprecated. Please use rag_resources instead.
      repeated string rag_corpora = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getRagCorporaBytes in interface VertexRagStoreOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ragCorpora at the given index.

    • 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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesList 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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesOrBuilderList 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.v1beta1.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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResources in interface VertexRagStoreOrBuilder

    • 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.v1beta1.VertexRagStore.RagResource rag_resources = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagResourcesOrBuilder in interface VertexRagStoreOrBuilder

    • hasSimilarityTopK

      @Deprecated public boolean hasSimilarityTopK()
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=550
       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.v1beta1.VertexRagStore.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=550
       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.

    • hasVectorDistanceThreshold

      @Deprecated public boolean hasVectorDistanceThreshold()
      Deprecated.
      google.cloud.aiplatform.v1beta1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=555
       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.v1beta1.VertexRagStore.vector_distance_threshold is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=555
       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.

    • hasRagRetrievalConfig

      public boolean hasRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
      .google.cloud.aiplatform.v1beta1.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.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRagRetrievalConfig in interface VertexRagStoreOrBuilder
      Returns:
      The ragRetrievalConfig.

    • getRagRetrievalConfigOrBuilder

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

    • getStoreContext

      public boolean getStoreContext()
       Optional. Currently only supported for Gemini Multimodal Live API.

 In Gemini Multimodal Live API, if `store_context` bool is
 true, Gemini will leverage it to automatically memorize the
 interactions between the client and Gemini, and retrieve context when
 needed to augment the response generation for users' ongoing and future
 interactions.
      bool store_context = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStoreContext in interface VertexRagStoreOrBuilder
      Returns:
      The storeContext.

    • 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 VertexRagStore parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static VertexRagStore parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexRagStore parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VertexRagStore parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static VertexRagStore parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexRagStore parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static VertexRagStore parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static VertexRagStore.Builder newBuilder()

    • newBuilder

      public static VertexRagStore.Builder newBuilder(VertexRagStore prototype)

    • toBuilder

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

    • newBuilderForType

      protected VertexRagStore.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static VertexRagStore getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<VertexRagStore> 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 VertexRagStore getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder