Updates the specified Experiment.

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-environments-experiments-patch ...

Required Scalar Argument

  • <name> (string)
    • The name of the experiment. Format: projects//locations//agents//environments//experiments/..

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:

GoogleCloudDialogflowCxV3Experiment:
  create-time: string
  definition:
    condition: string
  description: string
  display-name: string
  end-time: string
  experiment-length: string
  last-update-time: string
  name: string
  result:
    last-update-time: string
  rollout-config:
    failure-condition: string
    rollout-condition: string
  rollout-failure-reason: string
  rollout-state:
    start-time: string
    step: string
    step-index: integer
  start-time: string
  state: 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 . create-time=et
    • Creation time of this experiment.

  • definition condition=accusam

    • The condition defines which subset of sessions are selected for this experiment. If not specified, all sessions are eligible. E.g. "query_input.language_code=en" See the conditions reference.

  • .. description=voluptua.

    • The human-readable description of the experiment.
  • display-name=dolore
    • Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters.
  • end-time=dolore
    • End time of this experiment.
  • experiment-length=dolore
    • Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days.
  • last-update-time=voluptua.
    • Last update time of this experiment.
  • name=amet.
    • The name of the experiment. Format: projects//locations//agents//environments//experiments/..

  • result last-update-time=ea

    • The last time the experiment's stats data was updated. Will have default value if stats have never been computed for this experiment.

  • ..rollout-config failure-condition=sadipscing

    • The conditions that are used to evaluate the failure of a rollout step. If not specified, no rollout steps will fail. E.g. "containment_rate < 10% OR average_turn_count < 3". See the conditions reference.

  • rollout-condition=lorem

    • The conditions that are used to evaluate the success of a rollout step. If not specified, all rollout steps will proceed to the next one unless failure conditions are met. E.g. "containment_rate > 60% AND callback_rate < 20%". See the conditions reference.

  • .. rollout-failure-reason=invidunt

    • The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED.
  • rollout-state start-time=no
    • Start time of the current step.
  • step=est
    • Display name of the current auto rollout step.

  • step-index=74

    • Index of the current step in the auto rollout steps list.

  • .. start-time=sed

    • Start time of this experiment.
  • state=sit
    • The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE.

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 mask to control which fields get 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").