Analyzes multiple conversations in a single request.

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-conversations-bulk-analyze ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource to create analyses in.

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:

GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest:
  analysis-percentage: number
  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
  filter: string
  parent: 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-percentage=0.5053930334687853
    • Required. Percentage of selected conversation to analyze, between [0, 100].
  • annotator-selector issue-models=rebum.
    • 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=est
    • 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=true
    • 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=true
    • Whether to run the active phrase matcher annotator(s).
  • run-sentiment-annotator=false
    • Whether to run the sentiment annotator.
  • run-silence-annotator=true
    • Whether to run the silence annotator.
  • run-summarization-annotator=false
    • Whether to run the summarization annotator.
  • summarization-config conversation-profile=sed
    • Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

  • summarization-model=no

    • Default summarization model to be used.

  • ... filter=stet

    • Required. Filter used to select the subset of conversations to analyze.
  • parent=kasd
    • Required. The parent resource to create analyses in.

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 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").