EventHandler

이벤트 후에 실행할 핸들러를 정의합니다. 이벤트의 예로는 장면의 인텐트 및 조건 기반 이벤트가 있습니다.

YAML 표현 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
필드
webhookHandler

string

호출할 웹훅 핸들러의 이름입니다.
통합 필드 prompt는 프롬프트는 인라인 처리하거나 이름으로 참조할 수 있습니다. prompt은 다음 중 하나여야 합니다.
staticPrompt

object (StaticPrompt)

인라인 정적 프롬프트 번들의 문자열 리소스에 대한 참조를 포함할 수 있습니다.
staticPromptName

string

호출할 정적 프롬프트의 이름입니다.

정적 프롬프트

프롬프트 후보 목록을 나타내며, 그 중 하나는 사용자의 응답에 표시할 메시지로 선택됩니다. 이 메시지는 현지화할 수 있습니다.

YAML 표현 
candidates: 
  - object (StaticPromptCandidate)
필드
candidates[]

object (StaticPromptCandidate)

클라이언트에 전송할 후보 메시지 목록입니다. 각 메시지에는 사용할 수 있는 시점을 결정하는 선택기가 있습니다. 요청과 일치하는 첫 번째 선택기가 전송되고 나머지는 무시됩니다.

정적 프롬프트 후보

정적 프롬프트 후보를 나타냅니다.

YAML 표현 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
필드
selector

object (Selector)

선택사항입니다. 이 프롬프트가 요청과 일치하는지 여부에 대한 기준입니다. 선택기가 비어 있으면 이 메시지가 항상 트리거됩니다.
promptResponse

object (StaticPromptResponse)

선택기와 연결된 프롬프트 응답입니다.

선택기

프롬프트가 요청과 일치하는지 여부에 대한 기준을 정의합니다.

YAML 표현 
surfaceCapabilities: 
  object (SurfaceCapabilities)
필드
surfaceCapabilities

object (SurfaceCapabilities)

필요한 노출 영역 기능 모음입니다.

노출 영역 기능

사용자가 작업에 요청하는 데 사용하는 노출 영역을 나타냅니다.

YAML 표현 
capabilities: 
  - enum (Capability)
필드
capabilities[]

enum (Capability)

필수 항목입니다. 노출 영역에 작업을 요청하는 기능

정적 프롬프트 응답

텍스트, 음성, 카드, 캔버스 데이터, 추천 검색어 칩 등 사용자에게 전송할 구조화된 응답을 나타냅니다.

YAML 표현 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
필드
firstSimple

object (StaticSimplePrompt)

선택사항입니다. 첫 번째 음성 및 텍스트 전용 응답입니다.
content

object (StaticContentPrompt)

선택사항입니다. 카드, 목록 또는 미디어와 같은 콘텐츠가 사용자에게 표시됩니다.
lastSimple

object (StaticSimplePrompt)

선택사항입니다. 마지막 음성 및 텍스트 전용 응답입니다.
suggestions[]

object (Suggestion)

선택사항입니다. 응답 마지막 부분에 항상 표시되는 제안이 사용자에게 표시됩니다. 포함된 메시지의 append 필드가 true인 경우 이 필드에 정의된 제목이 이전에 정의된 추천 프롬프트 메시지에 정의된 제목에 추가되고 중복 값이 삭제됩니다.
override

boolean

선택사항입니다. 이 메시지를 이전에 정의한 메시지와 병합하는 방법 true에서 이전에 정의한 모든 메시지 (처음과 마지막 단순, 콘텐츠, 추천 링크, 캔버스)를 삭제하고 이 메시지에 정의된 메시지를 추가합니다. false는 이 메시지에 정의된 메시지를 이전 응답에 정의된 메시지에 추가합니다. 이 필드를 false로 설정하면 간단한 프롬프트, 추천 메시지, 캔버스 메시지 (콘텐츠 메시지의 일부) 내의 일부 필드에도 추가할 수 있습니다. 메시지에 정의된 콘텐츠 및 링크 메시지는 항상 덮어쓰기됩니다. 기본값은 false입니다.
canvas

object (StaticCanvasPrompt)

대화형 캔버스 환경에 사용되는 응답입니다.

정적 단순 프롬프트

사용자에게 전송할 간단한 프롬프트를 나타냅니다.

YAML 표현 
variants: 
  - object (Variant)
필드
variants[]

object (Variant)

가능한 변형 목록입니다.

대안

단순 프롬프트의 일부인 변형을 나타냅니다.

