Class: Google::Cloud::DiscoveryEngine::V1beta::Evaluation

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

Overview

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

Defined Under Namespace

Modules: State Classes: EvaluationSpec

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Evaluation was created at.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Evaluation was completed at.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#error_samples ⇒ ::Array<::Google::Rpc::Status> (readonly)

Returns Output only. A sample of errors encountered while processing the request.

Returns:

  • (::Array<::Google::Rpc::Status>) —

    Output only. A sample of errors encountered while processing the request.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#evaluation_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec

Returns Required. The specification of the evaluation.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#name ⇒ ::String

Returns Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns:

  • (::String) —

    Identifier. The full resource name of the Evaluation, in the format of projects/{project}/locations/{location}/evaluations/{evaluation}.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#quality_metrics ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics (readonly)

Returns Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet.

Only populated when the evaluation's state is SUCCEEDED.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end

#state ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::State (readonly)

Returns Output only. The state of the evaluation.

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb', line 64

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

  # Describes the specification of the evaluation.
  # @!attribute [rw] search_request
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
  #     Required. The search request that is used to perform the evaluation.
  #
  #     Only the following fields within SearchRequest are supported; if any
  #     other fields are provided, an UNSUPPORTED error will be returned:
  #
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
  #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
  # @!attribute [rw] query_set_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
  #     Required. The specification of the query set.
  class EvaluationSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes the specification of the query set.
    # @!attribute [rw] sample_query_set
    #   @return [::String]
    #     Required. The full resource name of the
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
    #     used for the evaluation, in the format of
    #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
    class QuerySetSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Describes the state of an evaluation.
  module State
    # The evaluation is unspecified.
    STATE_UNSPECIFIED = 0

    # The service is preparing to run the evaluation.
    PENDING = 1

    # The evaluation is in progress.
    RUNNING = 2

    # The evaluation completed successfully.
    SUCCEEDED = 3

    # The evaluation failed.
    FAILED = 4
  end
end