Package com.google.cloud.aiplatform.v1

Class Retrieval

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Retrieval
All Implemented Interfaces:
RetrievalOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Retrieval extends com.google.protobuf.GeneratedMessage implements RetrievalOrBuilder
 Defines a retrieval tool that model can call to access external knowledge.
Protobuf type google.cloud.aiplatform.v1.Retrieval
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Retrieval.Builder
    Defines a retrieval tool that model can call to access external knowledge.
    static enum 
    Retrieval.SourceCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DISABLE_ATTRIBUTION_FIELD_NUMBER
     
    static final int
    VERTEX_AI_SEARCH_FIELD_NUMBER
     
    static final int
    VERTEX_RAG_STORE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Retrieval
    getDefaultInstance()
     
    Retrieval
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisableAttribution()
    Deprecated.
    google.cloud.aiplatform.v1.Retrieval.disable_attribution is deprecated.
    com.google.protobuf.Parser<Retrieval>
    getParserForType()
     
    int
    getSerializedSize()
     
    Retrieval.SourceCase
    getSourceCase()
     
    VertexAISearch
    getVertexAiSearch()
    Set to use data source powered by Vertex AI Search.
    VertexAISearchOrBuilder
    getVertexAiSearchOrBuilder()
    Set to use data source powered by Vertex AI Search.
    VertexRagStore
    getVertexRagStore()
    Set to use data source powered by Vertex RAG store.
    VertexRagStoreOrBuilder
    getVertexRagStoreOrBuilder()
    Set to use data source powered by Vertex RAG store.
    int
    hashCode()
     
    boolean
    hasVertexAiSearch()
    Set to use data source powered by Vertex AI Search.
    boolean
    hasVertexRagStore()
    Set to use data source powered by Vertex RAG store.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Retrieval.Builder
    newBuilder()
     
    static Retrieval.Builder
    newBuilder(Retrieval prototype)
     
    Retrieval.Builder
    newBuilderForType()
     
    protected Retrieval.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Retrieval
    parseDelimitedFrom(InputStream input)
     
    static Retrieval
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Retrieval
    parseFrom(byte[] data)
     
    static Retrieval
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Retrieval
    parseFrom(com.google.protobuf.ByteString data)
     
    static Retrieval
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Retrieval
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Retrieval
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Retrieval
    parseFrom(InputStream input)
     
    static Retrieval
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Retrieval
    parseFrom(ByteBuffer data)
     
    static Retrieval
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Retrieval>
    parser()
     
    Retrieval.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • VERTEX_AI_SEARCH_FIELD_NUMBER

      public static final int VERTEX_AI_SEARCH_FIELD_NUMBER
      See Also:

    • VERTEX_RAG_STORE_FIELD_NUMBER

      public static final int VERTEX_RAG_STORE_FIELD_NUMBER
      See Also:

    • DISABLE_ATTRIBUTION_FIELD_NUMBER

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

    • getSourceCase

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

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

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Retrieval.Builder newBuilder()

    • newBuilder

      public static Retrieval.Builder newBuilder(Retrieval prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Retrieval getDefaultInstance()

    • parser

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

    • getParserForType

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