(::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.
#name=
defname=(value)->::String
Parameter
value (::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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Evaluation (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-Evaluation)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-Evaluation) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Evaluation.\n\nAn evaluation is a single execution (or run) of an evaluation process. It\nencapsulates the state of the evaluation and the resulting data. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Timestamp the [Evaluation](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation \"Google::Cloud::DiscoveryEngine::V1beta::Evaluation (class)\") was created at.\n\n### #end_time\n\n def end_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. Timestamp the [Evaluation](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation \"Google::Cloud::DiscoveryEngine::V1beta::Evaluation (class)\") was completed at.\n\n### #error\n\n def error() -\u003e ::Google::Rpc::Status\n\n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.\n\n### #error_samples\n\n def error_samples() -\u003e ::Array\u003c::Google::Rpc::Status\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Rpc::Status](./Google-Rpc-Status)\\\u003e) --- Output only. A sample of errors encountered while processing the request.\n\n### #evaluation_spec\n\n def evaluation_spec() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec](./Google-Cloud-DiscoveryEngine-V1beta-Evaluation-EvaluationSpec)) --- Required. The specification of the evaluation.\n\n### #evaluation_spec=\n\n def evaluation_spec=(value) -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec\n\n**Parameter**\n\n- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec](./Google-Cloud-DiscoveryEngine-V1beta-Evaluation-EvaluationSpec)) --- Required. The specification of the evaluation. \n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec](./Google-Cloud-DiscoveryEngine-V1beta-Evaluation-EvaluationSpec)) --- Required. The specification of the evaluation.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Identifier. The full resource name of the [Evaluation](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation \"Google::Cloud::DiscoveryEngine::V1beta::Evaluation (class)\"), in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\n characters.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Identifier. The full resource name of the [Evaluation](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation \"Google::Cloud::DiscoveryEngine::V1beta::Evaluation (class)\"), in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\ncharacters. \n**Returns**\n\n- (::String) --- Identifier. The full resource name of the [Evaluation](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Evaluation \"Google::Cloud::DiscoveryEngine::V1beta::Evaluation (class)\"), in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`.\n\n\n This field must be a UTF-8 encoded string with a length limit of 1024\n characters.\n\n### #quality_metrics\n\n def quality_metrics() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics](./Google-Cloud-DiscoveryEngine-V1beta-QualityMetrics)) --- Output only. The metrics produced by the evaluation, averaged across all [SampleQuery](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SampleQuery \"Google::Cloud::DiscoveryEngine::V1beta::SampleQuery (class)\")s in the [SampleQuerySet](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SampleQuerySet \"Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet (class)\").\n\n\n Only populated when the evaluation's state is SUCCEEDED.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::State\n\n**Returns**\n\n- ([::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::State](./Google-Cloud-DiscoveryEngine-V1beta-Evaluation-State)) --- Output only. The state of the evaluation."]]
