Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SessionInfo.
Information about the session.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#name
defname()->::String
Returns
(::String) — Name of the session.
If the auto-session mode is used (when
SearchRequest.session
ends with "-"), this field holds the newly generated session name.
#name=
defname=(value)->::String
Parameter
value (::String) — Name of the session.
If the auto-session mode is used (when
SearchRequest.session
ends with "-"), this field holds the newly generated session name.
Returns
(::String) — Name of the session.
If the auto-session mode is used (when
SearchRequest.session
ends with "-"), this field holds the newly generated session name.
#query_id
defquery_id()->::String
Returns
(::String) — Query ID that corresponds to this search API call.
One session can have multiple turns, each with a unique query ID.
By specifying the session name and this query ID in the Answer API call,
the answer generation happens in the context of the search results from
this search call.
#query_id=
defquery_id=(value)->::String
Parameter
value (::String) — Query ID that corresponds to this search API call.
One session can have multiple turns, each with a unique query ID.
By specifying the session name and this query ID in the Answer API call,
the answer generation happens in the context of the search results from
this search call.
Returns
(::String) — Query ID that corresponds to this search API call.
One session can have multiple turns, each with a unique query ID.
By specifying the session name and this query ID in the Answer API call,
the answer generation happens in the context of the search results from
this search call.
[[["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::SearchResponse::SessionInfo (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-SearchResponse-SessionInfo)\n- [0.20.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.20.1/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.19.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.19.1/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.18.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.18.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.17.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.17.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.16.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.16.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.15.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.15.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.14.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.14.2/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.13.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.13.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.12.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.12.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.11.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.11.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.10.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.10.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.9.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.9.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.8.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.8.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.7.2](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.7.2/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.6.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.6.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.5.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.5.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.4.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.4.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.3.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.3.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.2.1](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.2.1/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo)\n- [0.1.0](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/0.1.0/Google-Cloud-DiscoveryEngine-V1beta-SearchResponse-SessionInfo) \nReference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SessionInfo.\n\nInformation about the session. \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### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of the session. If the auto-session mode is used (when [SearchRequest.session](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest_session_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session (method)\") ends with \"-\"), this field holds the newly generated session name.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of the session. If the auto-session mode is used (when [SearchRequest.session](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest_session_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session (method)\") ends with \"-\"), this field holds the newly generated session name. \n**Returns**\n\n- (::String) --- Name of the session. If the auto-session mode is used (when [SearchRequest.session](/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-SearchRequest#Google__Cloud__DiscoveryEngine__V1beta__SearchRequest_session_instance_ \"Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session (method)\") ends with \"-\"), this field holds the newly generated session name.\n\n### #query_id\n\n def query_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.\n\n By specifying the session name and this query ID in the Answer API call,\n the answer generation happens in the context of the search results from\n this search call.\n\n### #query_id=\n\n def query_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.\n\n\n By specifying the session name and this query ID in the Answer API call,\n the answer generation happens in the context of the search results from\nthis search call. \n**Returns**\n\n- (::String) --- Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID.\n\n By specifying the session name and this query ID in the Answer API call,\n the answer generation happens in the context of the search results from\n this search call."]]