Updates the generative settings for the agent.

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-update-generative-settings ...

Required Scalar Argument

  • <name> (string)
    • Format: projects//locations//agents//generativeSettings.

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:

GoogleCloudDialogflowCxV3GenerativeSettings:
  fallback-settings:
    selected-prompt: string
  knowledge-connector-settings:
    agent: string
    agent-identity: string
    agent-scope: string
    business: string
    business-description: string
    disable-data-store-fallback: boolean
  language-code: string
  name: 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 .fallback-settings selected-prompt=rebum.

    • Display name of the selected prompt.

  • ..knowledge-connector-settings agent=kasd

    • Name of the virtual agent. Used for LLM prompt. Can be left empty.
  • agent-identity=voluptua.
    • Identity of the agent, e.g. "virtual agent", "AI assistant".
  • agent-scope=erat
    • Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
  • business=nonumy
    • Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
  • business-description=magna
    • Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".

  • disable-data-store-fallback=true

    • Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer). Per default the feature is enabled.

  • .. language-code=lorem

    • Language for this settings.
  • name=aliquyam
    • Format: projects//locations//agents//generativeSettings.

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