YAML 표현 
speech: string
text: string
필드
speech

string

선택사항입니다. 사용자에게 말할 음성을 나타냅니다. SSML 또는 TTS(텍스트 음성 변환)일 수 있습니다. 기본적으로 음성은 이전의 단순 프롬프트 음성에 추가됩니다. 포함하는 메시지의 override 필드가 true인 경우 이 필드에 정의된 음성이 이전의 간단한 프롬프트의 음성보다 우선 적용됩니다.
text

string

선택사항입니다. 채팅 풍선에 표시할 텍스트입니다. 지정하지 않으면 위의 음성 필드의 디스플레이 렌더링이 사용됩니다. 640자(영문 기준)로 제한됩니다. 기본적으로 텍스트는 이전 단순 프롬프트 텍스트에 추가됩니다. 포함하는 메시지의 override 필드가 true인 경우 이 필드에 정의된 텍스트가 이전 단순 메시지의 텍스트보다 우선 적용됩니다.

정적 콘텐츠 메시지

StaticPrompt 콘텐츠 부분의 자리표시자입니다.

YAML 표현 
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
필드
통합 필드 content는 메시지에는 한 가지 유형의 콘텐츠만 표시될 수 있습니다. content은 다음 중 하나여야 합니다.
card

object (StaticCardPrompt)

기본 카드입니다.
image

object (StaticImagePrompt)

이미지입니다.
table

object (StaticTablePrompt)

표 카드
media

object (StaticMediaPrompt)

재생할 미디어 집합을 나타내는 응답입니다.
list

object (StaticListPrompt)

선택할 수 있는 옵션 목록을 표시하는 카드입니다.
collection

object (StaticCollectionPrompt)

선택할 수 있는 옵션 목록이 표시된 카드입니다.
collectionBrowse

object (StaticCollectionBrowsePrompt)

열려는 웹페이지 모음을 보여주는 카드입니다.

정적 카드 프롬프트

이미지, 텍스트 등 일부 정보를 표시하기 위한 기본 카드입니다.

YAML 표현 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
필드
title

string

선택사항입니다. 카드의 전체 제목
subtitle

string

선택사항입니다. 카드 부제
text

string

필수 항목입니다. 이미지가 없는 한 필요한 카드의 본문 텍스트입니다. 형식을 위한 제한된 마크다운 구문 세트를 지원합니다.
image

object (StaticImagePrompt)

선택사항입니다. 카드의 히어로 이미지입니다. 높이는 192dp로 고정되어 있습니다.
imageFill

enum (ImageFill)

선택사항입니다. 이미지 배경이 채워지는 방식입니다.
button

object (StaticLinkPrompt)

선택사항입니다. 카드에 표시되는 클릭 가능한 버튼입니다.

정적 이미지 프롬프트

카드에 표시된 이미지

YAML 표현 
url: string
alt: string
height: integer
width: integer
필드
url

string

필수 항목입니다. 이미지의 소스 URL입니다. 이미지는 JPG, PNG, GIF (애니메이션 및 비애니메이션)일 수 있습니다. 예: https://www.agentx.com/logo.png
alt

string

필수 항목입니다. 접근성을 위해 사용되는 이미지의 텍스트 설명입니다(예: 스크린 리더).
height

integer

선택사항입니다. 이미지 높이(픽셀 단위)입니다.
width

integer

선택사항입니다. 이미지 너비(픽셀 단위)입니다.

정적 링크 프롬프트

추천 칩으로 표시되고 사용자가 열 수 있는 링크를 정의합니다.

YAML 표현 
name: string
open: 
  object (OpenUrl)
필드
name

string

링크 이름
open

object (OpenUrl)

사용자가 링크를 여는 동작을 정의합니다.

OpenUrl

사용자가 링크를 여는 동작을 정의합니다.

YAML 표현 
url: string
hint: enum (UrlHint)
필드
url

string

URL 필드: - 앱에 연결된 앱 또는 웹페이지를 여는 http/https URL
hint

enum (UrlHint)

URL 유형의 힌트를 나타냅니다.

정적 테이블 프롬프트

텍스트 표를 표시하는 표 카드

YAML 표현 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
필드
title

string

선택사항입니다. 테이블의 전체 제목입니다. 부제목이 설정된 경우 설정해야 합니다.
subtitle

string

선택사항입니다. 표의 부제목입니다.
image

object (StaticImagePrompt)

선택사항입니다. 테이블과 연결된 이미지입니다.
columns[]

object (TableColumn)

선택사항입니다. 헤더의 헤더 및 정렬
rows[]

