Method: projects.locations.collections.engines.assistants.listAvailableAgentViews

Lists the data for displaying the Agents under an Assistant which are available to the caller.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/assistants/*}:listAvailableAgentViews

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
agentOrigin

enum (AgentOrigin)

Optional. The origin of the Agent.
sortBy

string

Optional. The field to sort by. Can have the following values: - display-name: The display name of the agent. - description: The description of the agent. - create-time: The creation time of the agent. - state: The state of the agent.
pageSize

integer

Optional. Maximum number of [AgentViews][]s to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
pageToken

string

Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to assistants.listAvailableAgentViews must match the call that provided the page token.
languageCode

string

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

integer

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

string

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Allowed fields are: * displayName * state

Some examples of filters would be: * displayName = 'agent_1' * displayName = 'agent_1' AND state = ENABLED

For a full description of the filter format, please see https://google.aip.dev/160.

Request body

The request body must be empty.

Response body

Response message for the AgentService.ListAvailableAgentViews method.

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

JSON representation 
{
  "agentViews": [
    {
      object (AgentView)
    }
  ],
  "nextPageToken": string
}
Fields
agentViews[]

object (AgentView)

The agent sources visible to the caller under the parent Assistant.
nextPageToken

string

A token that can be sent as ListAvailableAgentViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.