Updates project-level settings.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: contactcenterinsights1 --scope <scope> projects locations-update-settings ...

Required Scalar Argument

  • <name> (string)
    • Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudContactcenterinsightsV1Settings:
  analysis-config:
    annotator-selector:
      issue-models: [string]
      phrase-matchers: [string]
      run-entity-annotator: boolean
      run-intent-annotator: boolean
      run-interruption-annotator: boolean
      run-issue-model-annotator: boolean
      run-phrase-matcher-annotator: boolean
      run-sentiment-annotator: boolean
      run-silence-annotator: boolean
      run-summarization-annotator: boolean
      summarization-config:
        conversation-profile: string
        summarization-model: string
    runtime-integration-analysis-percentage: number
    upload-conversation-analysis-percentage: number
  conversation-ttl: string
  create-time: string
  language-code: string
  name: string
  pubsub-notification-settings: { string: string }
  redaction-config:
    deidentify-template: string
    inspect-template: string
  speech-config:
    speech-recognizer: string
  update-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .analysis-config.annotator-selector issue-models=ipsum
    • 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.
    • Each invocation of this argument appends the given value to the array.
  • phrase-matchers=no
    • 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}
    • Each invocation of this argument appends the given value to the array.
  • run-entity-annotator=false
    • Whether to run the entity annotator.
  • run-intent-annotator=true
    • Whether to run the intent annotator.
  • run-interruption-annotator=true
    • Whether to run the interruption annotator.
  • run-issue-model-annotator=false
    • Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
  • run-phrase-matcher-annotator=false
    • Whether to run the active phrase matcher annotator(s).
  • run-sentiment-annotator=false
    • Whether to run the sentiment annotator.
  • run-silence-annotator=false
    • Whether to run the silence annotator.
  • run-summarization-annotator=true
    • Whether to run the summarization annotator.
  • summarization-config conversation-profile=justo
    • Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

  • summarization-model=ea

    • Default summarization model to be used.

  • ... runtime-integration-analysis-percentage=0.8588845222722127

    • Percentage of conversations created using Dialogflow runtime integration to analyze automatically, between [0, 100].

  • upload-conversation-analysis-percentage=0.15692298624109202

    • Percentage of conversations created using the UploadConversation endpoint to analyze automatically, between [0, 100].

  • .. conversation-ttl=vero

    • The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted.
  • create-time=invidunt
    • Output only. The time at which the settings was created.
  • language-code=nonumy
    • 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=erat
    • Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings
  • pubsub-notification-settings=key=erat
    • 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. * "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}
    • the value will be associated with the given key
  • redaction-config deidentify-template=dolores
    • The fully-qualified DLP deidentify template resource name. Format: projects/{project}/deidentifyTemplates/{template}

  • inspect-template=ipsum

    • The fully-qualified DLP inspect template resource name. Format: projects/{project}/locations/{location}/inspectTemplates/{template}

  • ..speech-config speech-recognizer=voluptua.

    • The fully-qualified Speech Recognizer resource name. Format: projects/{project_id}/locations/{location}/recognizer/{recognizer}

  • .. update-time=eos

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

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Required. The list of fields to be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").