Method: projects.locations.collections.engines.assistants.agents.getAgentView

Returns a AgentView for a given Agent, which contains additional information about the Agent.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:getAgentView

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Agent to get. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Query parameters

Parameters
languageCode

string

Optional. The UI language currently shown to the user. Specifying this field request that the texts in the AgentView in the response should be translated to this language.
maxSuggestedPrompts

integer

Optional. The maximum number of suggested prompts to return per agent.
adminView

boolean

Optional. Indicates whether to consider if the caller is an admin. If set, and the caller is an admin, the response will consider admin-only permissions. Otherwise, a caller with admin permissions will get a response as an unprivileged user.

Request body

The request body must be empty.

Response body

Response message for the AgentService.GetAgentView method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "agentView": {
    object (AgentView)
  }
}
Fields
agentView

object (AgentView)

The data for displaying an Agent.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.agents.getAgentView

For more information, see the IAM documentation.