Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: SetSuggestionFeatureConfigOperationMetadata - response: ConversationProfile If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.


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


If unset, the scope for this method defaults to You can set the scope for this method like this: dialogflow2 --scope <scope> projects conversation-profiles-set-suggestion-feature-config ...

Required Scalar Argument

  • <conversation-profile> (string)
    • Required. The Conversation Profile to add or update the suggestion feature config. Format: projects//locations//conversationProfiles/.

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:

  participant-role: string
      baseline-model-version: string
      model: string
      recent-sentences-count: integer
    disable-agent-query-logging: boolean
    enable-conversation-augmented-query: boolean
    enable-event-based-suggestion: boolean
      confidence-threshold: number
        drop-handoff-messages: boolean
        drop-ivr-messages: boolean
        drop-virtual-agent-messages: boolean
        agent: string
          agent: string
        documents: [string]
        knowledge-bases: [string]
      max-results: integer
        section-types: [string]
      type: string
      no-smalltalk: boolean
      only-end-user: boolean

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 . participant-role=no
    • Required. The participant role to add or update the suggestion feature config. Only HUMAN_AGENT or END_USER can be used.
  • suggestion-feature-config.conversation-model-config baseline-model-version=tempor
    • Version of current baseline model. It will be ignored if model is set. Valid versions are: Article Suggestion baseline model: - 0.9 - 1.0 (default) Summarization baseline model: - 1.0
  • model=ipsum

    • Conversation model resource name. Format: projects//conversationModels/.
  • ..conversation-process-config recent-sentences-count=41

    • Number of recent non-small-talk sentences to use as context for article and FAQ suggestion
  • .. disable-agent-query-logging=false

    • Optional. Disable the logging of search queries sent by human agents. It can prevent those queries from being stored at answer records. Supported features: KNOWLEDGE_SEARCH.
  • enable-conversation-augmented-query=true
    • Optional. Enable including conversation context during query answer generation. Supported features: KNOWLEDGE_SEARCH.
  • enable-event-based-suggestion=true
    • Automatically iterates all participants and tries to compile suggestions. Supported features: ARTICLE_SUGGESTION, FAQ, DIALOGFLOW_ASSIST, KNOWLEDGE_ASSIST.
  • query-config confidence-threshold=0.9135686285692259
    • Confidence threshold of query result. Agent Assist gives each suggestion a score in the range [0.0, 1.0], based on the relevance between the suggestion and the current conversation context. A score of 0.0 has no relevance, while a score of 1.0 has high relevance. Only suggestions with a score greater than or equal to the value of this field are included in the results. For a baseline model (the default), the recommended value is in the range [0.05, 0.1]. For a custom model, there is no recommended value. Tune this value by starting from a very low value and slowly increasing until you have desired results. If this field is not set, it defaults to 0.0, which means that all suggestions are returned. Supported features: ARTICLE_SUGGESTION, FAQ, SMART_REPLY, SMART_COMPOSE, KNOWLEDGE_SEARCH, KNOWLEDGE_ASSIST, ENTITY_EXTRACTION.
  • context-filter-settings drop-handoff-messages=false
    • If set to true, the last message from virtual agent (hand off message) and the message before it (trigger message of hand off) are dropped.
  • drop-ivr-messages=false
    • If set to true, all messages from ivr stage are dropped.
  • drop-virtual-agent-messages=false

    • If set to true, all messages from virtual agent are dropped.
  • ..dialogflow-query-source agent=gubergren

    • Required. The name of a Dialogflow virtual agent used for end user side intent detection and suggestion. Format: projects//locations//agent. When multiple agents are allowed in the same Dialogflow project.
  • human-agent-side-config agent=elitr

    • Optional. The name of a dialogflow virtual agent used for intent detection and suggestion triggered by human agent. Format: projects//locations//agent.
  • ...document-query-source documents=ipsum

    • Required. Knowledge documents to query from. Format: projects//locations//knowledgeBases//documents/. Currently, at most 5 documents are supported.
    • Each invocation of this argument appends the given value to the array.
  • ..knowledge-base-query-source knowledge-bases=kasd

    • Required. Knowledge bases to query. Format: projects//locations//knowledgeBases/. Currently, at most 5 knowledge bases are supported.
    • Each invocation of this argument appends the given value to the array.
  • .. max-results=67

    • Maximum number of results to return. Currently, if unset, defaults to 10. And the max number is 20.
  • sections section-types=lorem

    • The selected sections chosen to return when requesting a summary of a conversation. A duplicate selected section will be treated as a single selected section. If section types are not provided, the default will be {SITUATION, ACTION, RESULT}.
    • Each invocation of this argument appends the given value to the array.
  • ...suggestion-feature type=amet

    • Type of Human Agent Assistant API feature to request.
  • ..suggestion-trigger-settings no-smalltalk=true

    • Do not trigger if last utterance is small talk.
  • only-end-user=false
    • Only trigger suggestion if participant role of last utterance is END_USER.

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