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

모든 활성 CannedQueryCannedQueryUserView를 나열합니다.

HTTP 요청

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

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

경로 매개변수

파라미터
parent

string

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

쿼리 파라미터

파라미터
languageCode

string

(선택사항) 사전 정의된 질문이 반환되어야 하는 언어 코드입니다. 여기에 지정되지 않았거나 해당 번역을 찾을 수 없는 경우 기본 텍스트가 반환됩니다.

pageSize

integer

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

pageToken

string

이전 CannedQueryService.ListActiveCannedQueryUserViews 호출에서 받은 ListActiveCannedQueryUserViewsResponse.next_page_token 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

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

요청 본문

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

응답 본문

CannedQueryService.ListActiveCannedQueryUserViews 메서드의 응답 메시지입니다.

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

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

object (CannedQueryUserView)

활성 (기존, 사용 설정, 기능 충족) 사전 정의된 쿼리를 나타내는 CannedQueryUserView입니다.

nextPageToken

string

다음 페이지를 검색하기 위해 ListActiveCannedQueryUserViewsRequest.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를 참조하세요.

CannedQueryUserView

최종 사용자에게 충분한 CannedQuery에 관한 제한된 정보

JSON 표현
{
  "cannedQuery": string,
  "localizedTexts": {
    object (CannedQueryTexts)
  }
}
필드
cannedQuery

string

이 뷰가 속한 CannedQuery의 리소스 이름입니다. 지원 요청의 미리 준비된 질문을 식별합니다.

형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

localizedTexts

object (CannedQueryTexts)

미리 준비된 쿼리의 현지화된 텍스트입니다.