SimpleField interface

Pacchetto:

@azure/search-documents

Rappresenta un campo in una definizione di indice, che descrive il nome, il tipo di dati e il comportamento di ricerca di un campo.

Proprietà

analyzerName	Nome dell'analizzatore da utilizzare per il campo. Questa opzione può essere usata solo con i campi ricercabili e non può essere impostata insieme a searchAnalyzer o indexAnalyzer. Dopo aver scelto l'analizzatore, non può essere modificato per il campo.
facetable	Valore che indica se consentire il riferimento al campo nelle query facet. In genere usato in una presentazione dei risultati della ricerca che include il conteggio dei riscontri per categoria (ad esempio, cercare fotocamere digitali e vedere i riscontri per marchio, per impostazione predefinita, per prezzo e così via). I campi di tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) non possono essere facciabili. Il valore predefinito è false.
filterable	Valore che indica se abilitare il riferimento al campo nelle query $filter. filtrabile differisce dalla modalità di gestione delle stringhe. I campi di tipo Edm.String o Collection(Edm.String) che sono filtrabili non subiscono interruzioni di parole, quindi i confronti sono solo per corrispondenze esatte. Ad esempio, se si imposta tale campo f su "sunny day", $filter=f eq 'sunny' non troverà corrispondenze, ma $filter=f eq 'sunny day' will. Il valore predefinito è false.
hidden	Valore che indica se il campo può essere restituito in un risultato della ricerca. È possibile disabilitare questa opzione se si vuole usare un campo (ad esempio, margine) come filtro, ordinamento o meccanismo di assegnazione dei punteggi, ma non si vuole che il campo sia visibile all'utente finale. Questa proprietà deve essere false per i campi chiave. Questa proprietà può essere modificata nei campi esistenti. L'abilitazione di questa proprietà non comporta alcun aumento dei requisiti di archiviazione degli indici. Il valore predefinito è true per i campi vettoriali, false in caso contrario.
indexAnalyzerName	Nome dell'analizzatore utilizzato in fase di indicizzazione per il campo. Questa opzione può essere usata solo con i campi ricercabili. Deve essere impostato insieme a searchAnalyzer e non può essere impostato insieme all'opzione analizzatore. Questa proprietà non può essere impostata sul nome di un analizzatore del linguaggio; usare invece la proprietà analyzer se è necessario un analizzatore del linguaggio. Dopo aver scelto l'analizzatore, non può essere modificato per il campo.
key	Valore che indica se il campo identifica in modo univoco i documenti nell'indice. È necessario scegliere esattamente un campo di primo livello in ogni indice come campo chiave e deve essere di tipo Edm.String. I campi chiave possono essere usati per cercare i documenti direttamente e aggiornare o eliminare documenti specifici. Il valore predefinito è false.
name	Nome del campo, che deve essere univoco all'interno dell'insieme fields del campo indice o padre.
searchable	Valore che indica se il campo è ricercabile full-text. Ciò significa che verrà sottoposta a analisi come l'interruzione delle parole durante l'indicizzazione. Se si imposta un campo ricercabile su un valore come "sunny day", internamente verrà suddiviso nei singoli token "sunny" e "day". In questo modo vengono attivate ricerche full-text per questi termini. I campi di tipo Edm.String o Collection(Edm.String) sono ricercabili per impostazione predefinita. Questa proprietà deve essere false per campi semplici di altri tipi di dati non stringa. Nota: i campi ricercabili utilizzano spazio aggiuntivo nell'indice per supportare versioni aggiuntive con token del valore del campo per le ricerche full-text. Se si desidera risparmiare spazio nell'indice e non è necessario includere un campo nelle ricerche, impostare searchable su false. Il valore predefinito è false.
searchAnalyzerName	Nome dell'analizzatore utilizzato in fase di ricerca per il campo. Questa opzione può essere usata solo con i campi ricercabili. Deve essere impostato insieme a indexAnalyzerName e non può essere impostato insieme all'opzione analyzerName. Questa proprietà non può essere impostata sul nome di un analizzatore del linguaggio; usare invece la proprietà analyzerName se è necessario un analizzatore del linguaggio. Questo analizzatore può essere aggiornato in un campo esistente.
sortable	Valore che indica se abilitare il campo a cui fare riferimento nelle espressioni $orderby. Per impostazione predefinita, il motore di ricerca ordina i risultati in base al punteggio, ma in molte esperienze gli utenti vogliono ordinare in base ai campi nei documenti. Un campo semplice può essere ordinato solo se è a valore singolo (ha un singolo valore nell'ambito del documento padre). I campi di raccolta semplici non possono essere ordinabili, perché sono multivalore. Anche i campi secondari semplici di raccolte complesse sono multivalore e pertanto non possono essere ordinabili. Questo vale sia se si tratta di un campo padre immediato o di un campo predecessore, che è la raccolta complessa. Il valore predefinito è false.
stored	Valore non modificabile che indica se il campo verrà salvato separatamente su disco da restituire in un risultato di ricerca. È possibile disabilitare questa opzione se non si prevede di restituire il contenuto del campo in una risposta di ricerca per risparmiare sui costi di archiviazione. Questa impostazione può essere impostata solo durante la creazione dell'indice e solo per i campi vettoriali. Questa proprietà non può essere modificata per i campi esistenti o impostata su false per i nuovi campi. Se questa proprietà è impostata su false, la proprietà 'hidden' deve essere impostata su 'true'. Questa proprietà deve essere false o non impostata per i campi chiave, per i nuovi campi e per i campi non vettoriali. La disabilitazione di questa proprietà ridurrà i requisiti di archiviazione degli indici.
synonymMapNames	Elenco dei nomi delle mappe sinonimie da associare a questo campo. Questa opzione può essere usata solo con i campi ricercabili. Attualmente è supportata una sola mappa sinonimia per campo. L'assegnazione di una mappa sinonimia a un campo garantisce che i termini di query destinati a tale campo vengano espansi in fase di query usando le regole nella mappa dei sinonimi. Questo attributo può essere modificato nei campi esistenti.
type	Tipo di dati del campo.
vectorEncodingFormat	Formato di codifica per interpretare il contenuto del campo.
vectorSearchDimensions	Dimensionalità del campo vettore.
vectorSearchProfileName	Nome del profilo di ricerca vettoriale che specifica l'algoritmo e il vettore da usare durante la ricerca nel campo vettoriale.

Dettagli proprietà

analyzerName

Nome dell'analizzatore da utilizzare per il campo. Questa opzione può essere usata solo con i campi ricercabili e non può essere impostata insieme a searchAnalyzer o indexAnalyzer. Dopo aver scelto l'analizzatore, non può essere modificato per il campo.

analyzerName?: string

Valore della proprietà

string

facetable

Valore che indica se consentire il riferimento al campo nelle query facet. In genere usato in una presentazione dei risultati della ricerca che include il conteggio dei riscontri per categoria (ad esempio, cercare fotocamere digitali e vedere i riscontri per marchio, per impostazione predefinita, per prezzo e così via). I campi di tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) non possono essere facciabili. Il valore predefinito è false.

facetable?: boolean

Valore della proprietà

boolean

filterable

Valore che indica se abilitare il riferimento al campo nelle query $filter. filtrabile differisce dalla modalità di gestione delle stringhe. I campi di tipo Edm.String o Collection(Edm.String) che sono filtrabili non subiscono interruzioni di parole, quindi i confronti sono solo per corrispondenze esatte. Ad esempio, se si imposta tale campo f su "sunny day", $filter=f eq 'sunny' non troverà corrispondenze, ma $filter=f eq 'sunny day' will. Il valore predefinito è false.

filterable?: boolean

Valore della proprietà

boolean

hidden

Valore che indica se il campo può essere restituito in un risultato della ricerca. È possibile disabilitare questa opzione se si vuole usare un campo (ad esempio, margine) come filtro, ordinamento o meccanismo di assegnazione dei punteggi, ma non si vuole che il campo sia visibile all'utente finale. Questa proprietà deve essere false per i campi chiave. Questa proprietà può essere modificata nei campi esistenti. L'abilitazione di questa proprietà non comporta alcun aumento dei requisiti di archiviazione degli indici. Il valore predefinito è true per i campi vettoriali, false in caso contrario.

hidden?: boolean

Valore della proprietà

boolean

indexAnalyzerName

Nome dell'analizzatore utilizzato in fase di indicizzazione per il campo. Questa opzione può essere usata solo con i campi ricercabili. Deve essere impostato insieme a searchAnalyzer e non può essere impostato insieme all'opzione analizzatore. Questa proprietà non può essere impostata sul nome di un analizzatore del linguaggio; usare invece la proprietà analyzer se è necessario un analizzatore del linguaggio. Dopo aver scelto l'analizzatore, non può essere modificato per il campo.

indexAnalyzerName?: string

Valore della proprietà

string

key

Valore che indica se il campo identifica in modo univoco i documenti nell'indice. È necessario scegliere esattamente un campo di primo livello in ogni indice come campo chiave e deve essere di tipo Edm.String. I campi chiave possono essere usati per cercare i documenti direttamente e aggiornare o eliminare documenti specifici. Il valore predefinito è false.

key?: boolean

Valore della proprietà

boolean

name

Nome del campo, che deve essere univoco all'interno dell'insieme fields del campo indice o padre.

name: string

Valore della proprietà

string

searchable

Valore che indica se il campo è ricercabile full-text. Ciò significa che verrà sottoposta a analisi come l'interruzione delle parole durante l'indicizzazione. Se si imposta un campo ricercabile su un valore come "sunny day", internamente verrà suddiviso nei singoli token "sunny" e "day". In questo modo vengono attivate ricerche full-text per questi termini. I campi di tipo Edm.String o Collection(Edm.String) sono ricercabili per impostazione predefinita. Questa proprietà deve essere false per campi semplici di altri tipi di dati non stringa. Nota: i campi ricercabili utilizzano spazio aggiuntivo nell'indice per supportare versioni aggiuntive con token del valore del campo per le ricerche full-text. Se si desidera risparmiare spazio nell'indice e non è necessario includere un campo nelle ricerche, impostare searchable su false. Il valore predefinito è false.

searchable?: boolean

Valore della proprietà

boolean

searchAnalyzerName

Nome dell'analizzatore utilizzato in fase di ricerca per il campo. Questa opzione può essere usata solo con i campi ricercabili. Deve essere impostato insieme a indexAnalyzerName e non può essere impostato insieme all'opzione analyzerName. Questa proprietà non può essere impostata sul nome di un analizzatore del linguaggio; usare invece la proprietà analyzerName se è necessario un analizzatore del linguaggio. Questo analizzatore può essere aggiornato in un campo esistente.

searchAnalyzerName?: string

Valore della proprietà

string

sortable

Valore che indica se abilitare il campo a cui fare riferimento nelle espressioni $orderby. Per impostazione predefinita, il motore di ricerca ordina i risultati in base al punteggio, ma in molte esperienze gli utenti vogliono ordinare in base ai campi nei documenti. Un campo semplice può essere ordinato solo se è a valore singolo (ha un singolo valore nell'ambito del documento padre). I campi di raccolta semplici non possono essere ordinabili, perché sono multivalore. Anche i campi secondari semplici di raccolte complesse sono multivalore e pertanto non possono essere ordinabili. Questo vale sia se si tratta di un campo padre immediato o di un campo predecessore, che è la raccolta complessa. Il valore predefinito è false.

sortable?: boolean

Valore della proprietà

boolean

stored

Valore non modificabile che indica se il campo verrà salvato separatamente su disco da restituire in un risultato di ricerca. È possibile disabilitare questa opzione se non si prevede di restituire il contenuto del campo in una risposta di ricerca per risparmiare sui costi di archiviazione. Questa impostazione può essere impostata solo durante la creazione dell'indice e solo per i campi vettoriali. Questa proprietà non può essere modificata per i campi esistenti o impostata su false per i nuovi campi. Se questa proprietà è impostata su false, la proprietà 'hidden' deve essere impostata su 'true'. Questa proprietà deve essere false o non impostata per i campi chiave, per i nuovi campi e per i campi non vettoriali. La disabilitazione di questa proprietà ridurrà i requisiti di archiviazione degli indici.

stored?: boolean

Valore della proprietà

boolean

synonymMapNames

Elenco dei nomi delle mappe sinonimie da associare a questo campo. Questa opzione può essere usata solo con i campi ricercabili. Attualmente è supportata una sola mappa sinonimia per campo. L'assegnazione di una mappa sinonimia a un campo garantisce che i termini di query destinati a tale campo vengano espansi in fase di query usando le regole nella mappa dei sinonimi. Questo attributo può essere modificato nei campi esistenti.

synonymMapNames?: string[]

Valore della proprietà

string[]

type

Tipo di dati del campo.

type: SearchFieldDataType

Valore della proprietà

SearchFieldDataType

vectorEncodingFormat

Formato di codifica per interpretare il contenuto del campo.

vectorEncodingFormat?: string

Valore della proprietà

string

vectorSearchDimensions

Dimensionalità del campo vettore.

vectorSearchDimensions?: number

Valore della proprietà

number

vectorSearchProfileName

Nome del profilo di ricerca vettoriale che specifica l'algoritmo e il vettore da usare durante la ricerca nel campo vettoriale.

vectorSearchProfileName?: string

Valore della proprietà

string