Class: Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary

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

Overview

Summary of the top N search result specified by the summary spec.

Defined Under Namespace

Modules: SummarySkippedReason Classes: SafetyAttributes

Instance Attribute Summary collapse

Instance Attribute Details

#safety_attributes ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SafetyAttributes

Returns A collection of Safety Attribute categories and their associated confidence scores.

Returns:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 654

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

  # Safety Attribute categories and their associated confidence scores.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     The display names of Safety Attribute categories associated with the
  #     generated content. Order matches the Scores.
  # @!attribute [rw] scores
  #   @return [::Array<::Float>]
  #     The confidence scores of the each category, higher
  #     value means higher confidence. Order matches the Categories.
  class SafetyAttributes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An Enum for summary-skipped reasons.
  module SummarySkippedReason
    # Default value. The summary skipped reason is not specified.
    SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

    # The adversarial query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
    # is set to `true`.
    ADVERSARIAL_QUERY_IGNORED = 1

    # The non-summary seeking query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
    # is set to `true`.
    NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

    # The out-of-domain query ignored case.
    #
    # Google skips the summary if there are no high-relevance search results.
    # For example, the data store contains facts about company A but the
    # user query is asking questions about company B.
    OUT_OF_DOMAIN_QUERY_IGNORED = 3

    # The potential policy violation case.
    #
    # Google skips the summary if there is a potential policy violation
    # detected. This includes content that may be violent or toxic.
    POTENTIAL_POLICY_VIOLATION = 4

    # The LLM addon not enabled case.
    #
    # Google skips the summary if the LLM addon is not enabled.
    LLM_ADDON_NOT_ENABLED = 5
  end
end

#summary_skipped_reasons ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Summary::SummarySkippedReason>

Returns Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

Returns:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 654

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

  # Safety Attribute categories and their associated confidence scores.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     The display names of Safety Attribute categories associated with the
  #     generated content. Order matches the Scores.
  # @!attribute [rw] scores
  #   @return [::Array<::Float>]
  #     The confidence scores of the each category, higher
  #     value means higher confidence. Order matches the Categories.
  class SafetyAttributes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An Enum for summary-skipped reasons.
  module SummarySkippedReason
    # Default value. The summary skipped reason is not specified.
    SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

    # The adversarial query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
    # is set to `true`.
    ADVERSARIAL_QUERY_IGNORED = 1

    # The non-summary seeking query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
    # is set to `true`.
    NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

    # The out-of-domain query ignored case.
    #
    # Google skips the summary if there are no high-relevance search results.
    # For example, the data store contains facts about company A but the
    # user query is asking questions about company B.
    OUT_OF_DOMAIN_QUERY_IGNORED = 3

    # The potential policy violation case.
    #
    # Google skips the summary if there is a potential policy violation
    # detected. This includes content that may be violent or toxic.
    POTENTIAL_POLICY_VIOLATION = 4

    # The LLM addon not enabled case.
    #
    # Google skips the summary if the LLM addon is not enabled.
    LLM_ADDON_NOT_ENABLED = 5
  end
end

#summary_text ⇒ ::String

Returns The summary content.

Returns:

  • (::String) —

    The summary content.



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 654

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

  # Safety Attribute categories and their associated confidence scores.
  # @!attribute [rw] categories
  #   @return [::Array<::String>]
  #     The display names of Safety Attribute categories associated with the
  #     generated content. Order matches the Scores.
  # @!attribute [rw] scores
  #   @return [::Array<::Float>]
  #     The confidence scores of the each category, higher
  #     value means higher confidence. Order matches the Categories.
  class SafetyAttributes
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # An Enum for summary-skipped reasons.
  module SummarySkippedReason
    # Default value. The summary skipped reason is not specified.
    SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

    # The adversarial query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
    # is set to `true`.
    ADVERSARIAL_QUERY_IGNORED = 1

    # The non-summary seeking query ignored case.
    #
    # Only populated when
    # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
    # is set to `true`.
    NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

    # The out-of-domain query ignored case.
    #
    # Google skips the summary if there are no high-relevance search results.
    # For example, the data store contains facts about company A but the
    # user query is asking questions about company B.
    OUT_OF_DOMAIN_QUERY_IGNORED = 3

    # The potential policy violation case.
    #
    # Google skips the summary if there is a potential policy violation
    # detected. This includes content that may be violent or toxic.
    POTENTIAL_POLICY_VIOLATION = 4

    # The LLM addon not enabled case.
    #
    # Google skips the summary if the LLM addon is not enabled.
    LLM_ADDON_NOT_ENABLED = 5
  end
end