Schema

La definizione dello schema per un'origine dati.

Rappresentazione JSON
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Campi
objectDefinitions[]

object (ObjectDefinition)

L'elenco di oggetti di primo livello per l'origine dati. Il numero massimo di elementi è 10.

operationIds[]

string

ID delle operazioni a lunga esecuzione (LRO) attualmente in esecuzione per questo schema. Dopo aver modificato lo schema, attendi il completamento delle operazioni prima di indicizzare i contenuti aggiuntivi.

ObjectDefinition

La definizione di un oggetto all'interno di un'origine dati.

Rappresentazione JSON
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Campi
name

string

Il nome dell'oggetto, che ne definisce il tipo. Le richieste di indicizzazione degli articoli devono impostare il campo objectType su un valore uguale a questo. Ad esempio, se name è Documento, le richieste di indicizzazione per elementi di tipo Documento dovrebbero impostare objectType uguale a Documento. Ogni definizione dell'oggetto deve avere un nome univoco all'interno di uno schema. Il nome deve iniziare con una lettera e può contenere solo lettere (A-Z, a-z) o numeri (0-9). La lunghezza massima è di 256 caratteri.

options

object (ObjectOptions)

Le opzioni facoltative specifiche dell'oggetto.

propertyDefinitions[]

object (PropertyDefinition)

Definizioni delle proprietà dell'oggetto. Il numero massimo di elementi è 1000.

ObjectOptions

Le opzioni per un oggetto.

Rappresentazione JSON
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Campi
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Le opzioni di aggiornamento di un oggetto.

displayOptions

object (ObjectDisplayOptions)

Le opzioni che determinano come l'oggetto viene visualizzato nella pagina dei risultati di Cloud Search.

suggestionFilteringOperators[]

string

Operatori che possono essere utilizzati per filtrare i suggerimenti. Per l'API query.suggest, solo gli operatori qui menzionati verranno rispettati nel FilterOptions. Sono supportati solo gli operatori TEXT ed ENUM.

NOTA: "objecttype", "type" e "mimetype" sono già supportati. Questa proprietà consente di configurare operatori specifici dello schema.

Anche se si tratta di un array, è possibile specificare un solo operatore. Questo è un array per l'estensibilità futura.

La mappatura degli operatori a più proprietà all'interno dello stesso oggetto non è supportata. Se l'operatore si estende su tipi di oggetti diversi, questa opzione deve essere impostata una volta per ogni definizione dell'oggetto.

ObjectOptions.FreshnessOptions

Indica la proprietà di aggiornamento da utilizzare durante la regolazione del ranking di ricerca di un articolo. Date più fresche e recenti indicano una qualità superiore. Utilizza la proprietà dell'opzione di aggiornamento che meglio funziona con i tuoi dati. Per i documenti di condivisione file, l'ora dell'ultima modifica è più pertinente. Per i dati sugli eventi del calendario, l'ora in cui si verifica l'evento è un indicatore di aggiornamento più pertinente. In questo modo, gli eventi di calendario che si verificano più a ridosso della query di ricerca vengono considerati di qualità superiore e classificati di conseguenza.

Rappresentazione JSON
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Campi
freshnessProperty

string

Questa proprietà indica il livello di aggiornamento dell'oggetto nell'indice. Se impostata, questa proprietà deve essere una proprietà di primo livello all'interno di property definitions e deve essere timestamp type o date type. In caso contrario, l'API Index utilizza updateTime come indicatore di aggiornamento. La lunghezza massima è di 256 caratteri.

Quando viene utilizzata una proprietà per calcolare l'aggiornamento, il valore predefinito è 2 anni dall'ora corrente.

freshnessDuration

string (Duration format)

Il periodo di tempo dopo il quale un oggetto deve essere considerato inattivo. Il valore predefinito è 180 giorni (in secondi).

Durata in secondi con un massimo di nove cifre frazionarie e termina con "s". Esempio: "3.5s".

ObjectDisplayOptions

Le opzioni di visualizzazione di un oggetto.

Rappresentazione JSON
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Campi
objectDisplayLabel

string

