conversations

Creates, updates, deletes, gets or lists a conversations resource.

Overview

Name	conversations
Type	Resource
Id	google.ces.conversations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
appVersion	string	Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
channelType	string	DEPRECATED. Please use input_types instead. (CHANNEL_TYPE_UNSPECIFIED, TEXT, AUDIO, MULTIMODAL)
deployment	string	Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
endTime	string (google-datetime)	Output only. Timestamp when the conversation was completed.
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}
inputTypes	array	Output only. The input types of the conversation.
languageCode	string	Output only. The language code of the conversation.
messages	array	Deprecated. Use turns instead.
source	string	Output only. Indicate the source of the conversation. (SOURCE_UNSPECIFIED, LIVE, SIMULATOR, EVAL, AGENT_TOOL)
startTime	string (google-datetime)	Output only. Timestamp when the conversation was created.
turnCount	integer (int32)	Output only. The number of turns in the conversation.
turns	array	Required. The turns in the conversation.

list

Name	Datatype	Description
name	string	Identifier. The unique identifier of the conversation. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
appVersion	string	Output only. The version of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
channelType	string	DEPRECATED. Please use input_types instead. (CHANNEL_TYPE_UNSPECIFIED, TEXT, AUDIO, MULTIMODAL)
deployment	string	Output only. The deployment of the app used for processing the conversation. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
endTime	string (google-datetime)	Output only. Timestamp when the conversation was completed.
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}
inputTypes	array	Output only. The input types of the conversation.
languageCode	string	Output only. The language code of the conversation.
messages	array	Deprecated. Use turns instead.
source	string	Output only. Indicate the source of the conversation. (SOURCE_UNSPECIFIED, LIVE, SIMULATOR, EVAL, AGENT_TOOL)
startTime	string (google-datetime)	Output only. Timestamp when the conversation was created.
turnCount	integer (int32)	Output only. The number of turns in the conversation.
turns	array	Required. The turns in the conversation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, appsId, conversationsId	source	Gets details of the specified conversation.
list	select	projectsId, locationsId, appsId	source, sources, filter, pageSize, pageToken	Lists conversations in the given app.
delete	delete	projectsId, locationsId, appsId, conversationsId	source	Deletes the specified conversation.
batch_delete	delete	projectsId, locationsId, appsId		Batch deletes the specified conversations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appsId	string
conversationsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
source	string
sources	string

SELECT examples

get

Gets details of the specified conversation.

SELECT
name,
appVersion,
channelType,
deployment,
endTime,
entryAgent,
inputTypes,
languageCode,
messages,
source,
startTime,
turnCount,
turns
FROM google.ces.conversations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND conversationsId = '{{ conversationsId }}' -- required
AND source = '{{ source }}'
;

list

Lists conversations in the given app.

SELECT
name,
appVersion,
channelType,
deployment,
endTime,
entryAgent,
inputTypes,
languageCode,
messages,
source,
startTime,
turnCount,
turns
FROM google.ces.conversations
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND source = '{{ source }}'
AND sources = '{{ sources }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

DELETE examples

delete

Deletes the specified conversation.

DELETE FROM google.ces.conversations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
AND conversationsId = '{{ conversationsId }}' --required
AND source = '{{ source }}'
;

batch_delete

Batch deletes the specified conversations.

DELETE FROM google.ces.conversations
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appsId = '{{ appsId }}' --required
;