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

Risorsa: Controllo

Definisce un comportamento condizionato da utilizzare durante la pubblicazione. Deve essere allegato a un ServingConfig per essere preso in considerazione al momento della pubblicazione. Azioni consentite a seconda di SolutionType.

Rappresentazione 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.
}
Campi
name

string

Immutabile. Nome completo projects/*/locations/global/dataStore/*/controls/*
displayName

string

Obbligatorio. Nome leggibile. L'identificatore utilizzato nelle visualizzazioni dell'interfaccia utente.

Deve essere una stringa codificata in UTF-8. Il limite di lunghezza è di 128 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
associatedServingConfigIds[]

string

Solo output. Elenco di tutti gli ID ServingConfig a cui è collegato questo controllo. L'aggiornamento può richiedere fino a 10 minuti dopo le modifiche.
solutionType

enum (SolutionType)

Obbligatorio. Immutabile. A quale soluzione appartiene il controllo.

Deve essere compatibile con il verticale della risorsa. In caso contrario, viene generato un errore INVALID ARGUMENT.
useCases[]

enum (SearchUseCase)

Specifica il caso d'uso per il controllo. Influisce sui campi delle condizioni che possono essere impostati. Si applica solo a SOLUTION_TYPE_SEARCH. Attualmente è consentito un solo caso d'uso per controllo. Deve essere impostato quando solutionType è SolutionType.SOLUTION_TYPE_SEARCH.
conditions[]

object (Condition)

Determina quando verrà attivata l'azione associata.

Ometti per applicare sempre l'azione. Al momento è possibile specificare una sola condizione. In caso contrario, viene generato un errore INVALID ARGUMENT.

Campo unione action. Le azioni sono limitate in base al verticale e alla soluzione

Obbligatorio. action può essere solo uno dei seguenti:
boostAction

object (BoostAction)

Definisce un controllo di tipo boost
filterAction

object (FilterAction)

Definisce un controllo di tipo filtro. Attualmente non supportato da Consigli
redirectAction

object (RedirectAction)

Definisce un controllo di tipo reindirizzamento.
synonymsAction

object (SynonymsAction)

Considera un gruppo di termini come sinonimi.
promoteAction

object (PromoteAction)

Promuovi determinati link in base a query di attivazione predefinite.

Metodi

create

 Crea un controllo.

delete

 Elimina un controllo.

get

 Recupera un controllo.

list

 Elenca tutti i controlli in base al relativo DataStore principale.

patch

 Aggiorna un controllo.