L'etichetta facile da mostrare da mostrare nel risultato di ricerca per indicare il tipo di articolo. Questo è FACOLTATIVO; se non viene specificata, l'etichetta di un oggetto non viene visualizzata nella riga contestuale dei risultati di ricerca. La lunghezza massima è di 64 caratteri.

metalines[]

object (ObjectDisplayOptions.Metaline)

Definisce le proprietà visualizzate nelle metaline dei risultati di ricerca. I valori delle proprietà vengono visualizzati nell'ordine indicato qui. Se una proprietà contiene più valori, tutti questi vengono visualizzati prima delle proprietà successive. Per questo motivo, è buona norma specificare le proprietà singolari prima delle proprietà ripetute in questo elenco. Tutte le proprietà devono impostare isReturnable su true. Il numero massimo di metalinee è 3.

ObjectDisplayOptions.Metaline

Una metaline è un elenco di proprietà che vengono visualizzate insieme al risultato di ricerca per fornire contesto.

Rappresentazione JSON
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Campi
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

L'elenco di proprietà visualizzate per la metaline. Il numero massimo di proprietà è 5.

ObjectDisplayOptions.DisplayedProperty

Un riferimento a una proprietà di primo livello all'interno dell'oggetto da visualizzare nei risultati di ricerca. I valori delle strutture scelte vengono visualizzati nei risultati di ricerca insieme al display label per quella proprietà, se specificata. Se non viene specificata un'etichetta di visualizzazione, vengono mostrati solo i valori.

Rappresentazione JSON
{
  "propertyName": string
}
Campi
propertyName

string

Il nome della proprietà di primo livello come definito in una definizione della proprietà per l'oggetto. Se il nome non è una proprietà definita nello schema, viene fornito un errore quando tenti di aggiornare lo schema.

PropertyDefinition

La definizione di una proprietà all'interno di un oggetto.

Rappresentazione JSON
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
Campi
name

string

Il nome della struttura. Le richieste di indicizzazione degli articoli inviate all'API Index devono impostare property name uguale a questo valore. Ad esempio, se il nome è subject_line, le richieste di indicizzazione per gli elementi del documento con campi dell'oggetto dovrebbero impostare il name per quel campo su un valore uguale a subject_line. Utilizza il nome come identificatore della proprietà dell'oggetto. Dopo la registrazione come proprietà di un oggetto, non puoi riutilizzare questo nome per un'altra proprietà all'interno dell'oggetto. Il nome deve iniziare con una lettera e può contenere solo lettere (A-Z, a-z) o numeri (0-9). La lunghezza massima è di 256 caratteri.

isReturnable

boolean

Indica che la proprietà identifica i dati che devono essere restituiti nei risultati di ricerca tramite l'API Query. Se impostato su true, indica che gli utenti dell'API Query possono utilizzare i campi della proprietà corrispondenti nei risultati. Tuttavia, l'archiviazione dei campi richiede una maggiore allocazione di spazio e utilizza più larghezza di banda per le query di ricerca, con ripercussioni sulle prestazioni su set di dati di grandi dimensioni. Impostalo su true qui solo se il campo è necessario per i risultati di ricerca. Non può essere true per le proprietà il cui tipo è un oggetto.

isRepeatable

boolean

Indica che sono consentiti più valori per la proprietà. Ad esempio, un documento ha una sola descrizione, ma può avere più commenti. Non può essere true per le proprietà di tipo booleano. Se viene impostato su false, le proprietà che contengono più di un valore causano il rifiuto della richiesta di indicizzazione per l'elemento.

isSortable

boolean

Indica che la proprietà può essere utilizzata per l'ordinamento. Non può essere true per le proprietà ripetibili. Non può essere true per le proprietà il cui tipo è oggetto. Per impostare questa opzione, il valore IsReturnable deve essere true. Supportata solo per le proprietà booleane, date, doppie, numeri interi e timestamp.

isFacetable

boolean

Indica che la proprietà può essere utilizzata per generare facet. Non può essere true per le proprietà il cui tipo è oggetto. Per impostare questa opzione, il valore IsReturnable deve essere true. Supportata solo per le proprietà booleane, enum, interi e di testo.

