Package com.google.cloud.discoveryengine.v1

Interface StreamAssistRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StreamAssistRequest, StreamAssistRequest.Builder
@Generated public interface StreamAssistRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Required. The resource name of the
 [Assistant][google.cloud.discoveryengine.v1.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:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The resource name of the
 [Assistant][google.cloud.discoveryengine.v1.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:
      The bytes for name.

    • hasQuery

      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:
      Whether the query field is set.

    • getQuery

      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:
      The query.

    • getQueryOrBuilder

      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];

    • getSession

      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:
      The session.

    • getSessionBytes

      com.google.protobuf.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:
      The bytes for session.

    • hasUserMetadata

      boolean hasUserMetadata()
       Optional. Information about the user initiating the query.
      .google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the userMetadata field is set.

    • getUserMetadata

      AssistUserMetadata getUserMetadata()
       Optional. Information about the user initiating the query.
      .google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The userMetadata.

    • getUserMetadataOrBuilder

      AssistUserMetadataOrBuilder getUserMetadataOrBuilder()
       Optional. Information about the user initiating the query.
      .google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

    • hasToolsSpec

      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:
      Whether the toolsSpec field is set.

    • getToolsSpec

      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:
      The toolsSpec.

    • getToolsSpecOrBuilder

      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];

    • hasGenerationSpec

      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:
      Whether the generationSpec field is set.

    • getGenerationSpec

      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:
      The generationSpec.

    • getGenerationSpecOrBuilder

      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];