Package com.google.cloud.aiplatform.v1beta1

Interface RagQueryOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RagQuery, RagQuery.Builder
@Generated public interface RagQueryOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasText

      boolean hasText()
       Optional. The query in text format to get relevant contexts.
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the text field is set.

    • getText

      String getText()
       Optional. The query in text format to get relevant contexts.
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The text.

    • getTextBytes

      com.google.protobuf.ByteString getTextBytes()
       Optional. The query in text format to get relevant contexts.
      string text = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for text.

    • getSimilarityTopK

      @Deprecated int getSimilarityTopK()
      Deprecated.
      google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=117
       Optional. The number of contexts to retrieve.
      int32 similarity_top_k = 2 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The similarityTopK.

    • hasRanking

      @Deprecated boolean hasRanking()
      Deprecated.
      google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=121
       Optional. Configurations for hybrid search results ranking.
      .google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the ranking field is set.

    • getRanking

      @Deprecated RagQuery.Ranking getRanking()
      Deprecated.
      google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=121
       Optional. Configurations for hybrid search results ranking.
      .google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ranking.

    • getRankingOrBuilder

      @Deprecated RagQuery.RankingOrBuilder getRankingOrBuilder()
      Deprecated.
       Optional. Configurations for hybrid search results ranking.
      .google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

    • hasRagRetrievalConfig

      boolean hasRagRetrievalConfig()
       Optional. The retrieval config for the 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 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 query.
      .google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getQueryCase

      RagQuery.QueryCase getQueryCase()