Discovery Engine v1 API - Class StreamAssistRequest (1.9.0)

public sealed class StreamAssistRequest : IMessage<StreamAssistRequest>, IEquatable<StreamAssistRequest>, IDeepCloneable<StreamAssistRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class StreamAssistRequest.

Request for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.

Inheritance

object > StreamAssistRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

StreamAssistRequest()

public StreamAssistRequest()

StreamAssistRequest(StreamAssistRequest)

public StreamAssistRequest(StreamAssistRequest other)
Parameter
Name Description
other StreamAssistRequest

Properties

AssistantName

public AssistantName AssistantName { get; set; }

AssistantName-typed view over the Name resource name property.

Property Value
Type Description
AssistantName

GenerationSpec

public StreamAssistRequest.Types.GenerationSpec GenerationSpec { get; set; }

Optional. Specification of the generation configuration for the request.

Property Value
Type Description
StreamAssistRequestTypesGenerationSpec

Name

public string Name { get; set; }

Required. The resource name of the [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Property Value
Type Description
string

Query

public Query Query { get; set; }

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.

Property Value
Type Description
Query

Session

public string Session { get; set; }

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}

Property Value
Type Description
string

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
Type Description
SessionName

ToolsSpec

public StreamAssistRequest.Types.ToolsSpec ToolsSpec { get; set; }

Optional. Specification of tools that are used to serve the request.

Property Value
Type Description
StreamAssistRequestTypesToolsSpec

UserMetadata

public AssistUserMetadata UserMetadata { get; set; }

Optional. Information about the user initiating the query.

Property Value
Type Description
AssistUserMetadata