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
- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.
#generation_spec=
def generation_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec
- value (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.
- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec) — Optional. Specification of the generation configuration for the request.
#name
def name() -> ::String
-
(::String) — Required. The resource name of the
Assistant. Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
#name=
def name=(value) -> ::String
-
value (::String) — Required. The resource name of the
Assistant. Format:
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
-
(::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
-
(::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.
#query=
def query=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Query
-
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.
-
(::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.
#session
def session() -> ::String
-
(::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
-
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}
-
(::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
- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.
#tools_spec=
def tools_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec
- value (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.
- (::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec) — Optional. Specification of tools that are used to serve the request.
#user_metadata
def user_metadata() -> ::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata
- (::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata) — Optional. Information about the user initiating the query.
#user_metadata=
def user_metadata=(value) -> ::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata
- value (::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata) — Optional. Information about the user initiating the query.
- (::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata) — Optional. Information about the user initiating the query.