File: contactcenterinsights_v1.projects.locations.html

package info (click to toggle)
python-googleapi 2.187.0-1
links: PTS
area: main
in suites: forky, sid
size: 562,316 kB
sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (746 lines) | stat: -rw-r--r-- 67,713 bytes
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.analysisRules.html">analysisRules()</a></code>
</p>
<p class="firstline">Returns the analysisRules Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.assessmentRules.html">assessmentRules()</a></code>
</p>
<p class="firstline">Returns the assessmentRules Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.authorizedViewSets.html">authorizedViewSets()</a></code>
</p>
<p class="firstline">Returns the authorizedViewSets Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.conversations.html">conversations()</a></code>
</p>
<p class="firstline">Returns the conversations Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.datasets.html">datasets()</a></code>
</p>
<p class="firstline">Returns the datasets Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.encryptionSpec.html">encryptionSpec()</a></code>
</p>
<p class="firstline">Returns the encryptionSpec Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.insightsdata.html">insightsdata()</a></code>
</p>
<p class="firstline">Returns the insightsdata Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.issueModels.html">issueModels()</a></code>
</p>
<p class="firstline">Returns the issueModels Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.phraseMatchers.html">phraseMatchers()</a></code>
</p>
<p class="firstline">Returns the phraseMatchers Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.qaQuestionTags.html">qaQuestionTags()</a></code>
</p>
<p class="firstline">Returns the qaQuestionTags Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.qaScorecards.html">qaScorecards()</a></code>
</p>
<p class="firstline">Returns the qaScorecards Resource.</p>

<p class="toc_element">
  <code><a href="contactcenterinsights_v1.projects.locations.views.html">views()</a></code>
</p>
<p class="firstline">Returns the views Resource.</p>

