GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1Control (google_api_discovery_engine v0.28.0)

View Source

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

Attributes

  • associatedServingConfigIds (type: list(String.t), default: nil) - Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
  • boostAction (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostAction.t, default: nil) - Defines a boost-type control
  • conditions (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1Condition.t), default: nil) - Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
  • displayName (type: String.t, default: nil) - Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
  • filterAction (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlFilterAction.t, default: nil) - Defines a filter-type control Currently not supported by Recommendation
  • name (type: String.t, default: nil) - Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
  • promoteAction (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlPromoteAction.t, default: nil) - Promote certain links based on predefined trigger queries. This now only supports basic site search.
  • redirectAction (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlRedirectAction.t, default: nil) - Defines a redirect-type control.
  • solutionType (type: String.t, default: nil) - Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
  • synonymsAction (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlSynonymsAction.t, default: nil) - Treats a group of terms as synonyms of one another.
  • useCases (type: list(String.t), default: nil) - Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1Control{
    associatedServingConfigIds: [String.t()] | nil,
    boostAction:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostAction.t()
      | nil,
    conditions:
      [
        GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1Condition.t()
      ]
      | nil,
    displayName: String.t() | nil,
    filterAction:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlFilterAction.t()
      | nil,
    name: String.t() | nil,
    promoteAction:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlPromoteAction.t()
      | nil,
    redirectAction:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlRedirectAction.t()
      | nil,
    solutionType: String.t() | nil,
    synonymsAction:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlSynonymsAction.t()
      | nil,
    useCases: [String.t()] | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.