Generated from protobuf messagegoogle.cloud.discoveryengine.v1.StreamAssistRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The resource name of theAssistant. Format:projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
Optional. Current user query. Empty query is only supported iffile_idsare 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}
Optional. Specification of the generation configuration for the request.
getName
Required. The resource name of theAssistant. Format:projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
Returns
Type
Description
string
setName
Required. The resource name of theAssistant. Format:projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getQuery
Optional. Current user query.
Empty query is only supported iffile_idsare provided. In this case, the
answer will be generated based on those context files.
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
Type
Description
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}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUserMetadata
Optional. Information about the user initiating the query.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class StreamAssistRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.StreamAssistRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.StreamAssistRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.StreamAssistRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.StreamAssistRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.StreamAssistRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.StreamAssistRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.StreamAssistRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.StreamAssistRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.StreamAssistRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.StreamAssistRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.StreamAssistRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.StreamAssistRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.StreamAssistRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.StreamAssistRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.StreamAssistRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.StreamAssistRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.StreamAssistRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class StreamAssistRequest.\n\nRequest for the\n[AssistantService.StreamAssist](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.AssistantServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_AssistantServiceClient__streamAssist__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.StreamAssistRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The resource name of the\n[Assistant](/php/docs/reference/cloud-discoveryengine/latest/V1.Assistant). Format:\n`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`\n\n### setName\n\nRequired. The resource name of the\n[Assistant](/php/docs/reference/cloud-discoveryengine/latest/V1.Assistant). Format:\n`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`\n\n### getQuery\n\nOptional. Current user query.\n\nEmpty query is only supported if `file_ids` are provided. In this case, the\nanswer will be generated based on those context files.\n\n### hasQuery\n\n### clearQuery\n\n### setQuery\n\nOptional. Current user query.\n\nEmpty query is only supported if `file_ids` are provided. In this case, the\nanswer will be generated based on those context files.\n\n### getSession\n\nOptional. The session to use for the request. If specified, the assistant\nhas access to the session history, and the query and the answer are stored\nthere.\n\nIf `-` is specified as the session ID, or it is left empty, then a new\nsession is created with an automatically generated ID.\nFormat:\n`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`\n\n### setSession\n\nOptional. The session to use for the request. If specified, the assistant\nhas access to the session history, and the query and the answer are stored\nthere.\n\nIf `-` is specified as the session ID, or it is left empty, then a new\nsession is created with an automatically generated ID.\nFormat:\n`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`\n\n### getUserMetadata\n\nOptional. Information about the user initiating the query.\n\n### hasUserMetadata\n\n### clearUserMetadata\n\n### setUserMetadata\n\nOptional. Information about the user initiating the query.\n\n### getToolsSpec\n\nOptional. Specification of tools that are used to serve the request.\n\n### hasToolsSpec\n\n### clearToolsSpec\n\n### setToolsSpec\n\nOptional. Specification of tools that are used to serve the request.\n\n### getGenerationSpec\n\nOptional. Specification of the generation configuration for the request.\n\n### hasGenerationSpec\n\n### clearGenerationSpec\n\n### setGenerationSpec\n\nOptional. Specification of the generation configuration for the request."]]
