Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/dialogflow

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: dialogflow3 --scope <scope> projects locations-agents-patch ...

Required Scalar Argument

• <name> (string)
  • The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

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:

GoogleCloudDialogflowCxV3Agent:
  advanced-settings:
    audio-export-gcs-destination:
      uri: string
    dtmf-settings:
      enabled: boolean
      finish-digit: string
      max-digits: integer
    logging-settings:
      enable-interaction-logging: boolean
      enable-stackdriver-logging: boolean
  answer-feedback-settings:
    enable-answer-feedback: boolean
  avatar-uri: string
  default-language-code: string
  description: string
  display-name: string
  enable-spell-correction: boolean
  enable-stackdriver-logging: boolean
  gen-app-builder-settings:
    engine: string
  git-integration-settings:
    github-settings:
      access-token: string
      branches: [string]
      display-name: string
      repository-uri: string
      tracking-branch: string
  locked: boolean
  name: string
  security-settings: string
  speech-to-text-settings:
    enable-speech-adaptation: boolean
  start-flow: string
  supported-language-codes: [string]
  time-zone: 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 .advanced-settings.audio-export-gcs-destination uri=lorem

  • Required. The Google Cloud Storage URI for the exported objects. A URI is of the form: gs://bucket/object-name-or-prefix Whether a full object name, or just a prefix, its usage depends on the Dialogflow operation.

• ..dtmf-settings enabled=false

  • If true, incoming audio is processed for DTMF (dual tone multi frequency) events. For example, if the caller presses a button on their telephone keypad and DTMF processing is enabled, Dialogflow will detect the event (e.g. a "3" was pressed) in the incoming audio and pass the event to the bot to drive business logic (e.g. when 3 is pressed, return the account balance).
• finish-digit=gubergren
  • The digit that terminates a DTMF digit sequence.

• max-digits=25

  • Max length of DTMF digits.

• ..logging-settings enable-interaction-logging=false

  • If true, DF Interaction logging is currently enabled.

• enable-stackdriver-logging=true

  • If true, StackDriver logging is currently enabled.

• ...answer-feedback-settings enable-answer-feedback=true

  • Optional. If enabled, end users will be able to provide answer feedback to Dialogflow responses. Feature works only if interaction logging is enabled in the Dialogflow agent.

• .. avatar-uri=sanctus

  • The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted Web Demo integration.
• default-language-code=ipsum
  • Required. Immutable. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method.
• description=eirmod
  • The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected.
• display-name=vero
  • Required. The human-readable name of the agent, unique within the location.
• enable-spell-correction=false
  • Indicates if automatic spell correction is enabled in detect intent requests.
• enable-stackdriver-logging=true
  • Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead.

• gen-app-builder-settings engine=sea

  • Required. The full name of the Gen App Builder engine related to this agent if there is one. Format: projects/{Project ID}/locations/{Location ID}/collections/{Collection ID}/engines/{Engine ID}

• ..git-integration-settings.github-settings access-token=et

  • The access token used to authenticate the access to the GitHub repository.
• branches=gubergren
  • A list of branches configured to be used from Dialogflow.
  • Each invocation of this argument appends the given value to the array.
• display-name=dolore
  • The unique repository display name for the GitHub repository.
• repository-uri=ea
  • The GitHub repository URI related to the agent.

• tracking-branch=elitr

  • The branch of the GitHub repository tracked for this agent.

• ... locked=false

  • Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent.
• name=tempor
  • The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.
• security-settings=clita
  • Name of the SecuritySettings reference for the agent. Format: projects//locations//securitySettings/.

• speech-to-text-settings enable-speech-adaptation=true

  • Whether to use speech adaptation for speech recognition.

• .. start-flow=stet

  • Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: projects//locations//agents//flows/.
• supported-language-codes=sea
  • The list of all languages supported by the agent (except for the default_language_code).
  • Each invocation of this argument appends the given value to the array.
• time-zone=clita
  • Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.

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
  • The mask to control which fields get updated. If the mask is not present, all fields will 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").