REST Resource: projects.locations.collections.engines.assistants.cannedQueries

리소스: CannedQuery

Assistant의 미리 준비된 쿼리 리소스입니다. 사전 정의된 대화 시작으로 연결되는 바로가기를 나타냅니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "enabled": boolean,
  "googleDefined": boolean
}
필드
name

string

변경할 수 없습니다. 저장된 질문의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

길이 제한이 1,024자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
displayName

string

저장된 쿼리의 표시 이름입니다. 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다.
defaultTexts

object (CannedQueryTexts)

필수 항목입니다. 텍스트 속성의 기본 (현지화되지 않은) 값입니다.
localizedTexts

map (key: string, value: object (CannedQueryTexts))

(선택사항) 텍스트 속성의 번역입니다. 키는 BCP-47 언어 코드여야 합니다.
activationBehavior
(deprecated)

enum (ActivationBehavior)

이 미리 작성된 쿼리가 활성화되었을 때의 동작입니다. 지원 중단되었습니다.
requiredCapabilities[]

object (AssistantCapability)

(선택사항) 이 미리 준비된 질문을 사용하기 위해 어시스턴트가 갖춰야 하는 기능입니다.
icon

string

Google Symbols 라이브러리의 아이콘 이름입니다(상용구 질문).
enabled

boolean

이 사전 정의된 질문이 사용 설정되었는지 여부입니다.
googleDefined

boolean

출력 전용입니다. Google에서 정의한 읽기 전용 사전 정의된 쿼리인지 여부입니다.

CannedQueryTexts

현지화할 수 있는 미리 작성된 질문의 텍스트 부분입니다.

JSON 표현 
{
  "title": string,
  "prefix": string,
  "description": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ],

  // Union field start_message can be only one of the following:
  "suggestedUserQuery": string,
  "assistantMessage": string,
  "userQuery": string
  // End of list of possible types for union field start_message.
}
필드
title

string

필수 항목입니다. 최종 사용자를 위한 제목입니다.
prefix

string

(선택사항) suggestedPrompts가 시작해야 하는 접두사입니다.
description
(deprecated)

string

필수 항목입니다. 최종 사용자를 위한 설명입니다. 지원 중단되었습니다.
suggestedPrompts[]

object (SuggestedPrompt)

필수 항목입니다. 사용자에게 제공할 사전 정의된 질문의 프롬프트입니다.
통합 필드 start_message. 대화 시작으로 사용할 메시지입니다. 지원 중단되었습니다. 대신 suggested_prompts를 사용하세요. start_message은 다음 중 하나여야 합니다.
suggestedUserQuery
(deprecated)

string

지원이 중단되었습니다. 대신 userQuery를 사용하세요. 사용자의 제안된 첫 번째 턴에 대한 미리 작성된 텍스트입니다 (예: '고양이 이미지 생성')
assistantMessage
(deprecated)

string

어시스턴트의 첫 번째 턴에 대한 미리 작성된 텍스트입니다. 이 메시지는 사용자에게 표시되며, 입력 (예: '어떤 종류의 콘텐츠를 만들고 싶으신가요? 예: 이메일, 기사, 프레젠테이션)'을 입력합니다. 지원 중단되었습니다.
userQuery
(deprecated)

string

사용자의 첫 번째 턴에 대한 미리 준비된 텍스트입니다. 지원 중단되었습니다. 대신 suggestedPrompts를 사용하세요.

SuggestedPrompt

사전 제작된 쿼리에 대한 추천 프롬프트입니다.

JSON 표현 
{
  "promptText": string
}
필드
promptText

string

필수 항목입니다. 추천 프롬프트의 텍스트입니다.

ActivationBehavior

이 미리 작성된 쿼리가 활성화되었을 때의 동작입니다. 지원 중단되었습니다.

열거형
ACTIVATION_BEHAVIOR_UNSPECIFIED 기본값이며 사용하면 안 됩니다. 기본값은 NEW_SESSION입니다.
NEW_SESSION 이 사전 설정된 질문을 사용하면 새 어시스턴트 세션이 시작됩니다.
NEW_RESEARCH_ASSISTANT_SESSION 이 미리 작성된 질문을 사용하면 새 조사 어시스턴트 세션이 시작됩니다.

AssistantCapability

이 미리 준비된 질문을 사용하는 데 필요한 어시스턴트 기능입니다.

JSON 표현 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
필드
통합 필드 capability. 어시스턴트의 기능입니다(작업 또는 도구). capability은 다음 중 하나여야 합니다.
actionName

string

이 미리 준비된 질문을 사용하기 위해 어시스턴트가 설정해야 하는 작업의 이름입니다.

메서드

create

 CannedQuery를 만듭니다.

delete

 CannedQuery를 삭제합니다.

get

 CannedQuery을 가져옵니다.

list

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

listActiveCannedQueryUserViews

 모든 활성 CannedQuery의 CannedQueryUserView를 나열합니다.

patch

 CannedQuery을 업데이트합니다.