Class: Google::Cloud::DiscoveryEngine::V1::Session

Inherits:
Object
  • Object
show all
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

Modules: State Classes: Turn

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The time the session finished.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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/*.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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.

Returns:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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.

Returns:

  • (::String) —

    A unique identifier for tracking users.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'proto_docs/google/cloud/discoveryengine/v1/session.rb', line 44

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.
  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