Class: Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec

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

Overview

Query understanding specification.

Defined Under Namespace

Classes: QueryClassificationSpec, QueryRephraserSpec

Instance Attribute Summary collapse

Instance Attribute Details

#disable_spell_correction ⇒ ::Boolean

Returns Optional. Whether to disable spell correction. The default value is false.

Returns:

  • (::Boolean) —

    Optional. Whether to disable spell correction. The default value is false.



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 738

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

  # Query classification specification.
  # @!attribute [rw] types
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec::Type>]
  #     Enabled query classification types.
  class QueryClassificationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query classification types.
    module Type
      # Unspecified query classification type.
      TYPE_UNSPECIFIED = 0

      # Adversarial query classification type.
      ADVERSARIAL_QUERY = 1

      # Non-answer-seeking query classification type, for chit chat.
      NON_ANSWER_SEEKING_QUERY = 2

      # Jail-breaking query classification type.
      JAIL_BREAKING_QUERY = 3

      # Non-answer-seeking query classification type, for no clear intent.
      NON_ANSWER_SEEKING_QUERY_V2 = 4

      # User defined query classification type.
      USER_DEFINED_CLASSIFICATION_QUERY = 5
    end
  end

  # Query rephraser specification.
  # @!attribute [rw] disable
  #   @return [::Boolean]
  #     Disable query rephraser.
  # @!attribute [rw] max_rephrase_steps
  #   @return [::Integer]
  #     Max rephrase steps.
  #     The max number is 5 steps.
  #     If not set or set to < 1, it will be set to 1 by default.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec]
  #     Optional. Query Rephraser Model specification.
  class QueryRephraserSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Rephraser Model specification.
    # @!attribute [rw] model_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec::ModelType]
    #     Optional. Enabled query rephraser model type. If not set, it will use
    #     LARGE by default.
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Query rephraser types. Currently only supports single-hop
      # (max_rephrase_steps = 1) model selections. For multi-hop
      # (max_rephrase_steps > 1), there is only one default model.
      module ModelType
        # Unspecified model type.
        MODEL_TYPE_UNSPECIFIED = 0

        # Small query rephraser model. Gemini 1.0 XS model.
        SMALL = 1

        # Large query rephraser model. Gemini 1.0 Pro model.
        LARGE = 2
      end
    end
  end
end

#query_classification_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec

Returns Query classification specification.

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 738

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

  # Query classification specification.
  # @!attribute [rw] types
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec::Type>]
  #     Enabled query classification types.
  class QueryClassificationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query classification types.
    module Type
      # Unspecified query classification type.
      TYPE_UNSPECIFIED = 0

      # Adversarial query classification type.
      ADVERSARIAL_QUERY = 1

      # Non-answer-seeking query classification type, for chit chat.
      NON_ANSWER_SEEKING_QUERY = 2

      # Jail-breaking query classification type.
      JAIL_BREAKING_QUERY = 3

      # Non-answer-seeking query classification type, for no clear intent.
      NON_ANSWER_SEEKING_QUERY_V2 = 4

      # User defined query classification type.
      USER_DEFINED_CLASSIFICATION_QUERY = 5
    end
  end

  # Query rephraser specification.
  # @!attribute [rw] disable
  #   @return [::Boolean]
  #     Disable query rephraser.
  # @!attribute [rw] max_rephrase_steps
  #   @return [::Integer]
  #     Max rephrase steps.
  #     The max number is 5 steps.
  #     If not set or set to < 1, it will be set to 1 by default.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec]
  #     Optional. Query Rephraser Model specification.
  class QueryRephraserSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Rephraser Model specification.
    # @!attribute [rw] model_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec::ModelType]
    #     Optional. Enabled query rephraser model type. If not set, it will use
    #     LARGE by default.
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Query rephraser types. Currently only supports single-hop
      # (max_rephrase_steps = 1) model selections. For multi-hop
      # (max_rephrase_steps > 1), there is only one default model.
      module ModelType
        # Unspecified model type.
        MODEL_TYPE_UNSPECIFIED = 0

        # Small query rephraser model. Gemini 1.0 XS model.
        SMALL = 1

        # Large query rephraser model. Gemini 1.0 Pro model.
        LARGE = 2
      end
    end
  end
end

#query_rephraser_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec

Returns Query rephraser specification.

Returns:



738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 738

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

  # Query classification specification.
  # @!attribute [rw] types
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryClassificationSpec::Type>]
  #     Enabled query classification types.
  class QueryClassificationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query classification types.
    module Type
      # Unspecified query classification type.
      TYPE_UNSPECIFIED = 0

      # Adversarial query classification type.
      ADVERSARIAL_QUERY = 1

      # Non-answer-seeking query classification type, for chit chat.
      NON_ANSWER_SEEKING_QUERY = 2

      # Jail-breaking query classification type.
      JAIL_BREAKING_QUERY = 3

      # Non-answer-seeking query classification type, for no clear intent.
      NON_ANSWER_SEEKING_QUERY_V2 = 4

      # User defined query classification type.
      USER_DEFINED_CLASSIFICATION_QUERY = 5
    end
  end

  # Query rephraser specification.
  # @!attribute [rw] disable
  #   @return [::Boolean]
  #     Disable query rephraser.
  # @!attribute [rw] max_rephrase_steps
  #   @return [::Integer]
  #     Max rephrase steps.
  #     The max number is 5 steps.
  #     If not set or set to < 1, it will be set to 1 by default.
  # @!attribute [rw] model_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec]
  #     Optional. Query Rephraser Model specification.
  class QueryRephraserSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Query Rephraser Model specification.
    # @!attribute [rw] model_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec::ModelSpec::ModelType]
    #     Optional. Enabled query rephraser model type. If not set, it will use
    #     LARGE by default.
    class ModelSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Query rephraser types. Currently only supports single-hop
      # (max_rephrase_steps = 1) model selections. For multi-hop
      # (max_rephrase_steps > 1), there is only one default model.
      module ModelType
        # Unspecified model type.
        MODEL_TYPE_UNSPECIFIED = 0

        # Small query rephraser model. Gemini 1.0 XS model.
        SMALL = 1

        # Large query rephraser model. Gemini 1.0 Pro model.
        LARGE = 2
      end
    end
  end
end