Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class StreamAssistRequest.
Request for the AssistantService.StreamAssist method.
Generated from protobuf message google.cloud.discoveryengine.v1.StreamAssistRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of the Assistant
. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
↳ query
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
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}
↳ user_metadata
↳ tools_spec
↳ generation_spec
StreamAssistRequest\GenerationSpec
Optional. Specification of the generation configuration for the request.
getName
Required. The resource name of the Assistant
. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
string
setName
Required. The resource name of the Assistant
. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
var
string
$this
getQuery
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.
hasQuery
clearQuery
setQuery
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.
$this
getSession
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
setSession
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}
var
string
$this
getUserMetadata
Optional. Information about the user initiating the query.
hasUserMetadata
clearUserMetadata
setUserMetadata
Optional. Information about the user initiating the query.
$this
getToolsSpec
Optional. Specification of tools that are used to serve the request.
hasToolsSpec
clearToolsSpec
setToolsSpec
Optional. Specification of tools that are used to serve the request.
$this
getGenerationSpec
Optional. Specification of the generation configuration for the request.
hasGenerationSpec
clearGenerationSpec
setGenerationSpec
Optional. Specification of the generation configuration for the request.
$this
