Console
    Contact Us Start free

    Google Cloud Contact Center Insights V1 Client - Class Settings (2.3.2)

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

    Generated from protobuf message google.cloud.contactcenterinsights.v1.Settings

    Namespace

    Google \ Cloud \ ContactCenterInsights \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ create_time
    Google\Protobuf\Timestamp

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

    ↳ update_time
    Google\Protobuf\Timestamp

    Output only. The time at which the settings were last updated.

    ↳ language_code
    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.

    ↳ conversation_ttl
    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.

    ↳ pubsub_notification_settings
    array| Google\Protobuf\Internal\MapField

    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}

    ↳ analysis_config
    Settings\AnalysisConfig

    Default analysis settings.

    ↳ redaction_config
    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
    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.

    getName

    Immutable. The resource name of the settings resource.

    Format: projects/{project}/locations/{location}/settings

    Returns
    Type
    Description
    string

    setName

    Immutable. The resource name of the settings resource.

    Format: projects/{project}/locations/{location}/settings

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The time at which the settings were last updated.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The time at which the settings were last updated.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getLanguageCode

    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
    Type
    Description
    string

    setLanguageCode

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getConversationTtl

    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
    Type
    Description
    Google\Protobuf\Duration |null

    hasConversationTtl

    clearConversationTtl

    setConversationTtl

    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.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    getPubsubNotificationSettings

    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
    Type
    Description
    Google\Protobuf\Internal\MapField

    setPubsubNotificationSettings

    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}
    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getAnalysisConfig

    Default analysis settings.

    Returns
    Type
    Description
    Settings\AnalysisConfig |null

    hasAnalysisConfig

    clearAnalysisConfig

    setAnalysisConfig

    Default analysis settings.

    Parameter
    Name
    Description
    var
    Settings\AnalysisConfig
    Returns
    Type
    Description
    $this

    getRedactionConfig

    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
    Type
    Description
    RedactionConfig |null

    hasRedactionConfig

    clearRedactionConfig

    setRedactionConfig

    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.

    Parameter
    Name
    Description
    var
    RedactionConfig
    Returns
    Type
    Description
    $this

    getSpeechConfig

    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
    Type
    Description
    SpeechConfig |null

    hasSpeechConfig

    clearSpeechConfig

    setSpeechConfig

    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.

    Parameter
    Name
    Description
    var
    SpeechConfig
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: