REST Resource: projects.locations.collections.engines.controls

Ressource : Control

Définit un comportement conditionnel à utiliser lors de la diffusion. Pour être pris en compte au moment de la diffusion, ils doivent être associés à un ServingConfig. Actions autorisées en fonction de SolutionType.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "associatedServingConfigIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "useCases": [
    enum (SearchUseCase)
  ],
  "conditions": [
    {
      object (Condition)
    }
  ],

  // Union field action can be only one of the following:
  "boostAction": {
    object (BoostAction)
  },
  "filterAction": {
    object (FilterAction)
  },
  "redirectAction": {
    object (RedirectAction)
  },
  "synonymsAction": {
    object (SynonymsAction)
  },
  "promoteAction": {
    object (PromoteAction)
  }
  // End of list of possible types for union field action.
}
Champs
name

string

Immuable. Nom complet projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obligatoire. Nom lisible. Identifiant utilisé dans les vues de l'UI.

Doit être une chaîne encodée au format UTF-8. La limite de longueur est de 128 caractères. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.
associatedServingConfigIds[]

string

Uniquement en sortie. Liste de tous les ID ServingConfig auxquels cette commande est associée. La mise à jour peut prendre jusqu'à 10 minutes après les modifications.
solutionType

enum (SolutionType)

Obligatoire. Immuable. Solution à laquelle appartient le contrôle.

Doit être compatible avec le secteur de la ressource. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.
useCases[]

enum (SearchUseCase)

Spécifie le cas d'utilisation du contrôle. Affecte les champs de conditions qui peuvent être définis. S'applique uniquement à SOLUTION_TYPE_SEARCH. Actuellement, un seul cas d'utilisation est autorisé par commande. Doit être défini lorsque solutionType est SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Détermine quand l'action associée sera déclenchée.

Omettez-le pour toujours appliquer l'action. Actuellement, une seule condition peut être spécifiée. Dans le cas contraire, une erreur INVALID ARGUMENT est renvoyée.

Champ d'union action. Les actions sont limitées par secteur et par solution

Obligatoire. action ne peut être qu'un des éléments suivants :
boostAction

object (BoostAction)

Définit un contrôle de type boost
filterAction

object (FilterAction)

Définit un contrôle de type filtre. Non compatible actuellement avec les recommandations.
redirectAction

object (RedirectAction)

Définit un contrôle de type redirection.
synonymsAction

object (SynonymsAction)

Traite un groupe de termes comme des synonymes les uns des autres.
promoteAction

object (PromoteAction)

Mettez en avant certains liens en fonction de requêtes déclencheurs prédéfinies.

Méthodes

create

 Crée un contrôle.

delete

 Supprime un contrôle.

get

 Permet d'obtenir un contrôle.

list

 Liste tous les contrôles par DataStore parent.

patch

 Met à jour un contrôle.