Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest (v2.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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::V1::StreamAssistRequest::GenerationSpec
Returns

#generation_spec=

def generation_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec
Parameter
Returns

#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::V1::Query
Returns

#query=

def query=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Query
Parameter
  • value (::Google::Cloud::DiscoveryEngine::V1::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

#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::V1::StreamAssistRequest::ToolsSpec
Returns

#tools_spec=

def tools_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec
Parameter
Returns

#user_metadata

def user_metadata() -> ::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata
Returns

#user_metadata=

def user_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata
Parameter
Returns