isSuggestable

boolean

Indica che la proprietà può essere utilizzata per generare suggerimenti per le query.

isWildcardSearchable

boolean

Indica che gli utenti possono eseguire ricerche con caratteri jolly per questa proprietà. Supportata solo per le proprietà di testo. Per impostare questa opzione, il valore IsReturnable deve essere true. In una determinata origine dati, è possibile contrassegnare un massimo di cinque proprietà come isWildcardSearchable. Per ulteriori dettagli, consulta Definire le proprietà dell'oggetto.

displayOptions

object (PropertyDisplayOptions)

Le opzioni che determinano come la proprietà viene visualizzata nella pagina dei risultati di Cloud Search se è specificata per essere visualizzata nell'oggetto display options.

Campo unione property_options. Le opzioni specifiche del tipo che determinano il modo in cui la proprietà viene indicizzata e utilizzata. Nel caso in cui le opzioni siano le opzioni predefinite per un tipo, questo campo deve comunque essere impostato su uno dei tipi. Se questo campo non viene impostato, gli aggiornamenti dello schema vengono rifiutati. property_options può essere solo uno dei seguenti:
integerPropertyOptions

object (IntegerPropertyOptions)

doublePropertyOptions

object (DoublePropertyOptions)

timestampPropertyOptions

object (TimestampPropertyOptions)

booleanPropertyOptions

object (BooleanPropertyOptions)

objectPropertyOptions

object (ObjectPropertyOptions)

enumPropertyOptions

object (EnumPropertyOptions)

datePropertyOptions

object (DatePropertyOptions)

textPropertyOptions

object (TextPropertyOptions)

htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

Le opzioni per le proprietà di numeri interi.

Rappresentazione JSON
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Campi
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Utilizzato per specificare il ranking ordinato per il numero intero. Può essere utilizzato solo se isRepeatable è false.

minimumValue

string (Int64Value format)

Il valore minimo della proprietà. I valori minimo e massimo della proprietà vengono utilizzati per classificare i risultati in base a ordered ranking. Le richieste di indicizzazione con valori inferiori al minimo vengono accettate e classificate con lo stesso peso degli elementi indicizzati con il valore minimo.

maximumValue

string (Int64Value format)

Il valore massimo della proprietà. I valori minimo e massimo della proprietà vengono utilizzati per classificare i risultati in base a ordered ranking. Le richieste di indicizzazione con valori superiori al massimo vengono accettate e classificate con lo stesso peso degli elementi indicizzati con il valore massimo.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Se impostato, descrive come utilizzare il numero intero come operatore di ricerca.

integerFacetingOptions

object (IntegerFacetingOptions)

Se impostato, descrive le opzioni di faceting con numeri interi per la proprietà di numeri interi specificata. La proprietà del valore intero corrispondente deve essere contrassegnata come isFacetable.

IntegerPropertyOptions.OrderedRanking

Utilizzato per specificare come deve essere classificato un valore intero rispetto ad altri valori. Un numero intero con un ranking in ordine più alto suggerisce una maggiore importanza. Ad esempio, in alcune origini dati una priorità più bassa indica un'importanza maggiore, mentre in altre una priorità più alta indica un'importanza più elevata.

Enum
NO_ORDER Non esiste un ordine di ranking per la proprietà. I risultati non vengono modificati dal valore di questa proprietà.
ASCENDING Questa proprietà è ordinata in ordine crescente. Valori più bassi indicano un ranking inferiore.
DESCENDING Questa proprietà è posizionata in ordine decrescente. Valori più bassi indicano un ranking più elevato.

IntegerPropertyOptions.IntegerOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà di numeri interi. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà numero intero. Ad esempio, se operatorName è Priority e il nome della proprietà è PriorityVal, query come Priority:<value> mostrano risultati solo dove il valore della proprietà denominata PriorityVal corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà del numero intero utilizzando l'operatore di tipo minore di. Ad esempio, se lessThanOperatorName è Priority below e il nome della proprietà è PriorityVal, le query come Priority below:<value> mostrano risultati solo dove il valore della proprietà denominato PriorityVal è minore di <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà dei numeri interi utilizzando l'operatore "maggiore di". Ad esempio, se higherThanOperatorName è Priorityabove e il nome della proprietà è PriorityVal, query come Priorityabove:<value> mostrano risultati solo quando il valore della proprietà denominato PriorityVal è maggiore di <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