object (TableRow)

선택사항입니다. 테이블의 행 데이터 처음 3개 행은 항상 표시되지만 일부 노출 영역에서 일부 행이 잘릴 수 있습니다. 시뮬레이터에서 테스트하여 표시 경로에 어떤 행이 표시되는지 확인하세요. WEB_BROWSER 기능을 지원하는 노출 영역에서 사용자를 더 많은 데이터가 있는 웹페이지를 가리키도록 할 수 있습니다.
button

object (StaticLinkPrompt)

선택사항입니다. 버튼입니다.

테이블 열

테이블의 열을 설명합니다.

YAML 표현 
header: string
align: enum (HorizontalAlignment)
필드
header

string

열의 헤더 텍스트입니다.
align

enum (HorizontalAlignment)

wr.t 열의 콘텐츠 가로 정렬 지정하지 않으면 콘텐츠가 선행 가장자리에 정렬됩니다.

TableRow

테이블의 행을 설명합니다.

YAML 표현 
cells: 
  - object (TableCell)
divider: boolean
필드
cells[]

object (TableCell)

이 행의 셀입니다. 처음 3개의 셀은 항상 표시되나, 일부 표면에서는 잘릴 수 있습니다. 시뮬레이터를 사용하여 특정 표면에 표시되는 셀을 확인하세요.
divider

boolean

각 행 뒤에 구분선이 있어야 하는지를 나타냅니다.

TableCell

행에 있는 셀을 설명합니다.

YAML 표현 
text: string
필드
text

string

셀의 텍스트 콘텐츠입니다.

정적 미디어 프롬프트

이름, 설명, URL 등 미디어 관련 정보가 포함됩니다. 다음 ID: 11

YAML 표현 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
필드
mediaType

enum (MediaType)

이 응답의 미디어 유형입니다.
startOffset

string (Duration format)

첫 번째 미디어 객체의 시작 오프셋입니다.

초 단위 기간으로, 소수점 아래 9자리까지 지정 가능하며 's'로 끝납니다(예: "3.5s").
optionalMediaControls[]

enum (OptionalMediaControls)

이 미디어 응답 세션에서 지원할 수 있는 미디어 컨트롤 유형입니다(선택사항). 이 속성을 설정하면 특정 미디어 이벤트가 발생할 때 요청이 3p로 전달됩니다. 설정되지 않아도 서드 파티는 두 가지 기본 컨트롤 유형인 FINISHED 및 FAILED를 처리해야 합니다.
mediaObjects[]

object (MediaObject)

미디어 객체 목록
repeatMode

enum (RepeatMode)

미디어 객체 목록에 대한 반복 모드입니다.

미디어 객체

단일 미디어 객체를 나타냅니다.

YAML 표현 
name: string
description: string
url: string
image: 
  object (MediaImage)
필드
name

string

이 미디어 객체의 이름입니다.
description

string

이 미디어 객체에 대한 설명입니다.
url

string

미디어 콘텐츠를 가리키는 URL입니다.
image

object (MediaImage)

미디어 카드와 함께 표시할 이미지입니다.

미디어 이미지

MediaPrompt 내에 표시할 이미지

YAML 표현 
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
필드
통합 필드 image는 MediaImage 유형은 한 가지만 허용됩니다. image은 다음 중 하나여야 합니다.
large

object (StaticImagePrompt)

앨범의 표지 등 큰 이미지
icon

object (StaticImagePrompt)

제목 오른쪽에 표시되는 작은 이미지 아이콘 36x36dp로 크기가 조정됩니다.

정적 목록 프롬프트

선택할 수 있는 옵션 목록을 표시하는 카드입니다.

YAML 표현 
title: string
subtitle: string
items: 
  - object (ListItem)
필드
title

string

선택사항입니다. 목록의 제목입니다.
subtitle

string

선택사항입니다. 목록의 부제목입니다.
items[]

object (ListItem)

필수 항목입니다. 목록 항목입니다.

ListItem

목록의 항목입니다.

YAML 표현 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
필드
key

string

필수 항목입니다. 연결된 유형의 항목 키 이름과 일치하는 NLU 키입니다. 항목을 탭하면 이 키가 옵션 선택 매개변수로 다시 게시됩니다.
title

string

필수 항목입니다. 상품의 제목입니다. 이 텍스트를 탭하면 사용자가 입력한 것처럼 대화에 그대로 게시됩니다. 각 제목은 항목 집합에서 고유해야 합니다.
description

string

선택사항입니다. 항목의 본문 텍스트
image