<p class="toc_element">
  <code><a href="#bulkDeleteFeedbackLabels">bulkDeleteFeedbackLabels(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete feedback labels in bulk using a filter.</p>
<p class="toc_element">
  <code><a href="#bulkDownloadFeedbackLabels">bulkDownloadFeedbackLabels(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.</p>
<p class="toc_element">
  <code><a href="#bulkUploadFeedbackLabels">bulkUploadFeedbackLabels(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#getEncryptionSpec">getEncryptionSpec(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets location-level encryption key specification.</p>
<p class="toc_element">
  <code><a href="#getSettings">getSettings(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets project-level settings.</p>
<p class="toc_element">
  <code><a href="#listAllFeedbackLabels">listAllFeedbackLabels(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all feedback labels by project number.</p>
<p class="toc_element">
  <code><a href="#listAllFeedbackLabels_next">listAllFeedbackLabels_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#queryMetrics">queryMetrics(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Query metrics.</p>
<p class="toc_element">
  <code><a href="#queryPerformanceOverview">queryPerformanceOverview(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.</p>
<p class="toc_element">
  <code><a href="#updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates project-level settings.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="bulkDeleteFeedbackLabels">bulkDeleteFeedbackLabels(parent, body=None, x__xgafv=None)</code>
  <pre>Delete feedback labels in bulk using a filter.

Args:
  parent: string, Required. The parent resource for new feedback labels. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for the BulkDeleteFeedbackLabels endpoint.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
  &quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource for new feedback labels.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="bulkDownloadFeedbackLabels">bulkDownloadFeedbackLabels(parent, body=None, x__xgafv=None)</code>
  <pre>Download feedback labels in bulk from an external source. Currently supports exporting Quality AI example conversations with transcripts and question bodies.

Args:
  parent: string, Required. The parent resource for new feedback labels. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for the BulkDownloadFeedbackLabel endpoint.
  &quot;conversationFilter&quot;: &quot;A String&quot;, # Optional. Filter parent conversations to download feedback labels for. When specified, the feedback labels will be downloaded for the conversations that match the filter. If `template_qa_scorecard_id` is set, all the conversations that match the filter will be paired with the questions under the scorecard for labeling.
  &quot;feedbackLabelType&quot;: &quot;A String&quot;, # Optional. The type of feedback labels that will be downloaded.
  &quot;filter&quot;: &quot;A String&quot;, # Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
  &quot;gcsDestination&quot;: { # Google Cloud Storage Object details to write the feedback labels to. # A cloud storage bucket destination.
    &quot;addWhitespace&quot;: True or False, # Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.
    &quot;alwaysPrintEmptyFields&quot;: True or False, # Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.
    &quot;format&quot;: &quot;A String&quot;, # Required. File format in which the labels will be exported.
    &quot;objectUri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. `gs://bucket_name/object_uri_prefix`
    &quot;recordsPerFileCount&quot;: &quot;A String&quot;, # Optional. The number of records per file. Applicable for either format.
  },
  &quot;maxDownloadCount&quot;: 42, # Optional. Limits the maximum number of feedback labels that will be downloaded. The first `N` feedback labels will be downloaded.
  &quot;parent&quot;: &quot;A String&quot;, # Required. The parent resource for new feedback labels.
  &quot;sheetsDestination&quot;: { # Google Sheets document details to write the feedback labels to. # A sheets document destination.
    &quot;sheetTitle&quot;: &quot;A String&quot;, # Optional. The title of the new sheet to write the feedback labels to.
    &quot;spreadsheetUri&quot;: &quot;A String&quot;, # Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA. The spreadsheet ID written to will be returned as `file_names` in the BulkDownloadFeedbackLabelsMetadata.
  },
  &quot;templateQaScorecardId&quot;: [ # Optional. If set, a template for labeling conversations and scorecard questions will be created from the conversation_filter and the questions under the scorecard(s). The feedback label `filter` will be ignored.
    &quot;A String&quot;,
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="bulkUploadFeedbackLabels">bulkUploadFeedbackLabels(parent, body=None, x__xgafv=None)</code>
  <pre>Upload feedback labels from an external source in bulk. Currently supports labeling Quality AI example conversations.

Args:
  parent: string, Required. The parent resource for new feedback labels. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for bulk uploading feedback labels.
  &quot;gcsSource&quot;: { # Google Cloud Storage Object details to get the feedback label file from. # A cloud storage bucket source.
    &quot;format&quot;: &quot;A String&quot;, # Required. File format which will be ingested.
    &quot;objectUri&quot;: &quot;A String&quot;, # Required. The Google Cloud Storage URI of the file to import. Format: `gs://bucket_name/object_name`
  },
  &quot;sheetsSource&quot;: { # Google Sheets document details to get the feedback label file from. # A sheets document source.
    &quot;spreadsheetUri&quot;: &quot;A String&quot;, # Required. The Google Sheets document to write the feedback labels to. Retrieved from Google Sheets URI. E.g. `https://docs.google.com/spreadsheets/d/1234567890` The spreadsheet must be shared with the Insights P4SA.
  },
  &quot;validateOnly&quot;: True or False, # Optional. If set, upload will not happen and the labels will be validated. If not set, then default behavior will be to upload the labels after validation is complete.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="getEncryptionSpec">getEncryptionSpec(name, x__xgafv=None)</code>
  <pre>Gets location-level encryption key specification.

Args:
  name: string, Required. The name of the encryption spec 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:

    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`).
  &quot;kmsKey&quot;: &quot;A String&quot;, # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
}</pre>
</div>

<div class="method">
    <code class="details" id="getSettings">getSettings(name, x__xgafv=None)</code>
  <pre>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 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).
  &quot;analysisConfig&quot;: { # Default configuration when creating Analyses in Insights. # Default analysis settings.
    &quot;annotatorSelector&quot;: { # 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.
      &quot;issueModels&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;phraseMatchers&quot;: [ # 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}
        &quot;A String&quot;,
      ],
      &quot;qaConfig&quot;: { # Configuration for the QA feature. # Configuration for the QA annotator.
        &quot;scorecardList&quot;: { # Container for a list of scorecards. # A manual list of scorecards to score.
          &quot;qaScorecardRevisions&quot;: [ # List of QaScorecardRevisions.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;runEntityAnnotator&quot;: True or False, # Whether to run the entity annotator.
      &quot;runIntentAnnotator&quot;: True or False, # Whether to run the intent annotator.
      &quot;runInterruptionAnnotator&quot;: True or False, # Whether to run the interruption annotator.
      &quot;runIssueModelAnnotator&quot;: True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
      &quot;runPhraseMatcherAnnotator&quot;: True or False, # Whether to run the active phrase matcher annotator(s).
      &quot;runQaAnnotator&quot;: True or False, # Whether to run the QA annotator.
      &quot;runSentimentAnnotator&quot;: True or False, # Whether to run the sentiment annotator.
      &quot;runSilenceAnnotator&quot;: True or False, # Whether to run the silence annotator.
      &quot;runSummarizationAnnotator&quot;: True or False, # Whether to run the summarization annotator.
      &quot;summarizationConfig&quot;: { # Configuration for summarization. # Configuration for the summarization annotator.
        &quot;conversationProfile&quot;: &quot;A String&quot;, # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
        &quot;generator&quot;: &quot;A String&quot;, # The resource name of the existing created generator. Format: projects//locations//generators/
        &quot;summarizationModel&quot;: &quot;A String&quot;, # Default summarization model to be used.
      },
    },
    &quot;runtimeIntegrationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
    &quot;uploadConversationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
  },
  &quot;conversationTtl&quot;: &quot;A String&quot;, # 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.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the settings was created.
  &quot;languageCode&quot;: &quot;A String&quot;, # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to &quot;en-US&quot; if it is neither specified on the segment nor here.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  &quot;pubsubNotificationSettings&quot;: { # 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: * &quot;all-triggers&quot;: Notify each time any of the supported triggers occurs. * &quot;create-analysis&quot;: Notify each time an analysis is created. * &quot;create-conversation&quot;: Notify each time a conversation is created. * &quot;export-insights-data&quot;: Notify each time an export is complete. * &quot;ingest-conversations&quot;: Notify each time an IngestConversations LRO is complete. * &quot;update-conversation&quot;: Notify each time a conversation is updated via UpdateConversation. * &quot;upload-conversation&quot;: Notify when an UploadConversation LRO is complete. * &quot;update-or-analyze-conversation&quot;: 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}
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;redactionConfig&quot;: { # 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. # 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.
    &quot;deidentifyTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
    &quot;inspectTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
  },
  &quot;screenRecordingBucketUri&quot;: &quot;A String&quot;, # 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.
  &quot;speechConfig&quot;: { # 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. # 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.
    &quot;speechRecognizer&quot;: &quot;A String&quot;, # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which the settings were last updated.
}</pre>
</div>

<div class="method">
    <code class="details" id="listAllFeedbackLabels">listAllFeedbackLabels(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List all feedback labels by project number.

Args:
  parent: string, Required. The parent resource of all feedback labels per project. (required)
  filter: string, Optional. A filter to reduce results to a specific subset in the entire project. Supports disjunctions (OR) and conjunctions (AND). Supported fields: * `issue_model_id` * `qa_question_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
  pageToken: string, Optional. The value returned by the last `ListAllFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListAllFeedbackLabels` call and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for listing all feedback labels.
  &quot;feedbackLabels&quot;: [ # The feedback labels that match the request.
    { # Represents a conversation, resource, and label provided by the user. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create time of the label.
      &quot;label&quot;: &quot;A String&quot;, # String label used for Topic Modeling.
      &quot;labeledResource&quot;: &quot;A String&quot;, # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}`
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
      &quot;qaAnswerLabel&quot;: { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label used for Quality AI example conversations.
        &quot;boolValue&quot;: True or False, # Boolean value.
        &quot;key&quot;: &quot;A String&quot;, # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
        &quot;naValue&quot;: True or False, # A value of &quot;Not Applicable (N/A)&quot;. Should only ever be `true`.
        &quot;normalizedScore&quot;: 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
        &quot;numValue&quot;: 3.14, # Numerical value.
        &quot;potentialScore&quot;: 3.14, # Output only. The maximum potential score of the question.
        &quot;score&quot;: 3.14, # Output only. Numerical score of the answer.
        &quot;skipValue&quot;: True or False, # Output only. A value of &quot;Skip&quot;. If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated.
        &quot;strValue&quot;: &quot;A String&quot;, # String value.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update time of the label.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="listAllFeedbackLabels_next">listAllFeedbackLabels_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="queryMetrics">queryMetrics(location, body=None, x__xgafv=None)</code>
  <pre>Query metrics.

Args:
  location: string, Required. The location of the data. &quot;projects/{project}/locations/{location}&quot; (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for querying metrics.
  &quot;dimensions&quot;: [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension&#x27;s key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
    { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the &quot;SELECT&quot; and &quot;GROUP BY&quot; clauses.
      &quot;agentDimensionMetadata&quot;: { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension.
        &quot;agentDeploymentDisplayName&quot;: &quot;A String&quot;, # Optional. The agent&#x27;s deployment display name. Only applicable to automated agents. This will be populated for AGENT_DEPLOYMENT_ID dimensions.
        &quot;agentDeploymentId&quot;: &quot;A String&quot;, # Optional. The agent&#x27;s deployment ID. Only applicable to automated agents. This will be populated for AGENT and AGENT_DEPLOYMENT_ID dimensions.
        &quot;agentDisplayName&quot;: &quot;A String&quot;, # Optional. The agent&#x27;s name This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
        &quot;agentId&quot;: &quot;A String&quot;, # Optional. A user-specified string representing the agent. This will be populated for AGENT, AGENT_TEAM, AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
        &quot;agentTeam&quot;: &quot;A String&quot;, # Optional. A user-specified string representing the agent&#x27;s team.
        &quot;agentVersionDisplayName&quot;: &quot;A String&quot;, # Optional. The agent&#x27;s version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
        &quot;agentVersionId&quot;: &quot;A String&quot;, # Optional. The agent&#x27;s version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
      },
      &quot;clientSentimentCategoryDimensionMetadata&quot;: { # Metadata about the client sentiment category dimension. # Output only. Metadata about the client sentiment category dimension.
        &quot;sentimentCategory&quot;: &quot;A String&quot;, # Optional. The client sentiment category.
      },
      &quot;conversationProfileDimensionMetadata&quot;: { # Metadata about the conversation profile dimension. # Output only. Metadata about the conversation profile dimension.
        &quot;conversationProfileId&quot;: &quot;A String&quot;, # Optional. The conversation profile ID.
      },
      &quot;conversationalAgentsPlaybookDimensionMetadata&quot;: { # Metadata about the Conversational Agents playbook dimension. # Output only. Metadata about the Conversational Agents playbook dimension.
        &quot;playbookDisplayName&quot;: &quot;A String&quot;, # Optional. The dialogflow playbook display name.
        &quot;playbookId&quot;: &quot;A String&quot;, # Optional. The dialogflow playbook ID.
      },
      &quot;conversationalAgentsToolDimensionMetadata&quot;: { # Metadata about the Conversational Agents tool dimension. # Output only. Metadata about the Conversational Agents tool dimension.
        &quot;toolDisplayName&quot;: &quot;A String&quot;, # Optional. The dialogflow tool display name.
        &quot;toolId&quot;: &quot;A String&quot;, # Optional. The dialogflow tool ID.
      },
      &quot;dimensionKey&quot;: &quot;A String&quot;, # The key of the dimension.
      &quot;issueDimensionMetadata&quot;: { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
        &quot;issueDisplayName&quot;: &quot;A String&quot;, # The issue display name.
        &quot;issueId&quot;: &quot;A String&quot;, # The issue ID.
        &quot;issueModelId&quot;: &quot;A String&quot;, # The parent issue model ID.
      },
      &quot;mediumDimensionMetadata&quot;: { # Metadata about the conversation medium dimension. # Output only. Metadata about the conversation medium dimension.
        &quot;medium&quot;: &quot;A String&quot;, # Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.
      },
      &quot;qaQuestionAnswerDimensionMetadata&quot;: { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
        &quot;answerValue&quot;: &quot;A String&quot;, # Optional. The full body of the question.
        &quot;qaQuestionId&quot;: &quot;A String&quot;, # Optional. The QA question ID.
        &quot;qaScorecardId&quot;: &quot;A String&quot;, # Optional. The QA scorecard ID.
        &quot;questionBody&quot;: &quot;A String&quot;, # Optional. The full body of the question.
      },
      &quot;qaQuestionDimensionMetadata&quot;: { # Metadata about the QA question dimension. # Output only. Metadata about the QA question dimension.
        &quot;qaQuestionId&quot;: &quot;A String&quot;, # Optional. The QA question ID.
        &quot;qaScorecardId&quot;: &quot;A String&quot;, # Optional. The QA scorecard ID.
        &quot;questionBody&quot;: &quot;A String&quot;, # Optional. The full body of the question.
      },
      &quot;qaScorecardDimensionMetadata&quot;: { # Metadata about the QA scorecard dimension. # Output only. Metadata about the QA scorecard dimension.
        &quot;qaScorecardId&quot;: &quot;A String&quot;, # Optional. The QA scorecard ID.
      },
    },
  ],
  &quot;filter&quot;: &quot;A String&quot;, # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
  &quot;measureMask&quot;: &quot;A String&quot;, # Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is &quot;conversation_measure.count&quot;.
  &quot;timeGranularity&quot;: &quot;A String&quot;, # The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="queryPerformanceOverview">queryPerformanceOverview(parent, body=None, x__xgafv=None)</code>
  <pre>Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.

Args:
  parent: string, Required. The parent resource of the conversations to derive performance stats from. &quot;projects/{project}/locations/{location}&quot; (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for summarizing performance according to different metrics for conversations over a specified time window.
  &quot;agentPerformanceSource&quot;: { # The entity whose performance is being queried is a single agent. # Conversations are from a single agent.
    &quot;agentId&quot;: &quot;A String&quot;, # Required. Agent id to query performance overview for.
  },
  &quot;comparisonQueryInterval&quot;: { # A time window for querying conversations. # The time window of the conversations to compare the performance to.
    &quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
    &quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
  },
  &quot;filter&quot;: &quot;A String&quot;, # Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.
  &quot;queryInterval&quot;: { # A time window for querying conversations. # Required. The time window of the conversations to derive performance stats from.
    &quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
    &quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="updateSettings">updateSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>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 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).
  &quot;analysisConfig&quot;: { # Default configuration when creating Analyses in Insights. # Default analysis settings.
    &quot;annotatorSelector&quot;: { # 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.
      &quot;issueModels&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;phraseMatchers&quot;: [ # 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}
        &quot;A String&quot;,
      ],
      &quot;qaConfig&quot;: { # Configuration for the QA feature. # Configuration for the QA annotator.
        &quot;scorecardList&quot;: { # Container for a list of scorecards. # A manual list of scorecards to score.
          &quot;qaScorecardRevisions&quot;: [ # List of QaScorecardRevisions.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;runEntityAnnotator&quot;: True or False, # Whether to run the entity annotator.
      &quot;runIntentAnnotator&quot;: True or False, # Whether to run the intent annotator.
      &quot;runInterruptionAnnotator&quot;: True or False, # Whether to run the interruption annotator.
      &quot;runIssueModelAnnotator&quot;: True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
      &quot;runPhraseMatcherAnnotator&quot;: True or False, # Whether to run the active phrase matcher annotator(s).
      &quot;runQaAnnotator&quot;: True or False, # Whether to run the QA annotator.
      &quot;runSentimentAnnotator&quot;: True or False, # Whether to run the sentiment annotator.
      &quot;runSilenceAnnotator&quot;: True or False, # Whether to run the silence annotator.
      &quot;runSummarizationAnnotator&quot;: True or False, # Whether to run the summarization annotator.
      &quot;summarizationConfig&quot;: { # Configuration for summarization. # Configuration for the summarization annotator.
        &quot;conversationProfile&quot;: &quot;A String&quot;, # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
        &quot;generator&quot;: &quot;A String&quot;, # The resource name of the existing created generator. Format: projects//locations//generators/
        &quot;summarizationModel&quot;: &quot;A String&quot;, # Default summarization model to be used.
      },
    },
    &quot;runtimeIntegrationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
    &quot;uploadConversationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
  },
  &quot;conversationTtl&quot;: &quot;A String&quot;, # 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.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the settings was created.
  &quot;languageCode&quot;: &quot;A String&quot;, # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to &quot;en-US&quot; if it is neither specified on the segment nor here.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  &quot;pubsubNotificationSettings&quot;: { # 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: * &quot;all-triggers&quot;: Notify each time any of the supported triggers occurs. * &quot;create-analysis&quot;: Notify each time an analysis is created. * &quot;create-conversation&quot;: Notify each time a conversation is created. * &quot;export-insights-data&quot;: Notify each time an export is complete. * &quot;ingest-conversations&quot;: Notify each time an IngestConversations LRO is complete. * &quot;update-conversation&quot;: Notify each time a conversation is updated via UpdateConversation. * &quot;upload-conversation&quot;: Notify when an UploadConversation LRO is complete. * &quot;update-or-analyze-conversation&quot;: 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}
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;redactionConfig&quot;: { # 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. # 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.
    &quot;deidentifyTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
    &quot;inspectTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
  },
  &quot;screenRecordingBucketUri&quot;: &quot;A String&quot;, # 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.
  &quot;speechConfig&quot;: { # 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. # 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.
    &quot;speechRecognizer&quot;: &quot;A String&quot;, # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # 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 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).
  &quot;analysisConfig&quot;: { # Default configuration when creating Analyses in Insights. # Default analysis settings.
    &quot;annotatorSelector&quot;: { # 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.
      &quot;issueModels&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;phraseMatchers&quot;: [ # 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}
        &quot;A String&quot;,
      ],
      &quot;qaConfig&quot;: { # Configuration for the QA feature. # Configuration for the QA annotator.
        &quot;scorecardList&quot;: { # Container for a list of scorecards. # A manual list of scorecards to score.
          &quot;qaScorecardRevisions&quot;: [ # List of QaScorecardRevisions.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;runEntityAnnotator&quot;: True or False, # Whether to run the entity annotator.
      &quot;runIntentAnnotator&quot;: True or False, # Whether to run the intent annotator.
      &quot;runInterruptionAnnotator&quot;: True or False, # Whether to run the interruption annotator.
      &quot;runIssueModelAnnotator&quot;: True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
      &quot;runPhraseMatcherAnnotator&quot;: True or False, # Whether to run the active phrase matcher annotator(s).
      &quot;runQaAnnotator&quot;: True or False, # Whether to run the QA annotator.
      &quot;runSentimentAnnotator&quot;: True or False, # Whether to run the sentiment annotator.
      &quot;runSilenceAnnotator&quot;: True or False, # Whether to run the silence annotator.
      &quot;runSummarizationAnnotator&quot;: True or False, # Whether to run the summarization annotator.
      &quot;summarizationConfig&quot;: { # Configuration for summarization. # Configuration for the summarization annotator.
        &quot;conversationProfile&quot;: &quot;A String&quot;, # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
        &quot;generator&quot;: &quot;A String&quot;, # The resource name of the existing created generator. Format: projects//locations//generators/
        &quot;summarizationModel&quot;: &quot;A String&quot;, # Default summarization model to be used.
      },
    },
    &quot;runtimeIntegrationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].
    &quot;uploadConversationAnalysisPercentage&quot;: 3.14, # Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].
  },
  &quot;conversationTtl&quot;: &quot;A String&quot;, # 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.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the settings was created.
  &quot;languageCode&quot;: &quot;A String&quot;, # A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to &quot;en-US&quot; if it is neither specified on the segment nor here.
  &quot;name&quot;: &quot;A String&quot;, # Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  &quot;pubsubNotificationSettings&quot;: { # 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: * &quot;all-triggers&quot;: Notify each time any of the supported triggers occurs. * &quot;create-analysis&quot;: Notify each time an analysis is created. * &quot;create-conversation&quot;: Notify each time a conversation is created. * &quot;export-insights-data&quot;: Notify each time an export is complete. * &quot;ingest-conversations&quot;: Notify each time an IngestConversations LRO is complete. * &quot;update-conversation&quot;: Notify each time a conversation is updated via UpdateConversation. * &quot;upload-conversation&quot;: Notify when an UploadConversation LRO is complete. * &quot;update-or-analyze-conversation&quot;: 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}
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;redactionConfig&quot;: { # 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. # 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.
    &quot;deidentifyTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}`
    &quot;inspectTemplate&quot;: &quot;A String&quot;, # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}`
  },
  &quot;screenRecordingBucketUri&quot;: &quot;A String&quot;, # 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.
  &quot;speechConfig&quot;: { # 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. # 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.
    &quot;speechRecognizer&quot;: &quot;A String&quot;, # The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time at which the settings were last updated.
}</pre>
</div>

</body></html>