DoublePropertyOptions

Le opzioni per le proprietà doppie.

Rappresentazione JSON
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Campi
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Se impostato, descrive come utilizzare il double come operatore di ricerca.

DoublePropertyOptions.DoubleOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà doppie. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore obbligatorio nella query per utilizzare la proprietà doppia nell'ordinamento o come facet. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

TimestampPropertyOptions

Le opzioni per le proprietà del timestamp.

Rappresentazione JSON
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Campi
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Se impostato, descrive in che modo il timestamp deve essere utilizzato come operatore di ricerca.

TimestampPropertyOptions.TimestampOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà timestamp. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà timestamp. Ad esempio, se operatorName è closedon e il nome della proprietà è closeDate, le query come closedon:<value> mostrano risultati solo dove il valore della proprietà denominata closeDate corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà timestamp utilizzando l'operatore minore di. Ad esempio, se lessThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano risultati solo dove il valore della proprietà denominato closeDate è precedente a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà timestamp con l'operatore maggiore. Ad esempio, se higherThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano risultati solo dove il valore della proprietà denominato closeDate è successivo a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

BooleanPropertyOptions

Le opzioni per le proprietà booleane.

Rappresentazione JSON
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Campi
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Se impostato, descrive come utilizzare il valore booleano come operatore di ricerca.

BooleanPropertyOptions.BooleanOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà booleane. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà booleana. Ad esempio, se operatorName è closed e il nome della proprietà è isClosed, query come closed:<value> mostrano risultati solo dove il valore della proprietà denominata isClosed corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

ObjectPropertyOptions

Le opzioni per le proprietà degli oggetti.

Rappresentazione JSON
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Campi
subobjectProperties[]

object (PropertyDefinition)

Le proprietà dell'oggetto secondario. Queste proprietà rappresentano un oggetto nidificato. Ad esempio, se questa proprietà rappresenta un indirizzo postale, il valore subobjectProperties potrebbe essere denominato street, city e state. Il numero massimo di elementi è 1000.

EnumPropertyOptions

Le opzioni per le proprietà enum, che consentono di definire un insieme limitato di stringhe per soddisfare le query degli utenti, impostare i ranking per i valori di stringa e definire un nome di operatore da associare a tali stringhe, in modo che gli utenti possano restringere i risultati solo agli elementi con un valore specifico. Ad esempio, per gli elementi in un sistema di monitoraggio delle richieste con informazioni sulla priorità, puoi definire p0 come valore enum consentito e associarla al nome dell'operatore Priority, in modo che gli utenti della ricerca possano aggiungere Priority:p0 alla propria query per limitare l'insieme di risultati solo agli elementi indicizzati con il valore p0.

Rappresentazione JSON
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Campi
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

L'elenco di valori possibili per la proprietà di enumerazione. Tutte le coppie EnumValuePairs devono fornire un valore stringa. Se specifichi un valore intero per un EnumValuePair, tutte le EnumValuePairs possibili devono fornire un valore intero. Sia il valore della stringa che il valore intero devono essere univoci rispetto a tutti i valori possibili. Una volta impostati, i valori possibili non possono essere rimossi o modificati. Se fornisci un ranking ordinato e ritieni di poter inserire altri valori enum in futuro, lascia degli spazi vuoti nei valori interi iniziali per consentire di aggiungere un valore tra i valori registrati in precedenza. Il numero massimo di elementi è 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Utilizzato per specificare il ranking ordinato per l'enumerazione che determina il modo in cui vengono utilizzati i valori interi forniti nelle possibili EnumValuePairs per classificare i risultati. Se specificati, devono essere forniti valori interi per tutti i possibili valori EnumValuePair specificati per questa proprietà. Può essere utilizzato solo se isRepeatable è false.

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Se impostato, descrive come utilizzare l'enum come operatore di ricerca.

