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

호출자가 만든 Assistant의 모든 Agent를 나열합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 상위 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

쿼리 매개변수

매개변수
pageSize

integer

(선택사항) 반환할 최대 Agent 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1,000이며, 이 값을 초과하는 값은 1,000으로 변환됩니다.
pageToken

string

(선택사항) 이전 AgentService.ListAgents 호출에서 받은 ListAgentsResponse.next_page_token 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 매길 때 agents.list에 제공된 다른 모든 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.
orderBy

string

(선택사항) 정렬할 필드의 쉼표로 구분된 목록입니다. 오름차순으로 정렬됩니다. 필드 이름 뒤에 'desc'를 사용하여 내림차순으로 정렬합니다. 지원되는 필드:

  • updateTime
  • isPinned

예:

  • 'updateTime desc'
  • 'isPinned desc,updateTime desc': isPinned를 기준으로 먼저 에이전트를 나열한 다음 updateTime을 기준으로 나열합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문에 ListAgentsResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.agents.list

자세한 내용은 IAM 문서를 참조하세요.