Class: Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/conversation.rb

Overview

The request message for Conversations.SearchKnowledge.

Defined Under Namespace

Modules: QuerySource Classes: SearchConfig

Instance Attribute Summary collapse

Instance Attribute Details

#conversation ⇒ ::String

Returns Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Returns:

  • (::String) —

    Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#conversation_profile ⇒ ::String

Returns Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

Returns:

  • (::String) —

    Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#end_user_metadata ⇒ ::Google::Protobuf::Struct

Returns Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

{
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    \\{"model": "Google Pixel 7"},
    \\{"model": "Google Pixel Tablet"}
  ]
}
```.

Returns:

  • (::Google::Protobuf::Struct) —

    Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

    This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

    Example:

    {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    \\{"model": "Google Pixel 7"},
    \\{"model": "Google Pixel Tablet"}
  ]
}



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#exact_search ⇒ ::Boolean

Returns Optional. Whether to search the query exactly without query rewrite.

Returns:

  • (::Boolean) —

    Optional. Whether to search the query exactly without query rewrite.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#latest_message ⇒ ::String

Returns Optional. The name of the latest conversation message when the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

Returns:

  • (::String) —

    Optional. The name of the latest conversation message when the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#parent ⇒ ::String

Returns Required. The parent resource contains the conversation profile Format: 'projects/' or projects/<Project ID>/locations/<Location ID>.

Returns:

  • (::String) —

    Required. The parent resource contains the conversation profile Format: 'projects/' or projects/<Project ID>/locations/<Location ID>.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#query ⇒ ::Google::Cloud::Dialogflow::V2::TextInput

Returns Required. The natural language text query for knowledge search.

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#query_source ⇒ ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::QuerySource

Returns Optional. The source of the query in the request.

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#search_config ⇒ ::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig

Returns Optional. Configuration specific to search queries with data stores.

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end

#session_id ⇒ ::String

Returns Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.

Returns:

  • (::String) —

    Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
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
710
711
712
713
714
715
716
717
718
719
720
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 531

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

  # Configuration specific to search queries with data stores.
  # @!attribute [rw] boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs>]
  #     Optional. Boost specifications for data stores.
  # @!attribute [rw] filter_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::FilterSpecs>]
  #     Optional. Filter specification for data store queries.
  class SearchConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Boost specifications for data stores.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. Data Stores where the boosting configuration is applied. The
    #     full names of the referenced data stores. Formats:
    #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
    #     `projects/{project}/locations/{location}/dataStores/{data_store}`
    # @!attribute [rw] spec
    #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec>]
    #     Optional. A list of boosting specifications.
    class BoostSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Boost specification to boost certain documents.
      # A copy of google.cloud.discoveryengine.v1main.BoostSpec, field
      # documentation is available at
      # https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec
      # @!attribute [rw] condition_boost_specs
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
      #     Optional. Condition boost specifications. If a document matches
      #     multiple conditions in the specifictions, boost scores from these
      #     specifications are all applied and combined in a non-linear way.
      #     Maximum number of specifications is 20.
      class BoostSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # Boost applies to documents which match a condition.
        # @!attribute [rw] condition
        #   @return [::String]
        #     Optional. An expression which specifies a boost condition. The
        #     syntax and supported fields are the same as a filter expression.
        #     Examples:
        #
        #     * To boost documents with document ID "doc_1" or "doc_2", and
        #     color
        #       "Red" or "Blue":
        #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
        # @!attribute [rw] boost
        #   @return [::Float]
        #     Optional. Strength of the condition boost, which should be in [-1,
        #     1]. Negative boost means demotion. Default is 0.0.
        #
        #     Setting to 1.0 gives the document a big promotion. However, it does
        #     not necessarily mean that the boosted document will be the top
        #     result at all times, nor that other documents will be excluded.
        #     Results could still be shown even when none of them matches the
        #     condition. And results that are significantly more relevant to the
        #     search query can still trump your heavily favored but irrelevant
        #     documents.
        #
        #     Setting to -1.0 gives the document a big demotion. However, results
        #     that are deeply relevant might still be shown. The document will
        #     have an upstream battle to get a fairly high ranking, but it is not
        #     blocked out completely.
        #
        #     Setting to 0.0 means no boost applied. The boosting condition is
        #     ignored.
        # @!attribute [rw] boost_control_spec
        #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
        #     Optional. Complex specification for custom ranking based on
        #     customer defined attribute value.
        class ConditionBoostSpec
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods

          # Specification for custom ranking based on customer specified
          # attribute
          # value. It provides more controls for customized ranking than the
          # simple (condition, boost) combination above.
          # @!attribute [rw] field_name
          #   @return [::String]
          #     Optional. The name of the field whose value will be used to
          #     determine the boost amount.
          # @!attribute [rw] attribute_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
          #     Optional. The attribute type to be used to determine the boost
          #     amount. The attribute value can be derived from the field value
          #     of the specified field_name. In the case of numerical it is
          #     straightforward i.e. attribute_value = numerical_field_value. In
          #     the case of freshness however, attribute_value = (time.now() -
          #     datetime_field_value).
          # @!attribute [rw] interpolation_type
          #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
          #     Optional. The interpolation type to be applied to connect the
          #     control points listed below.
          # @!attribute [rw] control_points
          #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
          #     Optional. The control points used to define the curve. The
          #     monotonic function (defined through the interpolation_type above)
          #     passes through the control points listed here.
          class BoostControlSpec
            include ::Google::Protobuf::MessageExts
            extend ::Google::Protobuf::MessageExts::ClassMethods

            # The control points used to define the curve. The curve defined
            # through these control points can only be monotonically increasing
            # or decreasing(constant values are acceptable).
            class ControlPoint
              include ::Google::Protobuf::MessageExts
              extend ::Google::Protobuf::MessageExts::ClassMethods
            end

            # The attribute(or function) for which the custom ranking is to be
            # applied.
            module AttributeType
              # Unspecified AttributeType.
              ATTRIBUTE_TYPE_UNSPECIFIED = 0

              # The value of the numerical field will be used to dynamically
              # update the boost amount. In this case, the attribute_value (the
              # x value) of the control point will be the actual value of the
              # numerical field for which the boost_amount is specified.
              NUMERICAL = 1

              # For the freshness use case the attribute value will be the
              # duration between the current time and the date in the datetime
              # field specified. The value must be formatted as an XSD
              # `dayTimeDuration` value (a restricted subset of an ISO 8601
              # duration value). The pattern for this is:
              # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
              FRESHNESS = 2
            end

            # The interpolation type to be applied. Default will be linear
            # (Piecewise Linear).
            module InterpolationType
              # Interpolation type is unspecified. In this case, it defaults to
              # Linear.
              INTERPOLATION_TYPE_UNSPECIFIED = 0

              # Piecewise linear interpolation will be applied.
              LINEAR = 1
            end
          end
        end
      end
    end

    # Filter specification for data store queries.
    # @!attribute [rw] data_stores
    #   @return [::Array<::String>]
    #     Optional. The data store where the filter configuration is applied.
    #     Full resource name of data store, such as
    #     projects/\\{project}/locations/\\{location}/collections/\\{collectionId}/
    #     dataStores/\\{dataStoreId}.
    # @!attribute [rw] filter
    #   @return [::String]
    #     Optional. The filter expression to be applied.
    #     Expression syntax is documented at
    #     https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax
    class FilterSpecs
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The source of the query. We use QuerySource to distinguish queries directly
  # entered by agents and suggested queries from
  # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
  # If SUGGESTED_QUERY source is specified, we will treat it as a continuation
  # of a SuggestKnowledgeAssist call.
  module QuerySource
    # Unknown query source.
    QUERY_SOURCE_UNSPECIFIED = 0

    # The query is from agents.
    AGENT_QUERY = 1

    # The query is a suggested query from
    # {::Google::Cloud::Dialogflow::V2::Participants::Client#suggest_knowledge_assist Participants.SuggestKnowledgeAssist}.
    SUGGESTED_QUERY = 2
  end
end