Creates a conversation.

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

Required Scalar Argument

  • <parent> (string)
    • Required. The parent resource of the conversation.

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:

GoogleCloudContactcenterinsightsV1Conversation:
  agent-id: string
  call-metadata:
    agent-channel: integer
    customer-channel: integer
  create-time: string
  data-source:
    dialogflow-source:
      audio-uri: string
      dialogflow-conversation: string
    gcs-source:
      audio-uri: string
      transcript-uri: string
  duration: string
  expire-time: string
  labels: { string: string }
  language-code: string
  latest-analysis:
    analysis-result:
      call-analysis-metadata:
        issue-model-result:
          issue-model: string
      end-time: string
    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
    create-time: string
    name: string
    request-time: string
  latest-summary:
    answer-record: string
    confidence: number
    conversation-model: string
    metadata: { string: string }
    text: string
    text-sections: { string: string }
  medium: string
  name: string
  obfuscated-user-id: string
  quality-metadata:
    customer-satisfaction-rating: integer
    menu-path: string
    wait-duration: string
  start-time: string
  ttl: string
  turn-count: integer
  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 . agent-id=vero
    • An opaque, user-specified string representing the human agent who handled the conversation.
  • call-metadata agent-channel=70
    • The audio channel that contains the agent.

  • customer-channel=8

    • The audio channel that contains the customer.

  • .. create-time=duo

    • Output only. The time at which the conversation was created.
  • data-source.dialogflow-source audio-uri=dolore
    • Cloud Storage URI that points to a file that contains the conversation audio.

  • dialogflow-conversation=et

    • Output only. The name of the Dialogflow conversation that this conversation resource is derived from. Format: projects/{project}/locations/{location}/conversations/{conversation}

  • ..gcs-source audio-uri=voluptua.

    • Cloud Storage URI that points to a file that contains the conversation audio.

  • transcript-uri=amet.

    • Immutable. Cloud Storage URI that points to a file that contains the conversation transcript.

  • ... duration=consetetur

    • Output only. The duration of the conversation.
  • expire-time=diam
    • The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
  • labels=key=dolor
    • A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry.
    • the value will be associated with the given key
  • language-code=et
    • A user-specified language code for the conversation.

  • latest-analysis.analysis-result.call-analysis-metadata.issue-model-result issue-model=et

    • Issue model that generates the result. Format: projects/{project}/locations/{location}/issueModels/{issue_model}

  • ... end-time=sadipscing

    • The time at which the analysis ended.

  • ..annotator-selector issue-models=stet

    • 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=dolor
    • 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=false
    • Whether to run the intent annotator.
  • run-interruption-annotator=false
    • Whether to run the interruption annotator.
  • run-issue-model-annotator=true
    • 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=true
    • 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=accusam
    • Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}

  • summarization-model=takimata

    • Default summarization model to be used.

  • ... create-time=consetetur

    • Output only. The time at which the analysis was created, which occurs when the long-running operation completes.
  • name=voluptua.
    • Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis}

  • request-time=et

    • Output only. The time at which the analysis was requested.

  • ..latest-summary answer-record=erat

    • The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record}
  • confidence=0.04583256524798884
    • The confidence score of the summarization.
  • conversation-model=sed
    • The name of the model that generates this summary. Format: projects/{project}/locations/{location}/conversationModels/{conversation_model}
  • metadata=key=takimata
    • A map that contains metadata about the summarization and the document from which it originates.
    • the value will be associated with the given key
  • text=dolores
    • The summarization content that is concatenated into one string.

  • text-sections=key=gubergren

    • The summarization content that is divided into sections. The key is the section's name and the value is the section's content. There is no specific format for the key or value.
    • the value will be associated with the given key

  • .. medium=et

    • Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
  • name=accusam
    • Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
  • obfuscated-user-id=voluptua.
    • Obfuscated user ID which the customer sent to us.
  • quality-metadata customer-satisfaction-rating=67
    • An arbitrary integer value indicating the customer's satisfaction rating.
  • menu-path=dolore
    • An arbitrary string value specifying the menu path the customer took.

  • wait-duration=dolore

    • The amount of time the customer waited to connect with an agent.

  • .. start-time=voluptua.

    • The time at which the conversation started.
  • ttl=amet.
    • Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
  • turn-count=84
    • Output only. The number of turns in the conversation.
  • update-time=sadipscing
    • Output only. The most recent time at which the conversation was 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 conversation-id=string
    • A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are a-z-

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