close()

Close httplib2 connections.

getSettings(name, x__xgafv=None)

Gets project-level settings.

Args:
name: string, Required. The name of the settings resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The settings resource.
"analysisConfig": { # Default configuration when creating Analyses in Insights. # Default analysis settings.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"runtimeIntegrationAnalysisPercentage": 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
"uploadConversationAnalysisPercentage": 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
},
"conversationTtl": "A String", # 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": "A String", # Output only. The time at which the settings was created.
"languageCode": "A 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": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
"pubsubNotificationSettings": { # 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 completes. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
"a_key": "A String",
},
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. # Default DLP redaction resources to be applied while ingesting conversations.
"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
"inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
},
"speechConfig": { # Speech-to-Text configuration. # Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.
"speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
},
"updateTime": "A String", # Output only. The time at which the settings were last updated.
}

updateSettings(name, body=None, updateMask=None, x__xgafv=None)

Updates project-level settings.

Args:
name: string, Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings (required)
body: object, The request body.
The object takes the form of:

{ # The settings resource.
"analysisConfig": { # Default configuration when creating Analyses in Insights. # Default analysis settings.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"runtimeIntegrationAnalysisPercentage": 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
"uploadConversationAnalysisPercentage": 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
},
"conversationTtl": "A String", # 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": "A String", # Output only. The time at which the settings was created.
"languageCode": "A 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": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
"pubsubNotificationSettings": { # 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 completes. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
"a_key": "A String",
},
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. # Default DLP redaction resources to be applied while ingesting conversations.
"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
"inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
},
"speechConfig": { # Speech-to-Text configuration. # Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.
"speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
},
"updateTime": "A String", # Output only. The time at which the settings were last updated.
}

updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The settings resource.
"analysisConfig": { # Default configuration when creating Analyses in Insights. # Default analysis settings.
"annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
"issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
"A String",
],
"phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
"A String",
],
"runEntityAnnotator": True or False, # Whether to run the entity annotator.
"runIntentAnnotator": True or False, # Whether to run the intent annotator.
"runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
"runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
"runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
"runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
"runSilenceAnnotator": True or False, # Whether to run the silence annotator.
"runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
"summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
"conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
"summarizationModel": "A String", # Default summarization model to be used.
},
},
"runtimeIntegrationAnalysisPercentage": 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
"uploadConversationAnalysisPercentage": 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
},
"conversationTtl": "A String", # 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": "A String", # Output only. The time at which the settings was created.
"languageCode": "A 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": "A String", # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
"pubsubNotificationSettings": { # 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 completes. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. * "upload-conversation": Notify when an UploadConversation LRO completes. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
"a_key": "A String",
},
"redactionConfig": { # DLP resources used for redaction while ingesting conversations. # Default DLP redaction resources to be applied while ingesting conversations.
"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
"inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
},
"speechConfig": { # Speech-to-Text configuration. # Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided.
"speechRecognizer": "A String", # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
},
"updateTime": "A String", # Output only. The time at which the settings were last updated.
}

Contact Center AI Insights API . projects . locations

Instance Methods

Method Details