Package com.google.cloud.aiplatform.v1

Class Retrieval.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Retrieval.Builder>
com.google.cloud.aiplatform.v1.Retrieval.Builder
All Implemented Interfaces:
RetrievalOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Retrieval
public static final class Retrieval.Builder extends com.google.protobuf.GeneratedMessage.Builder<Retrieval.Builder> implements RetrievalOrBuilder
 Defines a retrieval tool that model can call to access external knowledge.
Protobuf type google.cloud.aiplatform.v1.Retrieval

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

    • clear

      public Retrieval.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<Retrieval.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<Retrieval.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Retrieval.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<Retrieval.Builder>

    • mergeFrom

      public Retrieval.Builder mergeFrom(Retrieval other)

    • isInitialized

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

    • mergeFrom

      public Retrieval.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<Retrieval.Builder>
      Throws:
      IOException

    • getSourceCase

      public Retrieval.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface RetrievalOrBuilder

    • clearSource

      public Retrieval.Builder clearSource()

    • hasVertexAiSearch

      public boolean hasVertexAiSearch()
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;
      Specified by:
      hasVertexAiSearch in interface RetrievalOrBuilder
      Returns:
      Whether the vertexAiSearch field is set.

    • getVertexAiSearch

      public VertexAISearch getVertexAiSearch()
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;
      Specified by:
      getVertexAiSearch in interface RetrievalOrBuilder
      Returns:
      The vertexAiSearch.

    • setVertexAiSearch

      public Retrieval.Builder setVertexAiSearch(VertexAISearch value)
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;

    • setVertexAiSearch

      public Retrieval.Builder setVertexAiSearch(VertexAISearch.Builder builderForValue)
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;

    • mergeVertexAiSearch

      public Retrieval.Builder mergeVertexAiSearch(VertexAISearch value)
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;

    • clearVertexAiSearch

      public Retrieval.Builder clearVertexAiSearch()
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;

    • getVertexAiSearchBuilder

      public VertexAISearch.Builder getVertexAiSearchBuilder()
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;

    • getVertexAiSearchOrBuilder

      public VertexAISearchOrBuilder getVertexAiSearchOrBuilder()
       Set to use data source powered by Vertex AI Search.
      .google.cloud.aiplatform.v1.VertexAISearch vertex_ai_search = 2;
      Specified by:
      getVertexAiSearchOrBuilder in interface RetrievalOrBuilder

    • hasVertexRagStore

      public boolean hasVertexRagStore()
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;
      Specified by:
      hasVertexRagStore in interface RetrievalOrBuilder
      Returns:
      Whether the vertexRagStore field is set.

    • getVertexRagStore

      public VertexRagStore getVertexRagStore()
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;
      Specified by:
      getVertexRagStore in interface RetrievalOrBuilder
      Returns:
      The vertexRagStore.

    • setVertexRagStore

      public Retrieval.Builder setVertexRagStore(VertexRagStore value)
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;

    • setVertexRagStore

      public Retrieval.Builder setVertexRagStore(VertexRagStore.Builder builderForValue)
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;

    • mergeVertexRagStore

      public Retrieval.Builder mergeVertexRagStore(VertexRagStore value)
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;

    • clearVertexRagStore

      public Retrieval.Builder clearVertexRagStore()
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;

    • getVertexRagStoreBuilder

      public VertexRagStore.Builder getVertexRagStoreBuilder()
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;

    • getVertexRagStoreOrBuilder

      public VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()
       Set to use data source powered by Vertex RAG store.
 User data is uploaded via the VertexRagDataService.
      .google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4;
      Specified by:
      getVertexRagStoreOrBuilder in interface RetrievalOrBuilder

    • getDisableAttribution

      @Deprecated public boolean getDisableAttribution()
      Deprecated.
      google.cloud.aiplatform.v1.Retrieval.disable_attribution is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=463
       Optional. Deprecated. This option is no longer supported.
      bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDisableAttribution in interface RetrievalOrBuilder
      Returns:
      The disableAttribution.

    • setDisableAttribution

      @Deprecated public Retrieval.Builder setDisableAttribution(boolean value)
      Deprecated.
      google.cloud.aiplatform.v1.Retrieval.disable_attribution is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=463
       Optional. Deprecated. This option is no longer supported.
      bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The disableAttribution to set.
      Returns:
      This builder for chaining.

    • clearDisableAttribution

      @Deprecated public Retrieval.Builder clearDisableAttribution()
      Deprecated.
      google.cloud.aiplatform.v1.Retrieval.disable_attribution is deprecated. See google/cloud/aiplatform/v1/tool.proto;l=463
       Optional. Deprecated. This option is no longer supported.
      bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.