# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse.

Response for the
[AssistantService.StreamAssist](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistantService-Client#Google__Cloud__DiscoveryEngine__V1beta__AssistantService__Client_stream_assist_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistantService::Client#stream_assist (method)")
method.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #answer

    def answer() -> ::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)").

  Observe
  [AssistAnswer.state](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_state_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#state (method)")
  to see if more parts are to be expected. While the state is `IN_PROGRESS`,
  the
  [AssistAnswer.replies](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)")
  field in each response will contain replies (reply fragments) to be
  appended to the ones received in previous responses.
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  won't be filled.

  If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
  is the last response and
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  will have a value.

### #answer=

    def answer=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)").

  Observe
  [AssistAnswer.state](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_state_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#state (method)")
  to see if more parts are to be expected. While the state is `IN_PROGRESS`,
  the
  [AssistAnswer.replies](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)")
  field in each response will contain replies (reply fragments) to be
  appended to the ones received in previous responses.
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  won't be filled.

  If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
  is the last response and
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  will have a value.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)").

  Observe
  [AssistAnswer.state](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_state_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#state (method)")
  to see if more parts are to be expected. While the state is `IN_PROGRESS`,
  the
  [AssistAnswer.replies](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_replies_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#replies (method)")
  field in each response will contain replies (reply fragments) to be
  appended to the ones received in previous responses.
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  won't be filled.

  If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
  is the last response and
  [AssistAnswer.name](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-AssistAnswer#Google__Cloud__DiscoveryEngine__V1beta__AssistAnswer_name_instance_ "Google::Cloud::DiscoveryEngine::V1beta::AssistAnswer#name (method)")
  will have a value.

### #assist_token

    def assist_token() -> ::String

**Returns**

- (::String) --- A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.

### #assist_token=

    def assist_token=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.

### #invocation_tools

    def invocation_tools() -> ::Array<::String>

**Returns**

- (::Array\<::String\>) --- The tool names of the tools that were invoked.

### #invocation_tools=

    def invocation_tools=(value) -> ::Array<::String>

**Parameter**

- **value** (::Array\<::String\>) --- The tool names of the tools that were invoked.
**Returns**

- (::Array\<::String\>) --- The tool names of the tools that were invoked.

### #invoked_skills

    def invoked_skills() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::InvokedSkill>

**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::InvokedSkill](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-InvokedSkill)\>) --- The skills executed during the turn.

### #invoked_skills=

    def invoked_skills=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::InvokedSkill>

**Parameter**

- **value** (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::InvokedSkill](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-InvokedSkill)\>) --- The skills executed during the turn.
**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::InvokedSkill](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-InvokedSkill)\>) --- The skills executed during the turn.

### #session_info

    def session_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::SessionInfo

**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::SessionInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-SessionInfo)) --- Session information. Only included in the final StreamAssistResponse of the response stream.

### #session_info=

    def session_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::SessionInfo

**Parameter**

- **value** ([::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::SessionInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-SessionInfo)) --- Session information. Only included in the final StreamAssistResponse of the response stream.
**Returns**

- ([::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistResponse::SessionInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-StreamAssistResponse-SessionInfo)) --- Session information. Only included in the final StreamAssistResponse of the response stream.