Settings

The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with getsettings and change the settings with updateSettings.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "languageCode": string,
  "conversationTtl": string,
  "pubsubNotificationSettings": {
    string: string,
    ...
  },
  "analysisConfig": {
    object (AnalysisConfig)
  },
  "enableCustomerAgentDetection": boolean,
  "redactionConfig": {
    object (RedactionConfig)
  },
  "speechConfig": {
    object (SpeechConfig)
  }
}
Fields
name

string

Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
createTime

string (Timestamp format)

Output only. The time at which the settings 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 time at which the settings were last 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".
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.
conversationTtl

string (Duration format)

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.

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

map (key: string, value: string)

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}

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

object (AnalysisConfig)

Default analysis settings.
enableCustomerAgentDetection

boolean

Whether to enable customer-agent detection. If specified, then Insights will infer which speakers are customers and which are agents when a conversation is created. If a conversation specifies the roles of the speakers, then those roles will be used instead of the detection.
redactionConfig

object (RedactionConfig)

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.
speechConfig

object (SpeechConfig)

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.

AnalysisConfig

Default configuration when creating Analyses in Insights.

JSON representation 
{
  "runtimeIntegrationAnalysisPercentage": number,
  "uploadConversationAnalysisPercentage": number,
  "smartHighlightCustomAgent": string,
  "disableIssueModeling": boolean,
  "annotatorSelector": {
    object (AnnotatorSelector)
  }
}
Fields
runtimeIntegrationAnalysisPercentage

number

Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
uploadConversationAnalysisPercentage

number

Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
smartHighlightCustomAgent

string

Unique ID of the custom Dialogflow agent that is used to produce Smart Highlights in addition to the default IDs. Format: projects/{projectId}/locations/{location}/agents/{agent}
disableIssueModeling
(deprecated)

boolean

Whether to disable issue model inference during analysis. By default issue modeling will be included in analysis if there is an active issue model for the project.
annotatorSelector

object (AnnotatorSelector)

To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.