Imports conversations and processes them according to the user's configuration.

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-ingest ...

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource for new conversations.

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:

GoogleCloudContactcenterinsightsV1IngestConversationsRequest:
  conversation-config:
    agent-channel: integer
    agent-id: string
    customer-channel: integer
  gcs-source:
    bucket-object-type: string
    bucket-uri: string
    custom-metadata-keys: [string]
    metadata-bucket-uri: string
  parent: string
  redaction-config:
    deidentify-template: string
    inspect-template: string
  speech-config:
    speech-recognizer: string
  transcript-object-config:
    medium: 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 .conversation-config agent-channel=95
    • Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
  • agent-id=invidunt
    • An opaque, user-specified string representing the human agent who handled the conversations.
  • customer-channel=90

    • Optional. Indicates which of the channels, 1 or 2, contains the agent. Note that this must be set for conversations to be properly displayed and analyzed.
  • ..gcs-source bucket-object-type=est

    • Optional. Specifies the type of the objects in bucket_uri.
  • bucket-uri=at
    • Required. The Cloud Storage bucket containing source objects.
  • custom-metadata-keys=sed
    • Optional. Custom keys to extract as conversation labels from metadata files in metadata_bucket_uri. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation.
    • Each invocation of this argument appends the given value to the array.
  • metadata-bucket-uri=sit

    • Optional. The Cloud Storage path to the source object metadata. Note that: [1] metadata files are expected to be in JSON format [2] metadata and source objects must be in separate buckets [3] a source object's metadata object must share the same name to be properly ingested
  • .. parent=et

    • Required. The parent resource for new conversations.
  • redaction-config deidentify-template=tempor
    • The fully-qualified DLP deidentify template resource name. Format: projects/{project}/deidentifyTemplates/{template}
  • inspect-template=aliquyam

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

    • The fully-qualified Speech Recognizer resource name. Format: projects/{project_id}/locations/{location}/recognizer/{recognizer}
  • ..transcript-object-config medium=et

    • Required. The medium transcript objects represent.

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