Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse.
Response message for Recommend method.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#attribution_token
defattribution_token()->::String
Returns
(::String) — A unique attribution token. This should be included in the
UserEvent logs resulting
from this recommendation, which enables accurate attribution of
recommendation model performance.
#attribution_token=
defattribution_token=(value)->::String
Parameter
value (::String) — A unique attribution token. This should be included in the
UserEvent logs resulting
from this recommendation, which enables accurate attribution of
recommendation model performance.
Returns
(::String) — A unique attribution token. This should be included in the
UserEvent logs resulting
from this recommendation, which enables accurate attribution of
recommendation model performance.
#missing_ids
defmissing_ids()->::Array<::String>
Returns
(::Array<::String>) — IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
#missing_ids=
defmissing_ids=(value)->::Array<::String>
Parameter
value (::Array<::String>) — IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
Returns
(::Array<::String>) — IDs of documents in the request that were missing from the default Branch
associated with the requested ServingConfig.
[[["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::RecommendResponse (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-RecommendResponse)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse.\n\nResponse message for Recommend method. \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### #attribution_token\n\n def attribution_token() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A unique attribution token. This should be included in the [UserEvent](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserEvent \"Google::Cloud::DiscoveryEngine::V1beta::UserEvent (class)\") logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.\n\n### #attribution_token=\n\n def attribution_token=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A unique attribution token. This should be included in the [UserEvent](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserEvent \"Google::Cloud::DiscoveryEngine::V1beta::UserEvent (class)\") logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. \n**Returns**\n\n- (::String) --- A unique attribution token. This should be included in the [UserEvent](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-UserEvent \"Google::Cloud::DiscoveryEngine::V1beta::UserEvent (class)\") logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.\n\n### #missing_ids\n\n def missing_ids() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.\n\n### #missing_ids=\n\n def missing_ids=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.\n\n### #results\n\n def results() -\u003e ::Array\u003c::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult](./Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse-RecommendationResult)\\\u003e) --- A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).\n\n### #results=\n\n def results=(value) -\u003e ::Array\u003c::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult](./Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse-RecommendationResult)\\\u003e) --- A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult](./Google-Cloud-DiscoveryEngine-V1beta-RecommendResponse-RecommendationResult)\\\u003e) --- A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).\n\n### #validate_only\n\n def validate_only() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- True if [RecommendRequest.validate_only](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-RecommendRequest#Google__Cloud__DiscoveryEngine__V1beta__RecommendRequest_validate_only_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#validate_only (method)\") was set.\n\n### #validate_only=\n\n def validate_only=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- True if [RecommendRequest.validate_only](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-RecommendRequest#Google__Cloud__DiscoveryEngine__V1beta__RecommendRequest_validate_only_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#validate_only (method)\") was set. \n**Returns**\n\n- (::Boolean) --- True if [RecommendRequest.validate_only](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-RecommendRequest#Google__Cloud__DiscoveryEngine__V1beta__RecommendRequest_validate_only_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#validate_only (method)\") was set."]]
