REST Resource: settings.searchapplications

Risorsa: SearchApplication

SearchApplication

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Campi
name

string

Il nome dell'applicazione di ricerca.

Formato: searchapplications/{applicationId}.
displayName

string

Nome visualizzato dell'applicazione di ricerca. La lunghezza massima è di 300 caratteri.
dataSourceRestrictions[]

object (DataSourceRestriction)

Limitazioni applicate alle configurazioni. Il numero massimo di elementi è 10.
sourceConfig[]

object (SourceConfig)

Configurazione di un'origine specificata in dataSourceRestrizioni.
scoringConfig

object (ScoringConfig)

Configurazione per il ranking dei risultati.
defaultSortOptions

object (SortOptions)

Le opzioni predefinite per ordinare i risultati di ricerca
defaultFacetOptions[]

object (FacetOptions)

I campi predefiniti per la restituzione di risultati facet. Le fonti specificate qui sono state incluse anche in dataSourceRestrictions qui sopra.
returnResultThumbnailUrls

boolean

Con ogni risultato dobbiamo restituire l'URI della miniatura (se applicabile)
operationIds[]

string

Solo output. ID delle operazioni a lunga esecuzione (LRO) attualmente in esecuzione per questo schema. Campo di solo output.
enableAuditLog

boolean

Indica se l'audit logging è attivato/disattivato per le richieste effettuate per l'applicazione di ricerca nelle API delle query.
queryInterpretationConfig

object (QueryInterpretationConfig)

Le opzioni predefinite per l'interpretazione delle query

DataSourceRestriction

Limitazione sull'origine dati.

Rappresentazione JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Campi
source

object (Source)

L'origine della limitazione.
filterOptions[]

object (FilterOptions)

Opzioni di filtro che limitano i risultati. Se sono presenti più filtri, questi vengono raggruppati per tipo di oggetto prima dell'unione. I filtri con lo stesso tipo di oggetto vengono uniti in modo congiuntivo, quindi le espressioni risultanti vengono unite in modo disgiuntivo.

Il numero massimo di elementi è 20.

NOTA. L'API Suggest al momento supporta solo pochi filtri: "objecttype", "type" e "mimetype". Al momento, non è possibile usare filtri specifici dello schema per filtrare i suggerimenti.

Origine

Definisce le origini delle API di suggerimento/ricerca.

Rappresentazione JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Campi

Campo di unione source.

source può essere solo uno dei seguenti:
name

string

Nome della sorgente dei contenuti indicizzati da Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Fonte di contenuto predefinita per Google Apps.

Source.PredefinedSource

Origini predefinite:

Enum
NONE
QUERY_HISTORY Suggerisce query eseguite dall'utente in passato. Valido solo se utilizzato con l'API di suggerimento. Ignorato se utilizzato nell'API Query.
PERSON Suggerisce persone nell'organizzazione. Valido solo se utilizzato con l'API di suggerimento. Restituisce un errore se utilizzato nell'API Query.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Opzioni di filtro da applicare alla query.

Rappresentazione JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Campi
objectType

string

Se è impostato l'attributo objectType, vengono restituiti solo gli oggetti di quel tipo. Deve corrispondere al nome dell'oggetto registrato all'interno della definizione dello schema. La lunghezza massima è di 256 caratteri.
filter

object (Filter)

Filtro generico per limitare la ricerca, ad esempio lang:en, site:xyz.

Filtro

Un modo generico di esprimere i filtri in una query, che supporta due approcci:

1. Impostazione di un Filtro dei valori. Il nome deve corrispondere a un operatorName definito nello schema per l'origine dati.

2. Impostazione di un filtro Composite. I filtri vengono valutati utilizzando l'operatore logico. Gli operatori di primo livello possono essere solo AND o NOT. AND possono essere visualizzate solo al livello più alto. OR può apparire solo sotto un AND di primo livello.

Rappresentazione JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Campi

Campo di unione filter.

filter può essere solo uno dei seguenti:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Rappresentazione JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Campi
operatorName

string

operatorName applicato alla query, ad esempio price_greater_than. Il filtro può funzionare con entrambi i tipi di filtri definiti nello schema per l'origine dati:

  1. operatorName, in cui la query filtra i risultati in base alla proprietà corrispondente al valore.

  2. greaterThanOperatorName o lessThanOperatorName nello schema. La query filtra i risultati in base ai valori della proprietà maggiori o minori del valore specificato nella query.
value

object (Value)

Il valore da confrontare.

Valore

Definizione di un singolo valore con tipo generico.

Rappresentazione JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Campi
Campo di unione value. Il valore della proprietà denominata. value può essere solo uno dei seguenti:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Rappresentazione JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Campi
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

L'operatore logico del filtro secondario.
subFilters[]

object (Filter)

Filtri secondari.

Filter.CompositeFilter.LogicOperator

Enum
AND Operatori logici, che possono essere applicati solo ai filtri secondari.
OR
NOT NOT può essere applicato solo a un singolo filtro secondario.

SourceConfig

Configurazioni per un'origine durante l'elaborazione di una richiesta query.search o query.suggest.

Rappresentazione JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Campi
source

object (Source)

L'origine per la quale deve essere utilizzata questa configurazione.
scoringConfig

object (SourceScoringConfig)

La configurazione del punteggio per l'origine.
crowdingConfig

