---
title: "PATCH /v1/projects/{projectsId}/locations/{locationsId}/settings"
method: PATCH
path: "/v1/projects/{projectsId}/locations/{locationsId}/settings"
tags: ["projects"]
---

# PATCH /v1/projects/{projectsId}/locations/{locationsId}/settings

`PATCH /v1/projects/{projectsId}/locations/{locationsId}/settings`

## Request

- Base URL: `https://contactcenterinsights.googleapis.com`
- URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/settings`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

Updates project-level settings.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required

## Query parameters

- `updateMask` string, google-fieldmask

## Request body

- GoogleCloudContactcenterinsightsV1Settings: The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) and change the settings with [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).
  - `analysisConfig` GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: Default configuration when creating Analyses in Insights.
    - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector: Selector of all available annotators and phrase matchers to run.
      - `issueModels` string[]: 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.
      - `phraseMatchers` string[]: 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}
      - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: Configuration for the QA feature.
        - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: Container for a list of scorecards.
          - `qaScorecardRevisions` string[]: List of QaScorecardRevisions.
      - `runAutoLabelingAnnotator` boolean: Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.
      - `runEntityAnnotator` boolean: Whether to run the entity annotator.
      - `runIntentAnnotator` boolean: Whether to run the intent annotator.
      - `runInterruptionAnnotator` boolean: Whether to run the interruption annotator.
      - `runIssueModelAnnotator` boolean: Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
      - `runPhraseMatcherAnnotator` boolean: Whether to run the active phrase matcher annotator(s).
      - `runQaAnnotator` boolean: Whether to run the QA annotator.
      - `runSentimentAnnotator` boolean: Whether to run the sentiment annotator.
      - `runSilenceAnnotator` boolean: Whether to run the silence annotator.
      - `runSummarizationAnnotator` boolean: Whether to run the summarization annotator.
      - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: Configuration for summarization.
        - `conversationProfile` string: Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
        - `generator` string: The resource name of the existing created generator. Format: projects//locations//generators/
        - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0': Default summarization model to be used.
    - `runtimeIntegrationAnalysisPercentage` number, double: Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
    - `uploadConversationAnalysisPercentage` number, double: Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
  - `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.
  - `diagnosticMetricConfig` GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig: Configuration for diagnostic metrics.
    - `metrics` object: Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., "containment").
  - `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.
  - `name` string: Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  - `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. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
  - `redactionConfig` GoogleCloudContactcenterinsightsV1RedactionConfig: DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.
    - `deidentifyTemplate` string: The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
    - `inspectTemplate` string: The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
  - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated.
  - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated.
  - `screenRecordingBucketUri` string: Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field.
  - `speechConfig` GoogleCloudContactcenterinsightsV1SpeechConfig: Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.
    - `disableWordTimeOffsets` boolean: Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.
    - `speechRecognizer` string: The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
  - `timeZone` string: Optional. The time zone applied to the project. This is a string representation of the time zone, for example, "America/New_York". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used.
  - `updateTime` string, google-datetime: Output only. The time at which the settings were last updated.

## Response `200`

Successful response

- GoogleCloudContactcenterinsightsV1Settings: The CCAI Insights project wide settings. Use these settings to configure the behavior of Insights. View these settings with [`getsettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/getSettings) and change the settings with [`updateSettings`](https://cloud.google.com/contact-center/insights/docs/reference/rest/v1/projects.locations/updateSettings).
  - `analysisConfig` GoogleCloudContactcenterinsightsV1SettingsAnalysisConfig: Default configuration when creating Analyses in Insights.
    - `annotatorSelector` GoogleCloudContactcenterinsightsV1AnnotatorSelector: Selector of all available annotators and phrase matchers to run.
      - `issueModels` string[]: 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.
      - `phraseMatchers` string[]: 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}
      - `qaConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfig: Configuration for the QA feature.
        - `scorecardList` GoogleCloudContactcenterinsightsV1AnnotatorSelectorQaConfigScorecardList: Container for a list of scorecards.
          - `qaScorecardRevisions` string[]: List of QaScorecardRevisions.
      - `runAutoLabelingAnnotator` boolean: Optional. Whether to run the auto-labeling annotator. If true, the auto-labeling annotator will be run. This is a non-billable operation designed for fixing or backfilling custom labels.
      - `runEntityAnnotator` boolean: Whether to run the entity annotator.
      - `runIntentAnnotator` boolean: Whether to run the intent annotator.
      - `runInterruptionAnnotator` boolean: Whether to run the interruption annotator.
      - `runIssueModelAnnotator` boolean: Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
      - `runPhraseMatcherAnnotator` boolean: Whether to run the active phrase matcher annotator(s).
      - `runQaAnnotator` boolean: Whether to run the QA annotator.
      - `runSentimentAnnotator` boolean: Whether to run the sentiment annotator.
      - `runSilenceAnnotator` boolean: Whether to run the silence annotator.
      - `runSummarizationAnnotator` boolean: Whether to run the summarization annotator.
      - `summarizationConfig` GoogleCloudContactcenterinsightsV1AnnotatorSelectorSummarizationConfig: Configuration for summarization.
        - `conversationProfile` string: Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
        - `generator` string: The resource name of the existing created generator. Format: projects//locations//generators/
        - `summarizationModel` 'SUMMARIZATION_MODEL_UNSPECIFIED' | 'BASELINE_MODEL' | 'BASELINE_MODEL_V2_0': Default summarization model to be used.
    - `runtimeIntegrationAnalysisPercentage` number, double: Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
    - `uploadConversationAnalysisPercentage` number, double: Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
  - `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.
  - `diagnosticMetricConfig` GoogleCloudContactcenterinsightsV1SettingsDiagnosticMetricConfig: Configuration for diagnostic metrics.
    - `metrics` object: Optional. A map of diagnostic metrics. The key is a unique identifier for the metric (e.g., "containment").
  - `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.
  - `name` string: Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  - `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. * "update-or-analyze-conversation": Notify when an analysis for a conversation is completed or when the conversation is updated. The message will contain the conversation with transcript, analysis and other metadata. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic}
  - `redactionConfig` GoogleCloudContactcenterinsightsV1RedactionConfig: DLP resources used for redaction while ingesting conversations. DLP settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint or the Dialogflow / Agent Assist runtime integrations. When using Dialogflow / Agent Assist runtime integrations, redaction should be performed in Dialogflow / Agent Assist.
    - `deidentifyTemplate` string: The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
    - `inspectTemplate` string: The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
  - `satisfiesPzi` boolean: Output only. Whether this resource is zone isolated.
  - `satisfiesPzs` boolean: Output only. Whether this resource is zone separated.
  - `screenRecordingBucketUri` string: Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field.
  - `speechConfig` GoogleCloudContactcenterinsightsV1SpeechConfig: Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint.
    - `disableWordTimeOffsets` boolean: Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false.
    - `speechRecognizer` string: The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
  - `timeZone` string: Optional. The time zone applied to the project. This is a string representation of the time zone, for example, "America/New_York". This field follows the IANA TZ database format. See https://www.iana.org/time-zones for a list of valid values. If no value is set the user time zone will be used.
  - `updateTime` string, google-datetime: Output only. The time at which the settings were last updated.

---

[API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)