EnumPropertyOptions.EnumValuePair

La coppia di valori di enumerazione definisce due cose: un valore di stringa obbligatorio e un valore intero facoltativo. Il valore stringa definisce il termine di query necessario per recuperare l'elemento, ad esempio p0 per un elemento prioritario. Il valore intero determina il ranking di quel valore di stringa rispetto ad altri valori enumerati per la stessa proprietà. Ad esempio, puoi associare p0 a 0 e definire un'altra coppia di enumerazione come p1 e 1. Devi utilizzare il valore intero in combinazione con ordered ranking per impostare il ranking di un determinato valore rispetto ad altri valori enumerati per lo stesso nome di proprietà. In questo caso, un ordine di ranking DESCENDING per le proprietà priorità determina un miglioramento del ranking per gli elementi indicizzati con un valore p0 rispetto agli elementi indicizzati con un valore p1. Senza un ordine di ranking specificato, il valore intero non ha alcun effetto sul ranking dell'articolo.

Rappresentazione JSON
{
  "stringValue": string,
  "integerValue": integer
}
Campi
stringValue

string

Il valore stringa di EnumValuePair. La lunghezza massima è di 32 caratteri.

integerValue

integer

Il valore intero dell'EnumValuePair che deve essere non negativo. (Facoltativo)

EnumPropertyOptions.OrderedRanking

Utilizzato per specificare la direzione di ranking per un numero intero EnumValuePair rispetto ad altri valori interi EnumValuePair. Per alcune proprietà, valori interi più bassi indicano un'importanza maggiore, mentre in altre un numero intero più alto indica un'importanza maggiore.

Enum
NO_ORDER Non esiste un ordine di ranking per la proprietà. I risultati non vengono modificati dal valore di questa proprietà.
ASCENDING Questa proprietà è ordinata in ordine crescente. Valori più bassi indicano un ranking inferiore.
DESCENDING Questa proprietà è posizionata in ordine decrescente. Valori più bassi indicano un ranking più elevato.

EnumPropertyOptions.EnumOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà enum. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato. Ad esempio, se non fornisci alcun operatore per una proprietà enum Priority con possibili valori p0 e p1, una query contenente il termine p0 restituisce gli elementi che hanno p0 come valore della proprietà Priority, nonché qualsiasi elemento contenente la stringa p0 in altri campi. Se fornisci un nome dell'operatore per l'enumerazione, come Priority, gli utenti della ricerca possono utilizzare questo operatore per perfezionare i risultati limitando i risultati solo agli elementi il cui valore di questa proprietà è p0, con la query Priority:p0.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore richiesto nella query per isolare la proprietà enum. Ad esempio, se operatorName è Priority e il nome della proprietà è PriorityVal, query come Priority:<value> mostrano risultati solo dove il valore della proprietà denominata PriorityVal corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

DatePropertyOptions

Le opzioni per le proprietà delle date.

Rappresentazione JSON
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Campi
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Se impostato, descrive come utilizzare la data come operatore di ricerca.

DatePropertyOptions.DateOperatorOptions

(Facoltativo) Fornisce un operatore di ricerca per le proprietà delle date. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Campi
operatorName

string

Indica la stringa effettiva richiesta nella query per isolare la proprietà della data. Ad esempio, supponiamo che un oggetto schema di monitoraggio dei problemi abbia una proprietà denominata closeDate che specifica un operatore con il valore operatorName closedon. Per le ricerche con quei dati, query come closedon:&lt;value&gt; mostrano risultati solo in cui il valore della proprietà closedon:&lt;value&gt; corrisponde a closedon:&lt;value&gt;. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà String o del testo all'interno del campo content per l'origine dati indicizzata. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

lessThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà della data utilizzando l'operatore minore di. Ad esempio, se lessThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano risultati solo dove il valore della proprietà denominato closeDate è precedente a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

greaterThanOperatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà date utilizzando l'operatore maggiore. Ad esempio, se higherThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano risultati solo dove il valore della proprietà denominato closeDate è successivo a <value>. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

