Class: Google::Cloud::AIPlatform::V1::GroundingChunk

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/content.rb

Overview

Grounding chunk.

Defined Under Namespace

Classes: Maps, RetrievedContext, Web

Instance Attribute Summary collapse

Instance Attribute Details

#maps ⇒ ::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'proto_docs/google/cloud/aiplatform/v1/content.rb', line 752

class GroundingChunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Chunk from the web.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  class Web
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from context retrieved by the retrieval tools.
  # @!attribute [rw] rag_chunk
  #   @return [::Google::Cloud::AIPlatform::V1::RagChunk]
  #     Additional context for the RAG retrieval result. This is only populated
  #     when using the RAG retrieval tool.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the attribution.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the attribution.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the attribution.
  # @!attribute [r] document_name
  #   @return [::String]
  #     Output only. The full document name for the referenced Vertex AI Search
  #     document.
  class RetrievedContext
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from Google Maps.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the chunk.
  # @!attribute [rw] place_id
  #   @return [::String]
  #     This Place's resource name, in `places/{place_id}` format.  Can be used
  #     to look up the Place.
  # @!attribute [rw] place_answer_sources
  #   @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources]
  #     Sources used to generate the place answer.
  #     This includes review snippets and photos that were used to generate the
  #     answer, as well as uris to flag content.
  class Maps
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] review_snippets
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources::ReviewSnippet>]
    #     Snippets of reviews that are used to generate the answer.
    class PlaceAnswerSources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encapsulates a review snippet.
      # @!attribute [rw] review_id
      #   @return [::String]
      #     Id of the review referencing the place.
      # @!attribute [rw] google_maps_uri
      #   @return [::String]
      #     A link to show the review on Google Maps.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the review.
      class ReviewSnippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#retrieved_context ⇒ ::Google::Cloud::AIPlatform::V1::GroundingChunk::RetrievedContext 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'proto_docs/google/cloud/aiplatform/v1/content.rb', line 752

class GroundingChunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Chunk from the web.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  class Web
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from context retrieved by the retrieval tools.
  # @!attribute [rw] rag_chunk
  #   @return [::Google::Cloud::AIPlatform::V1::RagChunk]
  #     Additional context for the RAG retrieval result. This is only populated
  #     when using the RAG retrieval tool.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the attribution.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the attribution.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the attribution.
  # @!attribute [r] document_name
  #   @return [::String]
  #     Output only. The full document name for the referenced Vertex AI Search
  #     document.
  class RetrievedContext
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from Google Maps.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the chunk.
  # @!attribute [rw] place_id
  #   @return [::String]
  #     This Place's resource name, in `places/{place_id}` format.  Can be used
  #     to look up the Place.
  # @!attribute [rw] place_answer_sources
  #   @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources]
  #     Sources used to generate the place answer.
  #     This includes review snippets and photos that were used to generate the
  #     answer, as well as uris to flag content.
  class Maps
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] review_snippets
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources::ReviewSnippet>]
    #     Snippets of reviews that are used to generate the answer.
    class PlaceAnswerSources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encapsulates a review snippet.
      # @!attribute [rw] review_id
      #   @return [::String]
      #     Id of the review referencing the place.
      # @!attribute [rw] google_maps_uri
      #   @return [::String]
      #     A link to show the review on Google Maps.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the review.
      class ReviewSnippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#web ⇒ ::Google::Cloud::AIPlatform::V1::GroundingChunk::Web 



752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'proto_docs/google/cloud/aiplatform/v1/content.rb', line 752

class GroundingChunk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Chunk from the web.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  class Web
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from context retrieved by the retrieval tools.
  # @!attribute [rw] rag_chunk
  #   @return [::Google::Cloud::AIPlatform::V1::RagChunk]
  #     Additional context for the RAG retrieval result. This is only populated
  #     when using the RAG retrieval tool.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the attribution.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the attribution.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the attribution.
  # @!attribute [r] document_name
  #   @return [::String]
  #     Output only. The full document name for the referenced Vertex AI Search
  #     document.
  class RetrievedContext
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Chunk from Google Maps.
  # @!attribute [rw] uri
  #   @return [::String]
  #     URI reference of the chunk.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title of the chunk.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text of the chunk.
  # @!attribute [rw] place_id
  #   @return [::String]
  #     This Place's resource name, in `places/{place_id}` format.  Can be used
  #     to look up the Place.
  # @!attribute [rw] place_answer_sources
  #   @return [::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources]
  #     Sources used to generate the place answer.
  #     This includes review snippets and photos that were used to generate the
  #     answer, as well as uris to flag content.
  class Maps
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] review_snippets
    #   @return [::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk::Maps::PlaceAnswerSources::ReviewSnippet>]
    #     Snippets of reviews that are used to generate the answer.
    class PlaceAnswerSources
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Encapsulates a review snippet.
      # @!attribute [rw] review_id
      #   @return [::String]
      #     Id of the review referencing the place.
      # @!attribute [rw] google_maps_uri
      #   @return [::String]
      #     A link to show the review on Google Maps.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title of the review.
      class ReviewSnippet
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end