Package com.google.cloud.aiplatform.v1

Class GroundingChunk.RetrievedContext

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext
All Implemented Interfaces:
GroundingChunk.RetrievedContextOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
GroundingChunk
public static final class GroundingChunk.RetrievedContext extends com.google.protobuf.GeneratedMessage implements GroundingChunk.RetrievedContextOrBuilder
 Chunk from context retrieved by the retrieval tools.
Protobuf type google.cloud.aiplatform.v1.GroundingChunk.RetrievedContext
See Also:

  • Field Details

  • 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

    • getContextDetailsCase

      public GroundingChunk.RetrievedContext.ContextDetailsCase getContextDetailsCase()
      Specified by:
      getContextDetailsCase in interface GroundingChunk.RetrievedContextOrBuilder

    • hasRagChunk

      public boolean hasRagChunk()
       Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
      .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
      Specified by:
      hasRagChunk in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      Whether the ragChunk field is set.

    • getRagChunk

      public RagChunk getRagChunk()
       Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
      .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
      Specified by:
      getRagChunk in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The ragChunk.

    • getRagChunkOrBuilder

      public RagChunkOrBuilder getRagChunkOrBuilder()
       Additional context for the RAG retrieval result. This is only populated
 when using the RAG retrieval tool.
      .google.cloud.aiplatform.v1.RagChunk rag_chunk = 4;
      Specified by:
      getRagChunkOrBuilder in interface GroundingChunk.RetrievedContextOrBuilder

    • hasUri

      public boolean hasUri()
       URI reference of the attribution.
      optional string uri = 1;
      Specified by:
      hasUri in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      Whether the uri field is set.

    • getUri

      public String getUri()
       URI reference of the attribution.
      optional string uri = 1;
      Specified by:
      getUri in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.ByteString getUriBytes()
       URI reference of the attribution.
      optional string uri = 1;
      Specified by:
      getUriBytes in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The bytes for uri.

    • hasTitle

      public boolean hasTitle()
       Title of the attribution.
      optional string title = 2;
      Specified by:
      hasTitle in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      Whether the title field is set.

    • getTitle

      public String getTitle()
       Title of the attribution.
      optional string title = 2;
      Specified by:
      getTitle in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       Title of the attribution.
      optional string title = 2;
      Specified by:
      getTitleBytes in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The bytes for title.

    • hasText

      public boolean hasText()
       Text of the attribution.
      optional string text = 3;
      Specified by:
      hasText in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       Text of the attribution.
      optional string text = 3;
      Specified by:
      getText in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       Text of the attribution.
      optional string text = 3;
      Specified by:
      getTextBytes in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The bytes for text.

    • hasDocumentName

      public boolean hasDocumentName()
       Output only. The full document name for the referenced Vertex AI Search
 document.
      optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDocumentName in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      Whether the documentName field is set.

    • getDocumentName

      public String getDocumentName()
       Output only. The full document name for the referenced Vertex AI Search
 document.
      optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDocumentName in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The documentName.

    • getDocumentNameBytes

      public com.google.protobuf.ByteString getDocumentNameBytes()
       Output only. The full document name for the referenced Vertex AI Search
 document.
      optional string document_name = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDocumentNameBytes in interface GroundingChunk.RetrievedContextOrBuilder
      Returns:
      The bytes for documentName.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static GroundingChunk.RetrievedContext parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static GroundingChunk.RetrievedContext parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GroundingChunk.RetrievedContext.Builder newBuilder()

    • newBuilder

      public static GroundingChunk.RetrievedContext.Builder newBuilder(GroundingChunk.RetrievedContext prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GroundingChunk.RetrievedContext getDefaultInstance()

    • parser

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

    • getParserForType

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