TextPropertyOptions

Le opzioni per le proprietà del testo.

Rappresentazione JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Campi
retrievalImportance

object (RetrievalImportance)

Indica l'importanza della qualità della ricerca dei token all'interno del campo quando sono utilizzati per il recupero.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Se impostato, descrive come utilizzare la proprietà come operatore di ricerca.

RetrievalImportance

Rappresentazione JSON
{
  "importance": enum (RetrievalImportance.Importance)
}
Campi
importance

enum (RetrievalImportance.Importance)

Indica l'importanza del ranking assegnata alla proprietà quando viene rilevata una corrispondenza durante il recupero. Una volta impostata, l'importanza del token di una proprietà non può essere modificata.

RetrievalImportance.Importance

Enum
DEFAULT Considera la corrispondenza come una corrispondenza del corpo del testo.
HIGHEST Considera la corrispondenza come una corrispondenza con il titolo dell'elemento.
HIGH Considera la corrispondenza con un'importanza maggiore rispetto al corpo del testo.
LOW Considera la corrispondenza con un'importanza minore rispetto al corpo del testo.
NONE Non trovare corrispondenze con questo campo durante il recupero. La proprietà può comunque essere utilizzata per la corrispondenza degli operatori, il faceting e, se necessario, suggerimenti.

TextPropertyOptions.TextOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà del testo. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Campi
operatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà di testo. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, le query come subject:<value> mostrano risultati solo dove il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà di testo o testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

exactMatchWithOperator

boolean

Se true, il valore di testo viene tokenizzato come un valore atomico nelle ricerche degli operatori e nelle corrispondenze dei facet. Ad esempio, se il nome dell'operatore è "gender" e il valore è "fantascienza" le restrizioni delle query "genere:scienza" e "gender:fiction" non corrisponde all'elemento; "genere:fantascienza" encoder-decoder. La corrispondenza dei valori di testo è sensibile alle maiuscole e non rimuove i caratteri speciali. Se il valore è false, il testo viene tokenizzato. Ad esempio, se il valore è "fantascienza" le query "genere:scienza" e "gender:fiction" corrisponde all'articolo.

HtmlPropertyOptions

Le opzioni per le proprietà HTML.

Rappresentazione JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Campi
retrievalImportance

object (RetrievalImportance)

Indica l'importanza della qualità della ricerca dei token all'interno del campo quando sono utilizzati per il recupero. Può essere impostato solo su PREDEFINITO o su NESSUNO.

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Se impostato, descrive come utilizzare la proprietà come operatore di ricerca.

HtmlPropertyOptions.HtmlOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà html. Questa opzione è facoltativa. Gli operatori query.search consentono agli utenti di limitare la query a campi specifici pertinenti al tipo di elemento cercato.

Rappresentazione JSON
{
  "operatorName": string
}
Campi
operatorName

string

Indica il nome dell'operatore obbligatorio nella query per isolare la proprietà html. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, le query come subject:<value> mostrano risultati solo dove il valore della proprietà denominata subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso &lt;value&gt; senza un operatore restituisce tutti gli elementi in cui &lt;value&gt; corrisponde al valore di qualsiasi proprietà html o testo all'interno del campo content per l'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

PropertyDisplayOptions

Le opzioni di visualizzazione di una proprietà.

Rappresentazione JSON
{
  "displayLabel": string
}
Campi
displayLabel

string

L'etichetta facile da usare per la proprietà utilizzata se questa viene specificata per essere visualizzata in ObjectDisplayOptions. Se fornita, l'etichetta viene mostrata davanti ai valori della proprietà quando la proprietà fa parte delle opzioni di visualizzazione dell'oggetto. Ad esempio, se il valore della proprietà è "1", il valore in sé potrebbe non essere un contesto utile per l'utente. Se il nome visualizzato era "priorità", l'utente vede "priorità 1" nei risultati di ricerca, il che fornisce un contesto chiaro agli utenti. Questo è FACOLTATIVO; Se non viene specificato, vengono visualizzati solo i valori delle proprietà. La lunghezza massima è di 64 caratteri.