Method: projects.locations.collections.engines.assistants.agents.message.stream

message.stream is a streaming call that will return a stream of task update events until the Task is in an interrupted or terminal state.

HTTP request

POST https://discoveryengine.googleapis.com/{tenant=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}/message:stream

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
tenant

string

Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "message": {
    object (Message)
  },
  "configuration": {
    object (SendMessageConfiguration)
  },
  "metadata": {
    object
  }
}
Fields
message

object (Message)

Required. The message to send to the agent.
configuration

object (SendMessageConfiguration)

Configuration for the send request.
metadata

object (Struct format)

Optional metadata for the request.

Response body

If successful, the response body contains a stream of StreamResponse instances.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.