settings

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

Overview

Name	settings
Type	Resource
Id	google.contactcenterinsights.settings

Fields

The following fields are returned by SELECT queries:

get_settings

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
analysisConfig	object	Default analysis settings. (id: GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig)
conversationTtl	string (google-duration)	The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.
createTime	string (google-datetime)	Output only. The time at which the settings was created.
languageCode	string	A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here.
pubsubNotificationSettings	object	A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "ingest-conversations": Notify each time an IngestConversations LRO is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO is complete. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
redactionConfig	object	Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform. (id: GoogleCloudContactcenterinsightsV1RedactionConfig)
speechConfig	object	Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the UploadConversation and IngestConversations endpoints, including conversations coming from CCAI Platform. (id: GoogleCloudContactcenterinsightsV1SpeechConfig)
updateTime	string (google-datetime)	Output only. The time at which the settings were last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_settings	select	projectsId, locationsId		Gets project-level settings.
update_settings	update	projectsId, locationsId	updateMask	Updates project-level settings.

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
locationsId	string
projectsId	string
updateMask	string (google-fieldmask)

SELECT examples

get_settings

Gets project-level settings.

SELECT
name,
analysisConfig,
conversationTtl,
createTime,
languageCode,
pubsubNotificationSettings,
redactionConfig,
speechConfig,
updateTime
FROM google.contactcenterinsights.settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

update_settings

Updates project-level settings.

UPDATE google.contactcenterinsights.settings
SET 
data__name = '{{ name }}',
data__languageCode = '{{ languageCode }}',
data__conversationTtl = '{{ conversationTtl }}',
data__pubsubNotificationSettings = '{{ pubsubNotificationSettings }}',
data__analysisConfig = '{{ analysisConfig }}',
data__redactionConfig = '{{ redactionConfig }}',
data__speechConfig = '{{ speechConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
analysisConfig,
conversationTtl,
createTime,
languageCode,
pubsubNotificationSettings,
redactionConfig,
speechConfig,
updateTime;