Interface StreamAssistRequestOrBuilder (0.66.0)

public interface StreamAssistRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGenerationSpec()

public abstract StreamAssistRequest.GenerationSpec getGenerationSpec()

Optional. Specification of the generation configuration for the request.

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.GenerationSpec

The generationSpec.

getGenerationSpecOrBuilder()

public abstract StreamAssistRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()

Optional. Specification of the generation configuration for the request.

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.GenerationSpecOrBuilder

getName()

public abstract String getName()

Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getQuery()

public abstract Query 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.

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Query

The query.

getQueryOrBuilder()

public abstract QueryOrBuilder getQueryOrBuilder()

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 query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryOrBuilder

getSession()

public abstract String 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 session = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public abstract ByteString getSessionBytes()

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 session = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

getToolsSpec()

public abstract StreamAssistRequest.ToolsSpec getToolsSpec()

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

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.ToolsSpec

The toolsSpec.

getToolsSpecOrBuilder()

public abstract StreamAssistRequest.ToolsSpecOrBuilder getToolsSpecOrBuilder()

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

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamAssistRequest.ToolsSpecOrBuilder

getUserMetadata()

public abstract AssistUserMetadata getUserMetadata()

Optional. Information about the user initiating the query.

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AssistUserMetadata

The userMetadata.

getUserMetadataOrBuilder()

public abstract AssistUserMetadataOrBuilder getUserMetadataOrBuilder()

Optional. Information about the user initiating the query.

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AssistUserMetadataOrBuilder

hasGenerationSpec()

public abstract boolean hasGenerationSpec()

Optional. Specification of the generation configuration for the request.

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the generationSpec field is set.

hasQuery()

public abstract boolean hasQuery()

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 query = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the query field is set.

hasToolsSpec()

public abstract boolean hasToolsSpec()

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

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolsSpec field is set.

hasUserMetadata()

public abstract boolean hasUserMetadata()

Optional. Information about the user initiating the query.

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the userMetadata field is set.