Interface VertexRagStoreOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
VertexRagStore, VertexRagStore.Builder

@Generated public interface VertexRagStoreOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getRagCorporaList

      @Deprecated List<String> 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) = { ... }
      Returns:
      A list containing the ragCorpora.
    • getRagCorporaCount

      @Deprecated 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) = { ... }
      Returns:
      The count of ragCorpora.
    • getRagCorpora

      @Deprecated 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) = { ... }
      Parameters:
      index - The index of the element to return.
      Returns:
      The ragCorpora at the given index.
    • getRagCorporaBytes

      @Deprecated 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) = { ... }
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ragCorpora at the given index.
    • getRagResourcesList

      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];
    • getRagResources

      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];
    • getRagResourcesCount

      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];
    • getRagResourcesOrBuilderList

      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];
    • getRagResourcesOrBuilder

      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];
    • hasSimilarityTopK

      @Deprecated 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];
      Returns:
      Whether the similarityTopK field is set.
    • getSimilarityTopK

      @Deprecated 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];
      Returns:
      The similarityTopK.
    • hasVectorDistanceThreshold

      @Deprecated 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];
      Returns:
      Whether the vectorDistanceThreshold field is set.
    • getVectorDistanceThreshold

      @Deprecated 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];
      Returns:
      The vectorDistanceThreshold.
    • hasRagRetrievalConfig

      boolean hasRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
       
      .google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the ragRetrievalConfig field is set.
    • getRagRetrievalConfig

      RagRetrievalConfig getRagRetrievalConfig()
       Optional. The retrieval config for the Rag query.
       
      .google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ragRetrievalConfig.
    • getRagRetrievalConfigOrBuilder

      RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()
       Optional. The retrieval config for the Rag query.
       
      .google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];
    • getStoreContext

      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];
      Returns:
      The storeContext.