REST Resource: projects.locations.apps.conversations

Resource: Conversation

A conversation represents an interaction between an end user and the CES app.

JSON representation 
{
  "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)
    }
  ]
}
Fields
name

string

Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
startTime

string (Timestamp format)

Output only. Timestamp when the conversation was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. Timestamp when the conversation was completed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
turns[]

object (Conversation.Turn)

Required. The turns in the conversation.
turnCount

integer

Output only. The number of turns in the conversation.
channelType
(deprecated)

enum (Conversation.ChannelType)

DEPRECATED. Please use inputTypes instead.
source

enum (Conversation.Source)

Output only. Indicate the source of the conversation.
inputTypes[]

enum (Conversation.InputType)

Output only. The input types of the conversation.
entryAgent

string

Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment

string

Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
appVersion

string

Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
languageCode

string

Output only. The language code of the conversation.
messages[]
(deprecated)

object (Message)

Deprecated. Use turns instead.

Conversation.Turn

All information about a single turn in the conversation.

JSON representation 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "rootSpan": {
    object (Span)
  }
}
Fields
messages[]

object (Message)

Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.
rootSpan

object (Span)

Optional. The root span of the action processing.

Span

A span is a unit of work or a single operation during the request processing.

JSON representation 
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "duration": string,
  "attributes": {
    object
  },
  "childSpans": [
    {
      object (Span)
    }
  ]
}
Fields
name

string

Output only. The name of the span.
startTime

string (Timestamp format)

Output only. The start time of the span.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Output only. The end time of the span.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
duration

string (Duration format)

Output only. The duration of the span.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
attributes

object (Struct format)

Output only. Key-value attributes associated with the span.
childSpans[]

object (Span)

Output only. The child spans that are nested under this span.

Conversation.ChannelType

The channel type of the conversation.

Enums
CHANNEL_TYPE_UNSPECIFIED Unspecified channel type.
TEXT The conversation only contains text messages between the end user and the agent.
AUDIO The conversation contains audio messages between the end user and the agent.
MULTIMODAL The conversation multi-modal messages (e.g. image) between the end user and the agent.

Conversation.Source

The source of the conversation.

Enums
SOURCE_UNSPECIFIED Unspecified source.
LIVE The conversation is from the live end user.
SIMULATOR The conversation is from the simulator.
EVAL The conversation is from the evaluation.

Conversation.InputType

Type of the input message.

Enums
INPUT_TYPE_UNSPECIFIED Unspecified input type.
INPUT_TYPE_TEXT The input message is text.
INPUT_TYPE_AUDIO The input message is audio.
INPUT_TYPE_IMAGE The input message is image.
INPUT_TYPE_BLOB The input message is blob file.

Methods

batchDelete

 Batch deletes the specified conversations.

delete

 Deletes the specified conversation.

get

 Gets details of the specified conversation.

list

 Lists conversations in the given app.