object (StaticImagePrompt)

선택사항입니다. 항목 이미지입니다.

정적 수집 프롬프트

선택할 수 있는 옵션 모음을 표시하는 카드입니다.

YAML 표현 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
필드
title

string

선택사항입니다. 컬렉션의 제목입니다.
subtitle

string

선택사항입니다. 컬렉션의 부제목입니다.
items[]

object (CollectionItem)

필수 항목입니다. 컬렉션 항목
imageFill

enum (ImageFill)

선택사항입니다. 이미지 표시 옵션의 유형입니다.

컬렉션 항목

컬렉션의 항목입니다.

YAML 표현 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
필드
key

string

필수 항목입니다. 연결된 유형의 항목 키 이름과 일치하는 NLU 키입니다. 항목을 탭하면 이 키가 옵션 선택 매개변수로 다시 게시됩니다.
title

string

필수 항목입니다. 상품의 제목입니다. 이 텍스트를 탭하면 사용자가 입력한 것처럼 대화에 그대로 게시됩니다. 각 제목은 항목 집합에서 고유해야 합니다.
description

string

선택사항입니다. 항목의 본문 텍스트
image

object (StaticImagePrompt)

선택사항입니다. 항목 이미지입니다.

정적 컬렉션 찾아보기 프롬프트

대규모 타일 항목의 모음으로 웹 문서 집합을 표시합니다. 웹 뷰어에서 연결된 웹 문서를 실행하도록 항목을 선택할 수 있습니다.

YAML 표현 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
필드
items[]

object (CollectionBrowseItem)

탐색 컬렉션의 항목입니다. 목록 크기는 [2, 10] 범위 내에 있어야 합니다.
imageFill

enum (ImageFill)

컬렉션의 이미지 표시 옵션입니다.

컬렉션 탐색 항목

컬렉션의 항목입니다.

YAML 표현 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
필드
title

string

필수 항목입니다. 컬렉션 항목의 제목입니다.
description

string

컬렉션 항목에 대한 설명입니다.
footer

string

컬렉션 항목의 바닥글 텍스트로, 설명 아래에 표시됩니다. 줄임표로 잘린 단일 텍스트 행.
image

object (StaticImagePrompt)

컬렉션 항목의 이미지입니다.
openUriAction

object (OpenUrl)

필수 항목입니다. 항목이 선택된 경우 열 URI입니다.

제안

편의상 사용자에게 표시되는 UI 요소인 추천 검색어 칩을 나타냅니다.

YAML 표현 
title: string
필드
title

string

필수 항목입니다. 추천 검색어 칩에 표시되는 텍스트입니다. 이 텍스트를 탭하면 사용자가 입력한 것처럼 대화에 그대로 게시됩니다. 각 제목은 추천 검색어 칩 세트에서 고유해야 합니다. 최대 25자(영문 기준)

정적 캔버스 프롬프트

사용자에게 전송할 Interactive Canvas 응답을 나타냅니다. 대화형 캔버스 응답을 표시할 뿐만 아니라 포함하는 메시지의 firstSimple 필드와 함께 사용하여 사용자에게 말할 수도 있습니다.

YAML 표현 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
필드
url

string

필수 항목입니다. 로드할 웹 뷰의 URL입니다.
data[]

value (Value format)

선택사항입니다. 이벤트로 몰입형 환경 웹페이지에 전달되는 JSON 데이터입니다. 포함 프롬프트의 override 필드가 false인 경우 이 캔버스 프롬프트에 정의된 데이터 값이 이전 Canvas 프롬프트에 정의된 데이터 값 뒤에 추가됩니다.
suppressMic

boolean

선택사항입니다. true 값은 이 몰입형 응답이 사용자에게 표시된 후 입력을 캡처하기 위해 마이크가 열리지 않음을 의미합니다.
sendStateDataToCanvasApp

boolean

선택사항입니다. true인 경우 대화 관련 메타데이터가 포함되고 캔버스 애플리케이션으로 다시 전송됩니다.
enableFullScreen

boolean

선택사항입니다. true인 경우 캔버스 애플리케이션이 전체 화면을 차지하며 상단에 헤더가 없습니다. 또한 작업의 표시 이름, 개발자 이름, 작업 종료 안내가 포함된 토스트 메시지가 로드 화면에 표시됩니다. 기본값은 false입니다.
continueTtsDuringTouch

boolean

선택사항입니다. true인 경우 전체 화면 세션의 화면 TTS는 중단되지 않습니다. 기본값은 false입니다.