Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest (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::StreamAssistRequest.

Request for the AssistantService.StreamAssist method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#generation_spec

def generation_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::GenerationSpec

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.

#generation_spec=

def generation_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::GenerationSpec

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.

#name

def name() -> ::String

Returns

• (::String) — Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Returns

• (::String) — Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

#query

def query() -> ::Google::Cloud::DiscoveryEngine::V1beta::Query

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Query) — Optional. Current user query.

  Empty query is only supported if file_ids are provided. In this case, the answer will be generated based on those context files.

#query=

def query=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Query

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Query) — Optional. Current user query.

  Empty query is only supported if file_ids are provided. In this case, the answer will be generated based on those context files.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Query) — Optional. Current user query.

  Empty query is only supported if file_ids are provided. In this case, the answer will be generated based on those context files.

#session

def session() -> ::String

Returns

• (::String) — Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there.

  If - is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

#session=

def session=(value) -> ::String

Parameter

• value (::String) — Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there.

  If - is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Returns

• (::String) — Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there.

  If - is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

#tools_spec

def tools_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.

#tools_spec=

def tools_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.

#user_metadata

def user_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::AssistUserMetadata

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::AssistUserMetadata) — Optional. Information about the user initiating the query.

#user_metadata=

def user_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::AssistUserMetadata

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::AssistUserMetadata) — Optional. Information about the user initiating the query.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::AssistUserMetadata) — Optional. Information about the user initiating the query.