object (SourceCrowdingConfig)

La configurazione di crowding per l'origine.

SourceScoringConfig

Imposta la configurazione del punteggio. Ciò consente di modificare il ranking dei risultati per una fonte.

Rappresentazione JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Campi
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Importanza della fonte.

SourceScoringConfig.SourceImportance

L'importanza di una fonte, che può essere utilizzata per indicare se a una sorgente deve essere data una priorità maggiore nel ranking rispetto a un'altra fonte.

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Impostare limiti di crowding dei risultati di ricerca. Il crowding è una situazione in cui più risultati provenienti dalla stessa fonte o dalla stessa origine "sostituiscono" altri risultati, riducendo la qualità della ricerca da parte degli utenti. Per migliorare la qualità della ricerca e la diversità delle fonti nei risultati di ricerca, puoi impostare una condizione per ridurre i risultati ripetitivi in base alla fonte.

Rappresentazione JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
Campi
numResults

integer

Numero massimo di risultati consentiti da un'origine dati in una pagina di risultati, purché i risultati di altre origini non siano esauriti. Il valore specificato non deve essere negativo. Se questo valore è uguale a 0, viene utilizzato un valore predefinito. Per disattivare il crowding, imposta un valore superiore a 100.
numSuggestions

integer

Numero massimo di suggerimenti consentiti da un'origine. Se questo valore è inferiore o uguale a 0, non verranno impostati limiti per i risultati.

ScoringConfig

Configurazioni di punteggio per un'origine durante l'elaborazione di una richiesta query.search o query.suggest.

Rappresentazione JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Campi
disableFreshness

boolean

Indica se utilizzare l'aggiornamento come indicatore di ranking. Per impostazione predefinita, l'aggiornamento viene utilizzato come indicatore di ranking. Tieni presente che questa impostazione non è disponibile nell'interfaccia utente amministratore.
disablePersonalization

boolean

Indica se personalizzare i risultati. Per impostazione predefinita, verranno utilizzati indicatori personali per migliorare i risultati.

SortOptions

Rappresentazione JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Campi
operatorName

string

Il nome dell'operatore corrispondente al campo in base al quale effettuare l'ordinamento. La proprietà corrispondente deve essere contrassegnata come sortable.
sortOrder

enum (SortOptions.SortOrder)

L'ordinamento predefinito è crescente

SortOptions.SortOrder

Enum
ASCENDING
DESCENDING

FacetOptions

Specifica gli operatori per i quali restituire i risultati dei facet. Ci sarà un FacetResult per ogni combinazione di sourceName/objectType/operatorName.

Rappresentazione JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Campi
sourceName

string

Nome dell'origine da usare per il facet. Formato: datasources/{sourceId} Se vuoto, verranno utilizzate tutte le origini dati.
objectType

string

Se objectType è impostato, solo gli oggetti di quel tipo verranno utilizzati per calcolare i facet. Se vuoto, tutti gli oggetti verranno utilizzati per calcolare i facet.
operatorName

string

Il nome dell'operatore scelto per il faceting. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Numero massimo di bucket di facet da restituire per questo facet. Il valore predefinito è 10. Il valore massimo è 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Se impostato, descrive le opzioni di faceting di numeri interi per la proprietà intera specificata. La proprietà del numero intero corrispondente nello schema deve essere contrassegnata come isFacetable. Il numero di bucket restituiti sarebbe il minimo compreso tra questo valore e numFacetBucket.

IntegerFacetingOptions

Utilizzato per specificare le opzioni di faceting di numeri interi.

Rappresentazione JSON 
{
  "integerBuckets": [
    string
  ]
}
Campi
integerBuckets[]

string (Int64Value format)

I bucket per determinati valori interi devono essere in ordine rigorosamente crescente. Ad esempio, se i valori forniti sono (1,5,10,100), verranno formati i seguenti bucket di facet {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Opzioni predefinite per interpretare la query dell'utente.

Rappresentazione JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Campi
forceVerbatimMode

boolean

Attiva questo flag per disattivare tutte le ottimizzazioni interne come l'interpretazione delle query in linguaggio naturale (NL), il recupero di risultati supplementari e l'utilizzo di sinonimi, inclusi quelli personalizzati. Se questo flag è impostato su True, avrà la precedenza sull'opzione impostata a livello di query. Per il valore predefinito False, il flag del livello di query imposterà l'interpretazione corretta per la modalità testata.
forceDisableSupplementalResults

boolean

Imposta questo flag per disabilitare il recupero di risultati supplementari. L'impostazione di un flag qui non consente di recuperare risultati supplementari per le query associate a una determinata applicazione di ricerca. Se questo flag è impostato su True, avrà la precedenza sull'opzione impostata a livello di query. Per il valore predefinito False, il flag del livello di query imposterà l'interpretazione corretta per ottenere risultati supplementari.

Metodi

create

 Crea un'applicazione di ricerca.

delete

 Elimina un'applicazione di ricerca.

get

 Restituisce l'applicazione di ricerca specificata.

list

 Elenca tutte le applicazioni di ricerca.

patch

 Consente di aggiornare un'applicazione di ricerca.

reset

 Consente di reimpostare le impostazioni predefinite di un'applicazione di ricerca.

update

 Consente di aggiornare un'applicazione di ricerca.