REST Resource: projects.locations.apps.conversations

리소스: Conversation

대화는 최종 사용자와 CES 앱 간의 상호작용을 나타냅니다.

JSON 표현 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "turns": [
    {
      object (Conversation.Turn)
    }
  ],
  "turnCount": integer,
  "channelType": enum (Conversation.ChannelType),
  "source": enum (Conversation.Source),
  "inputTypes": [
    enum (Conversation.InputType)
  ],
  "entryAgent": string,
  "deployment": string,
  "appVersion": string,
  "languageCode": string,
  "messages": [
    {
      object (Message)
    }
  ]
}
필드
name

string

식별자. 대화의 고유 식별자입니다. 형식: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
startTime

string (Timestamp format)

출력 전용입니다. 대화가 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
endTime

string (Timestamp format)

출력 전용입니다. 대화가 완료된 시점의 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
turns[]

object (Conversation.Turn)

필수 항목입니다. 대화의 턴입니다.
turnCount

integer

출력 전용입니다. 대화의 턴 수입니다.
channelType
(deprecated)

enum (Conversation.ChannelType)

DEPRECATED. 대신 inputTypes를 사용하세요.
source

enum (Conversation.Source)

출력 전용입니다. 대화의 소스를 표시합니다.
inputTypes[]

enum (Conversation.InputType)

출력 전용입니다. 대화의 입력 유형입니다.
entryAgent

string

출력 전용입니다. 대화를 처음 처리하는 상담사입니다. 지정하지 않으면 루트 에이전트가 대화를 처리합니다. 형식: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

출력 전용입니다. 대화 처리에 사용되는 앱의 배포입니다. 형식: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
appVersion

string

출력 전용입니다. 대화를 처리하는 데 사용된 앱의 버전입니다. 형식: projects/{project}/locations/{location}/apps/{app}/versions/{version}
languageCode

string

출력 전용입니다. 대화의 언어 코드입니다.
messages[]
(deprecated)

object (Message)

지원 중단되었습니다. 대신 턴을 사용하세요.

Conversation.Turn

대화의 단일 턴에 관한 모든 정보입니다.

JSON 표현 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  },
  "userIntendedText": string
}
필드
messages[]

object (Message)

선택사항입니다. 처리 중 사용자 입력, 에이전트 응답, 중간 이벤트를 포함한 대화 턴의 메시지 목록입니다.
rootSpan

object (Span)

선택사항입니다. 작업 처리의 루트 스팬입니다.
userIntendedText

string

선택사항입니다. 시뮬레이션된 호출자 (Polysynth)의 의도된 정답 텍스트입니다. 단어 오류율 측정항목이 사용 설정된 경우에만 채워집니다.

스팬

스팬은 요청 처리 중의 작업 단위 또는 단일 작업입니다.

JSON 표현 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
필드
name

string

출력 전용입니다. 스팬의 이름입니다.
startTime

string (Timestamp format)

출력 전용입니다. 스팬의 시작 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
endTime

string (Timestamp format)

출력 전용입니다. 스팬의 종료 시간입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
duration

string (Duration format)

출력 전용입니다. 스팬의 지속 시간입니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
attributes

object (Struct format)

출력 전용입니다. 스팬과 연결된 키-값 속성입니다.
childSpans[]

object (Span)

출력 전용입니다. 이 스팬 아래에 중첩된 하위 스팬입니다.

Conversation.ChannelType

대화의 채널 유형입니다.

열거형
CHANNEL_TYPE_UNSPECIFIED 지정되지 않은 채널 유형입니다.
TEXT 대화에는 최종 사용자와 상담사 간의 문자 메시지만 포함됩니다.
AUDIO 대화에 최종 사용자와 에이전트 간의 오디오 메시지가 포함되어 있습니다.
MULTIMODAL 최종 사용자와 에이전트 간의 대화 멀티모달 메시지 (예: 이미지)입니다.

Conversation.Source

대화의 소스입니다.

열거형
SOURCE_UNSPECIFIED 지정되지 않은 소스입니다.
LIVE 실제 최종 사용자의 대화입니다.
SIMULATOR 시뮬레이터에서 시작된 대화입니다.
EVAL 평가에서 나온 대화입니다.
AGENT_TOOL 대화가 상담사 도구에서 시작되었습니다. 에이전트 도구는 테스트 및 디버깅 목적으로 유지되는 별도의 세션에서 에이전트를 실행합니다.

Conversation.InputType

입력 메시지 유형입니다.

열거형
INPUT_TYPE_UNSPECIFIED 지정되지 않은 입력 유형입니다.
INPUT_TYPE_TEXT 텍스트 입력
INPUT_TYPE_EVENT 이벤트 입력입니다.
INPUT_TYPE_AUDIO 오디오 입력입니다.
INPUT_TYPE_IMAGE 이미지 입력입니다.
INPUT_TYPE_BLOB Blob 입력입니다.
INPUT_TYPE_TOOL_RESPONSE 클라이언트 함수 도구 응답 입력입니다.
INPUT_TYPE_VARIABLES 변수 입력

메서드

batchDelete

 지정된 대화를 일괄 삭제합니다.

delete

 지정된 대화를 삭제합니다.

get

 지정된 대화의 세부정보를 가져옵니다.

list

 지정된 앱의 대화를 나열합니다.