Contact Center AI Insights V1 API - Class Google::Cloud::ContactCenterInsights::V1::Settings (v1.1.0)

Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#analysis_config

def analysis_config() -> ::Google::Cloud::ContactCenterInsights::V1::Settings::AnalysisConfig
Returns

#analysis_config=

def analysis_config=(value) -> ::Google::Cloud::ContactCenterInsights::V1::Settings::AnalysisConfig
Parameter
Returns

#conversation_ttl

def conversation_ttl() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::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.

#conversation_ttl=

def conversation_ttl=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::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.
Returns
  • (::Google::Protobuf::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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#language_code

def language_code() -> ::String
Returns
  • (::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.

#language_code=

def language_code=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::String) — Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
Returns
  • (::String) — Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings

#pubsub_notification_settings

def pubsub_notification_settings() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::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}

#pubsub_notification_settings=

def pubsub_notification_settings=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::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}

Returns
  • (::Google::Protobuf::Map{::String => ::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}

#redaction_config

def redaction_config() -> ::Google::Cloud::ContactCenterInsights::V1::RedactionConfig
Returns
  • (::Google::Cloud::ContactCenterInsights::V1::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.

#redaction_config=

def redaction_config=(value) -> ::Google::Cloud::ContactCenterInsights::V1::RedactionConfig
Parameter
  • value (::Google::Cloud::ContactCenterInsights::V1::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.
Returns
  • (::Google::Cloud::ContactCenterInsights::V1::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.

#speech_config

def speech_config() -> ::Google::Cloud::ContactCenterInsights::V1::SpeechConfig
Returns
  • (::Google::Cloud::ContactCenterInsights::V1::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.

#speech_config=

def speech_config=(value) -> ::Google::Cloud::ContactCenterInsights::V1::SpeechConfig
Parameter
  • value (::Google::Cloud::ContactCenterInsights::V1::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.
Returns
  • (::Google::Cloud::ContactCenterInsights::V1::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns