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. Per le richieste di indicizzazione degli articoli, il campo objectType deve essere uguale a questo valore. Ad esempio, se nome è Documento, le richieste di indicizzazione per gli elementi di tipo Documento devono impostare objectType uguale a Documento. Ogni definizione di 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 per un oggetto.

displayOptions

object (ObjectDisplayOptions)

Le opzioni che determinano come viene visualizzato l'oggetto 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 menzionati qui 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 a diversi tipi di oggetti, questa opzione deve essere impostata una sola volta per ogni definizione dell'oggetto.

ObjectOptions.FreshnessOptions

Indica la proprietà di aggiornamento da utilizzare per la regolazione del ranking di ricerca di un elemento. Le date più fresche e più recenti indicano una qualità migliore. Utilizza la proprietà dell'opzione di aggiornamento più adatta ai tuoi dati. Per i documenti condivisibili, l'ora dell'ultima modifica è quella più pertinente. Per i dati sugli eventi di calendario, un indicatore di aggiornamento più pertinente è l'ora in cui si verifica l'evento. In questo modo, gli eventi di calendario che si verificano più vicino al momento 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 Indexing utilizza updateTime come indicatore di aggiornamento. La lunghezza massima è di 256 caratteri.

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

freshnessDuration

string (Duration format)

La durata dopo la quale un oggetto deve essere considerato inattivo. Il valore predefinito è 180 giorni (in secondi).

Una durata in secondi con un massimo di nove cifre frazionarie, che 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 usare da visualizzare nei risultati di ricerca per indicare il tipo di elemento. Questo è FACOLTATIVO; se non viene fornito, un'etichetta oggetto non viene visualizzata nella riga di contesto dei risultati di ricerca. La lunghezza massima è di 64 caratteri.

metalines[]

object (ObjectDisplayOptions.Metaline)

Definisce le proprietà visualizzate nelle metalinee 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 della proprietà successiva. Per questo motivo, è buona norma specificare proprietà singolari prima di ripetere le proprietà in questo elenco. Tutte le proprietà devono impostare isReturnable su true. Il numero massimo di metaline è 3.

ObjectDisplayOptions.Metaline

Una metalinea è 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 delle proprietà visualizzate per la metalinea. 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 proprietà scelte vengono visualizzati nei risultati di ricerca insieme all'attributo 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 di proprietà per l'oggetto. Se il nome non è una proprietà definita nello schema, viene visualizzato un errore durante il tentativo di aggiornamento dello 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 proprietà. Le richieste di indicizzazione degli articoli inviate all'API Indexing devono impostare property name su questo valore. Ad esempio, se il nome è subject_line, le richieste di indicizzazione relative agli elementi dei documenti con campi dell'oggetto devono impostare il valore name per quel campo su subject_line. Utilizza il nome come identificatore della proprietà dell'oggetto. Una volta registrato come proprietà per 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 nei risultati i campi delle proprietà corrispondenti. Tuttavia, l'archiviazione dei campi richiede una maggiore allocazione di spazio e utilizza più larghezza di banda per le query di ricerca, il che influisce 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à il cui tipo è booleano. Se il criterio viene impostato su false, le proprietà che contengono più di un valore comportano il rifiuto della richiesta di indicizzazione per quell'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, IsReturnable deve essere true. Opzione supportata solo per le proprietà booleane, data, 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, IsReturnable deve essere true. Funzionalità supportata solo per le proprietà booleane, enum, intere 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à. Funzionalità supportata solo per le proprietà di testo. Per impostare questa opzione, IsReturnable deve essere true. In una determinata origine dati, è possibile contrassegnare come isWildcardSearchable un massimo di cinque proprietà. Per maggiori dettagli, consulta Definire le proprietà degli oggetti.

displayOptions

object (PropertyDisplayOptions)

Le opzioni che determinano la modalità di visualizzazione della proprietà nella pagina dei risultati di Cloud Search se è stata specificata la visualizzazione nel display options dell'oggetto.

Campo di unione property_options. Le opzioni specifiche per tipo che determinano il modo in cui la proprietà viene indicizzata e utilizzata. Nel caso in cui le opzioni debbano essere predefinite per un tipo, questo campo deve comunque essere impostato su uno dei tipi. Se questo campo non viene configurato, 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à dei 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 al ordered ranking. Le richieste di indicizzazione con valori inferiori al minimo vengono accettate e classificate con la stessa ponderazione degli articoli 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 al ordered ranking. Le richieste di indicizzazione con valori superiori al massimo vengono accettate e classificate con la stessa ponderazione degli articoli 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 di numeri interi per la proprietà intera specificata. La proprietà del numero intero corrispondente deve essere contrassegnata come isFacetable.

IntegerPropertyOptions.OrderedRanking

Utilizzato per specificare come classificare un valore intero rispetto agli altri valori. Un numero intero con un ranking più elevato suggerisce un'importanza maggiore. Ad esempio, in alcune origini dati una priorità più bassa indica un'importanza maggiore, mentre in altre una priorità più alta indica un'importanza maggiore.

Enum
NO_ORDER Non è presente alcun ordine di ranking per la proprietà. I risultati non vengono modificati in base al valore di questa proprietà.
ASCENDING Questa proprietà è classificata in ordine crescente. Valori più bassi indicano un ranking più basso.
DESCENDING Questa proprietà è classificata 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. 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 richiesto nella query per isolare la proprietà intera. 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 <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà Stringa o al testo nel campo dei contenuti dell'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 richiesto nella query per isolare la proprietà intera utilizzando l'operatore minore di. Ad esempio, se lessThanOperatorName è Priority below e il nome della proprietà è PriorityVal, le query come Priority below:<value> mostrano i risultati solo quando il valore della proprietà 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 richiesto nella query per isolare la proprietà intera utilizzando l'operatore maggiore di. Ad esempio, se majorThanOperatorName è Priorityabove e il nome della proprietà è PriorityVal, le query come Priorityabove:<value> mostrano i risultati solo quando il valore della proprietà denominata 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. 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 utilizzare la proprietà double per l'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à timestamp.

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

object (TimestampPropertyOptions.TimestampOperatorOptions)

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

TimestampPropertyOptions.TimestampOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà timestamp. 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 richiesto nella query per isolare la proprietà timestamp. Ad esempio, se operatorName è closedon e il nome della proprietà è closeDate, 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 <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà Stringa o al testo nel campo dei contenuti dell'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 richiesto nella query al fine di isolare la proprietà timestamp utilizzando l'operatore minore di. Ad esempio, se menoThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano solo i risultati in cui il valore della proprietà 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 richiesto nella query al fine di isolare la proprietà timestamp utilizzando l'operatore maggiore di. Ad esempio, se majorThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano i risultati solo quando il valore della proprietà denominata closeDate è successivo al valore <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 l'operatore booleano come operatore di ricerca.

BooleanPropertyOptions.BooleanOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà booleane. 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, le query come closed:<value> mostrano i risultati solo quando il valore della proprietà denominata isClosed corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà della stringa o del testo nel campo dei contenuti nel campo dei contenuti. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

ObjectPropertyOptions

Le opzioni relative alle 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, le proprietà secondarie delle proprietà potrebbero essere denominate street, city e state. Il numero massimo di elementi è 1000.

EnumPropertyOptions

Le opzioni delle proprietà enum, che consentono di definire un insieme limitato di stringhe per abbinare le query degli utenti, impostare i ranking per i valori di stringa e definire un nome di operatore da associare a queste stringhe in modo che gli utenti possano limitare 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 di enum consentito e associare questa enum al nome dell'operatore priorità in modo che gli utenti della ricerca possano aggiungere priorità:p0 alla query per limitare l'insieme dei 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 dei possibili valori per la proprietà di enumerazione. Tutte le coppie EnumValuePairs devono fornire un valore stringa. Se specifichi un valore intero per un valore EnumValuePair, tutte le possibili EnumValuePairs devono fornire un valore intero. Sia il valore della stringa che quello intero devono essere univoci rispetto a tutti i valori possibili. Una volta impostati, i possibili valori non possono essere rimossi o modificati. Se fornisci un ranking ordinato e pensi di poter inserire altri valori di enumerazione in futuro, lascia delle lacune nei valori interi iniziali per consentire l'aggiunta di 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 i valori interi forniti nelle possibili EnumValuePairs vengono utilizzati per classificare i risultati. Se specificato, è necessario fornire 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 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 stringa rispetto ad altri valori enumerati per la stessa proprietà. Ad esempio, puoi associare p0 a 0 e definire un'altra coppia di enum 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 pari a DISCENDENTE per le proprietà priorità comporta un miglioramento del ranking per gli elementi indicizzati con un valore pari a p0 rispetto a quelli indicizzati con valore p1. Senza un ordine di ranking specificato, il valore intero non ha effetto sul ranking degli articoli.

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 di EnumValuePair che deve essere un numero non negativo. Campo facoltativo.

