AssistantApiSuggestionsSupport

AI Overview😉

  • The potential purpose of this module is to determine the capabilities of a client (e.g. a mobile app or web browser) in terms of supporting various features related to suggestion chips, such as impersonation, debug data, history chips, and more. This information helps the Assistant API to tailor its responses and user interface to the client's capabilities.
  • This module could impact search results by influencing the types of suggestions that are displayed to the user, as well as how those suggestions are presented. For example, if a client does not support the "drlHistoryChipSupported" feature, the Assistant API may not display a history chip in the suggestion results. This could affect the user's experience and the relevance of the search results.
  • A website may change things to be more favorable for this function by ensuring that their client (e.g. mobile app or web browser) supports as many of the listed features as possible. This could involve updating their client's software or configuration to enable features like impersonation, debug data, and history chips. By supporting more features, the website may be able to provide a more comprehensive and user-friendly search experience.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupport (google_api_content_warehouse v0.4.0)

Next ID: 18

Attributes

  • clickImpersonationSupported (type: boolean(), default: nil) - Whether client supports user impersonation on suggestion chip click. go/suggestion-click-impersonation
  • debugDataSupported (type: boolean(), default: nil) - Whether client supports suggestions debug data to be displayed.
  • drlHistoryChipSupported (type: boolean(), default: nil) - Whether DRL history chip is supported. Related bug: http://b/241837879, http://b/171854732 Design doc: http://go/panthera-history-chip-dd DRL history chip was originally rolled out to Panthera in http://google3/googledata/experiments/mobile/agsa/studies/agsa_nga/opa_panthera_one_input_ui_launch.gcl?l=55&rcl=384682900. We plan to roll it out to NGA and TNG. drl_history_chip_supported bit specifies whether the client support (and should have) DRL history chip.
  • escapeHatchSupported (type: String.t, default: nil) - Whether client supports escape hatches aka post execution suggestions go/nga-escape-hatch-prd
  • executedTextSupported (type: boolean(), default: nil) - Whether the client can rewrite suggestion query text into executed text, if the latter is present. If this feature is disabled, the rewrite happens in Assistant Server.
  • executionContextSupported (type: boolean(), default: nil) - Whether the client supports passing back execution_context from |assistant.api.client_op.SuggestionProcessingParams| when the suggestion is clicked or spoken.
  • featureSpecificActionSupport (type: GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureSpecificActionSupport.t, default: nil) - Whether the client supports features in |SuggestionFeatureSpecificAction|.
  • featureSpecificAppActionsNotificationSupported (type: boolean(), default: nil) - Whether the client supports handling App Actions' notification when the suggestion is clicked. This will allow the server to populate the app_actions_notification_data extension field from |SuggestionFeatureSpecificAction| proto message.
  • multiStepTrySayingSupported (type: boolean(), default: nil) - Whether the multi-step try saying suggestion feature is supported. dd: go/tng-multi-step-simplified
  • ruleIdInExecutionContextSupported (type: boolean(), default: nil) - Whether the rule_id field in the execution_context is supported. This is a temporary workaround to be able to identify clicks on Person entity suggestions on Sabrina and is expected to be eventually deprecated. TODO(b/185517153) : Deprecate (but do not delete) once click tracking is correctly sent up from the Katniss client.
  • showExecutedTextSupported (type: boolean(), default: nil) - Whether the client can show executed_text after the click on the suggestion chip. Must be set to false on TNG. TNG disregards |SuggestionProcessingParams.show_executed_text| field and always treats it as if |show_executed_text=true|.
  • showTranslationSupported (type: boolean(), default: nil) - Whether the client can show chip as (text | translation). go/lang-partner-doc

  • supportedDisplayTargets (type: list(GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupportDisplayTargetSupport.t), default: nil) - A list of suggestions display targets supported by this client. If unset only DEFAULT SuggestionDisplayTarget is supported.
  • widgetDataSupported (type: boolean(), default: nil) - Whether client supports widget suggestion chip to be displayed.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupport{
  clickImpersonationSupported: boolean() | nil,
  debugDataSupported: boolean() | nil,
  drlHistoryChipSupported: boolean() | nil,
  escapeHatchSupported: String.t() | nil,
  executedTextSupported: boolean() | nil,
  executionContextSupported: boolean() | nil,
  featureSpecificActionSupport:
    GoogleApi.ContentWarehouse.V1.Model.AssistantApiFeatureSpecificActionSupport.t()
    | nil,
  featureSpecificAppActionsNotificationSupported: boolean() | nil,
  multiStepTrySayingSupported: boolean() | nil,
  ruleIdInExecutionContextSupported: boolean() | nil,
  showExecutedTextSupported: boolean() | nil,
  showTranslationSupported: boolean() | nil,
  supportedDisplayTargets:
    [
      GoogleApi.ContentWarehouse.V1.Model.AssistantApiSuggestionsSupportDisplayTargetSupport.t()
    ]
    | nil,
  widgetDataSupported: boolean() | nil
}

Functions

Link to this function

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.