Class: Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb

Overview

Response for the AssistantService.StreamAssist method.

Defined Under Namespace

Classes: SessionInfo

Instance Attribute Summary collapse

Instance Attribute Details

#answer ⇒ ::Google::Cloud::DiscoveryEngine::V1::AssistAnswer

Returns Assist answer resource object containing parts of the assistant's final answer for the user's query.

Not present if the current response doesn't add anything to previously sent AssistAnswer.replies.

Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. [AssistAnswer.name][] won't be filled.

If the state is SUCCEEDED, FAILED or SKIPPED, the response is the last response and [AssistAnswer.name][] will have a value.

Returns:

  • (::Google::Cloud::DiscoveryEngine::V1::AssistAnswer) —

    Assist answer resource object containing parts of the assistant's final answer for the user's query.

    Not present if the current response doesn't add anything to previously sent AssistAnswer.replies.

    Observe AssistAnswer.state to see if more parts are to be expected. While the state is IN_PROGRESS, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. [AssistAnswer.name][] won't be filled.

    If the state is SUCCEEDED, FAILED or SKIPPED, the response is the last response and [AssistAnswer.name][] will have a value.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 188

class StreamAssistResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about the session.
  # @!attribute [rw] session
  #   @return [::String]
  #     Name of the newly generated or continued session.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#assist_token ⇒ ::String

Returns A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

Returns:

  • (::String) —

    A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 188

class StreamAssistResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about the session.
  # @!attribute [rw] session
  #   @return [::String]
  #     Name of the newly generated or continued session.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#session_info ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo

Returns Session information.

Returns:



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 188

class StreamAssistResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Information about the session.
  # @!attribute [rw] session
  #   @return [::String]
  #     Name of the newly generated or continued session.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end