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

Assistant 아래의 모든 CannedQuery를 나열합니다.

HTTP 요청

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

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

경로 매개변수

매개변수
parent

string

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

쿼리 매개변수

매개변수
filter

string

(선택사항) 필터 표현식입니다.

지원되는 필드:

  • enabled
  • googleDefined

예:

  • enabled=true
  • googleDefined=true
  • enabled=true AND googleDefined=true
pageSize

integer

반환할 최대 사전 정의된 질문 수입니다. 지정하지 않으면 기본값은 100입니다. 허용되는 최댓값은 1,000이며, 이 값을 초과하는 값은 1,000으로 변환됩니다.
pageToken

string

이전 CannedQueryService.ListCannedQueries 호출에서 수신한 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

요청 본문

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

응답 본문

CannedQueryService.ListCannedQueries 메서드에 대한 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "cannedQueries": [
    {
      object (CannedQuery)
    }
  ],
  "nextPageToken": string
}
필드
cannedQueries[]

object (CannedQuery)

요청과 일치하는 CannedQuery 목록입니다.
nextPageToken

string

다음 페이지를 검색하기 위해 ListCannedQueriesRequest.page_token으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

다음 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를 참조하세요.