EnumPropertyOptions.OrderedRanking

Utilizzato per specificare la direzione di ranking di un numero intero EnumValuePair rispetto ad altri valori interi di 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 è presente alcun ordine di ranking per la proprietà. I risultati non vengono modificati dal valore di questa proprietà.
ASCENDING Questa proprietà è classificata in ordine crescente. Valori più bassi indicano un ranking più basso.
DESCENDING Questa proprietà è classificata in ordine decrescente. Valori più bassi indicano un ranking più elevato.

EnumPropertyOptions.EnumOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà enum. 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 un operatore per una proprietà enum priorità con i possibili valori p0 e p1, una query contenente il termine p0 restituisce elementi che hanno p0 come valore della proprietà Priority, nonché elementi che contengono la stringa p0 in altri campi. Se fornisci un nome operatore per l'enum, ad esempio Priority, gli utenti della ricerca possono utilizzare questo operatore per perfezionare i risultati solo per gli elementi che hanno p0 come valore di questa proprietà, 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 <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà Stringa o al testo nel campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

DatePropertyOptions

Le opzioni relative alle proprietà della data.

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

object (DatePropertyOptions.DateOperatorOptions)

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

DatePropertyOptions.DateOperatorOptions

Campo facoltativo. Fornisce un operatore di ricerca per le proprietà data. 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, supponi che un oggetto schema di monitoraggio dei problemi abbia una proprietà denominata closeDate che specifica un operatore con operatorName pari a closedon. Per le ricerche basate su quei dati, query come closedon:<value> mostrano risultati solo quando il valore della proprietà closeDate corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà Stringa o al testo nel campo dei contenuti 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 richiesto nella query per isolare la proprietà della data utilizzando l'operatore minore di. Ad esempio, se menoThanOperatorName è closedbefore e il nome della proprietà è closeDate, le query come closedbefore:<value> mostrano solo i risultati in cui il valore della proprietà 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 richiesto nella query per isolare la proprietà della data utilizzando l'operatore maggiore di. Ad esempio, se majorThanOperatorName è closedafter e il nome della proprietà è closeDate, le query come closedafter:<value> mostrano i risultati solo quando il valore della proprietà denominata closeDate è successivo al valore <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 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 di ranking assegnata alla proprietà quando viene trovata una corrispondenza durante il recupero. Una volta impostata, l'importanza del token di una proprietà non può essere modificata.

RetrievalImportance.Importance

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

TextPropertyOptions.TextOperatorOptions

Utilizzato per fornire un operatore di ricerca per le proprietà di testo. 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 richiesto nella query per isolare la proprietà di testo. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, query come subject:<value> mostrano risultati solo quando il valore della proprietà subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà di testo o testo nel campo dei contenuti dell'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 è "genere" e il valore è "fantascienza", le limitazioni alla query "genere:scienza" e "genere:fiction" non corrispondono all'elemento; "genere:fantascienza" sì. La corrispondenza dei valori testuali è 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 "genere:fiction" corrispondono 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 utilizzati per il recupero. Può essere impostato solo su PREDEFINITO o NONE.

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. 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à HTML. Ad esempio, se operatorName è subject e il nome della proprietà è subjectLine, query come subject:<value> mostrano risultati solo quando il valore della proprietà subjectLine corrisponde a <value>. Al contrario, una ricerca che utilizza lo stesso <value> senza un operatore restituisce tutti gli elementi in cui <value> corrisponde al valore di qualsiasi proprietà HTML o testo nel campo dei contenuti dell'elemento. Il nome dell'operatore può contenere solo lettere minuscole (a-z). La lunghezza massima è di 32 caratteri.

PropertyDisplayOptions

Le opzioni di visualizzazione per una proprietà.

Rappresentazione JSON
{
  "displayLabel": string
}
Campi
displayLabel

string

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