Discovery Engine API (discoveryengine:v1)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.message.send

  Parameters :

  tenant

  Type : string

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

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Location : path

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/message:send

  HTTP Method : POST

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

  Path : {+tenant}/message:send

  Parameter Order : tenant

  Description : Send a message to the agent. This is a blocking call that will return the task once it is completed, or a LRO if requested.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.message.stream

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/message:stream

  Path : {+tenant}/message:stream

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

  HTTP Method : POST

  Parameters :

  tenant

  Required : Yes

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

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

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

  Parameter Order : tenant

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.get

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}

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

  Description : Get the current state of a task from the agent.

  Parameter Order :

  • tenant
  • name

  HTTP Method : GET

  Parameters :

  name

  Type : string

  Description : Required. The resource name of the task. Format: tasks/{task_id}

  Pattern : ^tasks/[^/]+$

  Required : Yes

  Location : path

  historyLength

  Type : integer

  Format : int32

  Description : The number of most recent messages from the task's history to retrieve.

  Location : query

  tenant

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Location : path

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

  Path : {+tenant}/{+name}

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.cancel

  Description : Cancel a task from the agent. If supported one should expect no more task updates for the task.

  HTTP Method : POST

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

  Path : {+tenant}/{+name}:cancel

  Parameters :

  tenant

  Type : string

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

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Location : path

  name

  Type : string

  Description : The resource name of the task to cancel. Format: tasks/{task_id}

  Pattern : ^tasks/[^/]+$

  Location : path

  Required : Yes

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}:cancel

  Parameter Order :

  • tenant
  • name

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.subscribe

  Description : TaskSubscription is a streaming call that will return a stream of task update events. This attaches the stream to an existing in process task. If the task is complete the stream will return the completed task (like GetTask) and close the stream.

  Parameters :

  tenant

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

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Type : string

  Location : path

  Required : Yes

  name

  Type : string

  Description : The resource name of the task to subscribe to. Format: tasks/{task_id}

  Required : Yes

  Pattern : ^tasks/[^/]+$

  Location : path

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}:subscribe

  HTTP Method : GET

  Path : {+tenant}/{+name}:subscribe

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

  Parameter Order :

  • tenant
  • name

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.create

  Parameters :

  parent

  Description : Required. The parent task resource for this config. Format: tasks/{task_id}

  Required : Yes

  Location : path

  Pattern : ^tasks/[^/]+/pushNotificationConfigs$

  Type : string

  configId

  Location : query

  Description : Required. The ID for the new config.

  Type : string

  tenant

  Type : string

  Location : path

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

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

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

  Path : {+tenant}/{+parent}

  HTTP Method : POST

  Parameter Order :

  • tenant
  • parent

  Description : Set a push notification config for a task.

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.list

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs

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

  Parameters :

  pageSize

  Type : integer

  Location : query

  Description : For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned.

  Format : int32

  parent

  Required : Yes

  Location : path

  Description : The parent task resource. Format: tasks/{task_id}

  Pattern : ^tasks/[^/]+$

  Type : string

  tenant

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Location : path

  Required : Yes

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

  Type : string

  pageToken

  Description : A page token received from a previous ListTaskPushNotificationConfigRequest call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTaskPushNotificationConfigRequest` must match the call that provided the page token.

  Location : query

  Type : string

  Path : {+tenant}/{+parent}/pushNotificationConfigs

  HTTP Method : GET

  Parameter Order :

  • tenant
  • parent

  Description : Get a list of push notifications configured for a task.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.get

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

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}

  Parameters :

  tenant

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

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

  Location : path

  name

  Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$

  Description : The resource name of the config to retrieve. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}

  Location : path

  Type : string

  Required : Yes

  HTTP Method : GET

  Parameter Order :

  • tenant
  • name

  Path : {+tenant}/{+name}

  Description : Get a push notification config for a task.

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.tasks.pushNotificationConfigs.delete

  Parameters :

  tenant

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

  Location : path

  Type : string

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

  name

  Pattern : ^tasks/[^/]+/pushNotificationConfigs/[^/]+$

  Location : path

  Type : string

  Description : The resource name of the config to delete. Format: tasks/{task_id}/pushNotificationConfigs/{config_id}

  Required : Yes

  Path : {+tenant}/{+name}

  Parameter Order :

  • tenant
  • name

  Description : Delete a push notification config for a task.

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}

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

  HTTP Method : DELETE

• ▼ ▲ discoveryengine.projects.locations.collections.engines.assistants.agents.getCard

  Flat Path : projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/card

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

  HTTP Method : GET

  Parameters :

  tenant

  Type : string

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$

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

  Location : path

  Parameter Order : tenant

  Description : GetAgentCard returns the agent card for the agent.

  Path : {+tenant}/card