REST Resource: projects.locations.conversations

Resource: Conversation

The conversation resource.

JSON representation 
{
  "name": string,
  "dataSource": {
    object (ConversationDataSource)
  },
  "createTime": string,
  "updateTime": string,
  "startTime": string,
  "languageCode": string,
  "agentId": string,
  "customerId": string,
  "labels": {
    string: string,
    ...
  },
  "qualityMetadata": {
    object (QualityMetadata)
  },
  "metadataJson": string,
  "transcript": {
    object (Transcript)
  },
  "medium": enum (Medium),
  "duration": string,
  "turnCount": integer,
  "latestAnalysis": {
    object (Analysis)
  },
  "latestSummary": {
    object (ConversationSummarizationSuggestionData)
  },
  "runtimeAnnotations": [
    {
      object (RuntimeAnnotation)
    }
  ],
  "dialogflowIntents": {
    string: {
      object (DialogflowIntent)
    },
    ...
  },
  "obfuscatedUserId": string,
  "dialogflowCxConversationData": {
    object (DialogflowCxConversationData)
  },

  // Union field metadata can be only one of the following:
  "callMetadata": {
    object (CallMetadata)
  }
  // End of list of possible types for union field metadata.

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Fields
name

string

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
dataSource

object (ConversationDataSource)

The source of the audio and transcription for the conversation.
createTime

string (Timestamp format)

Output only. The time at which the conversation was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The most recent time at which the conversation was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startTime

string (Timestamp format)

The time at which the conversation started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
languageCode

string

A user-specified language code for the conversation.
agentId

string

An opaque, user-specified string representing the human agent who handled the conversation.
customerId

string

An opaque, user-specified string representing the customer identifier.
labels

map (key: string, value: string)

A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
qualityMetadata

object (QualityMetadata)

Conversation metadata related to quality management.
metadataJson

string

Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
transcript

object (Transcript)

Output only. The conversation transcript.
medium

enum (Medium)

Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
duration

string (Duration format)

Output only. The duration of the conversation.

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

integer

Output only. The number of turns in the conversation.
latestAnalysis

object (Analysis)

Output only. The conversation's latest analysis, if one exists.
latestSummary

object (ConversationSummarizationSuggestionData)

Output only. Latest summary of the conversation.
runtimeAnnotations[]

object (RuntimeAnnotation)

Output only. The annotations that were generated during the customer and agent interaction.
dialogflowIntents

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

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
obfuscatedUserId

string

Obfuscated user ID which the customer sent to us.
dialogflowCxConversationData

object (DialogflowCxConversationData)

The Dialogflow conversation raw data. It will only be populated when ConversationView is DF_CONVERSATION_BASIC or DF_CONVERSATION_FULL.
Union field metadata. Metadata that applies to the conversation. metadata can be only one of the following:
callMetadata

object (CallMetadata)

Call-specific metadata.
Union field expiration. A time to live expiration setting, can be either a specified timestamp or a duration from the time that the conversation creation request was received. Conversations with an expiration set will be removed up to 24 hours after the specified time. expiration can be only one of the following:
expireTime

string (Timestamp format)

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.

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

Methods

bulkAnalyze

 Analyzes multiple conversations in a single request.

bulkDelete

 Deletes multiple conversations in a single request.

calculateStats

 Gets conversation statistics.

create

 Creates a conversation.

delete

 Deletes a conversation.

get

 Gets a conversation.

ingest

 Imports conversations and processes them according to the user's configuration.

list

 Lists conversations.

patch

 Updates a conversation.

upload

 Create a long-running conversation upload operation.