Class: Google::Cloud::DiscoveryEngine::V1::Session
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1::Session
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/discoveryengine/v1/session.rb
Overview
External session proto definition.
Defined Under Namespace
Instance Attribute Summary collapse
-
#display_name ⇒ ::String
Optional.
-
#end_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#is_pinned ⇒ ::Boolean
Optional.
-
#name ⇒ ::String
Immutable.
-
#start_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::Session::State
The state of the session.
-
#turns ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Turns.
-
#user_pseudo_id ⇒ ::String
A unique identifier for tracking users.
Instance Attribute Details
#display_name ⇒ ::String
Returns Optional. The display name of the session.
This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time the session finished.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#is_pinned ⇒ ::Boolean
Returns Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#name ⇒ ::String
Returns Immutable. Fully qualified name
projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. The time the session started.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::Session::State
Returns The state of the session.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#turns ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Session::Turn>
Returns Turns.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |
#user_pseudo_id ⇒ ::String
Returns A unique identifier for tracking users.
54 55 56 57 58 59 60 61 62 63 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 54 class Session include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Represents a turn, including a query from the user and a # answer from service. # @!attribute [rw] query # @return [::Google::Cloud::DiscoveryEngine::V1::Query] # The user query. # @!attribute [rw] answer # @return [::String] # The resource name of the answer to the user query. # # Only set if the answer generation (/answer API call) happened in this # turn. # @!attribute [r] detailed_answer # @return [::Google::Cloud::DiscoveryEngine::V1::Answer] # Output only. In # {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession} # API, if # {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details} # is set to true, this field will be populated when getting answer query # session. class Turn include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Enumeration of the state of the session. module State # State is unspecified. STATE_UNSPECIFIED = 0 # The session is currently open. IN_PROGRESS = 1 end end |