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 del linguaggio da usare per il campo. Questa opzione può essere usata solo con campi ricercabili e non può essere impostata con searchAnalyzer o indexAnalyzer. Una volta scelto, l'analizzatore non può essere cambiato per il campo. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.
facetable	Valore che indica se abilitare il campo a cui fare riferimento nelle query facet. In genere usato in una presentazione dei risultati della ricerca che includono il numero di hit per categoria (ad esempio, cercare fotocamere digitali e vedere le hit per marchio, da megalie, per prezzo e così via). I campi di tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) non possono essere visibili. Il valore predefinito è false per tutti gli altri campi semplici.
filterable	Valore che indica se abilitare il campo a cui fare riferimento nelle query $filter. Il filtro è diverso dal modo in cui vengono gestite le 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 un campo f su "giorno sole", $filter=f eq 'sunny' non troverà corrispondenze, ma $filter=f eq 'sunny day' will. L'impostazione predefinita è false.
hidden	Valore che indica se il campo può essere restituito in un risultato di ricerca. È possibile abilitare 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. La disabilitazione di questa proprietà non causa alcun aumento dei requisiti di archiviazione dell'indice. L'impostazione predefinita è false.
indexAnalyzerName	Nome dell'analizzatore usato in fase di indicizzazione per il campo. Questa opzione può essere usata solo con campi ricercabili. Deve essere impostato insieme a searchAnalyzer e non può essere impostato insieme all'opzione analizzatore. Una volta scelto, l'analizzatore non può essere cambiato per il campo. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.
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 ed aggiornare o eliminare documenti specifici. L'impostazione predefinita è false.
name	Nome del campo, che deve essere univoco all'interno dell'insieme campi del campo indice o padre.
searchable	Valore che indica se il campo è ricercabile in full-text. Ciò significa che verrà sottoposto ad analisi, ad esempio la suddivisione in parole durante l'indicizzazione. Se si imposta un campo ricercabile su un valore come "sunny day", questo viene suddiviso internamente nei singoli token "sunny" e "day". È così possibile eseguire ricerche full-text di questi termini. Questa proprietà deve essere false per i campi semplici di altri tipi di dati non stringa. Nota: i campi ricercabili usano spazio aggiuntivo nell'indice poiché Ricerca cognitiva di Azure archivierà una versione tokenizzata aggiuntiva del valore del campo per le ricerche full-text. Impostazione predefinita su false per i campi semplici.
searchAnalyzerName	Nome dell'analizzatore usato in fase di ricerca per il campo. Questa opzione può essere usata solo con campi ricercabili. Deve essere impostato insieme a indexAnalyzer e non può essere impostato insieme all'opzione analizzatore. Questo analizzatore può essere aggiornato per un campo esistente. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.
sortable	Valore che indica se abilitare il campo a cui fare riferimento nelle espressioni di $orderby. Per impostazione predefinita, Ricerca cognitiva di Azure ordina i risultati per punteggio, ma in molte esperienze gli utenti vogliono ordinare in base ai campi nei documenti. Un campo semplice può essere ordinabile solo se è a valore singolo (ha un singolo valore nell'ambito del documento padre). I campi di raccolta semplici non possono essere ordinabili, poiché sono multivalore. I campi secondari semplici delle raccolte complesse sono anche multivalore e pertanto non possono essere ordinabili. Questo è vero se si tratta di un campo padre immediato o di un campo predecessore, ovvero la raccolta complessa. Il valore predefinito per ordinabile è false.
synonymMapNames	Elenco dei nomi delle mappe sinonimi da associare a questo campo. Questa opzione può essere usata solo con campi ricercabili. Attualmente è supportata solo una mappa sinonimo per campo. L'assegnazione di un mapping sinonimo a un campo garantisce che i termini di query destinati al campo vengano espansi in fase di query usando le regole nella mappa sinonimia. Questo attributo può essere modificato nei campi esistenti.
type	Tipo di dati del campo. I valori possibili includono: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'
vectorSearchDimensions	Dimensione del campo vettore.
vectorSearchProfileName	Nome della configurazione dell'algoritmo di ricerca vettore che specifica l'algoritmo e i parametri facoltativi per la ricerca del campo vettore.

Dettagli proprietà

analyzerName

Nome dell'analizzatore del linguaggio da usare per il campo. Questa opzione può essere usata solo con campi ricercabili e non può essere impostata con searchAnalyzer o indexAnalyzer. Una volta scelto, l'analizzatore non può essere cambiato per il campo. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.

analyzerName?: string

Valore della proprietà

string

facetable

Valore che indica se abilitare il campo a cui fare riferimento nelle query facet. In genere usato in una presentazione dei risultati della ricerca che includono il numero di hit per categoria (ad esempio, cercare fotocamere digitali e vedere le hit per marchio, da megalie, per prezzo e così via). I campi di tipo Edm.GeographyPoint o Collection(Edm.GeographyPoint) non possono essere visibili. Il valore predefinito è false per tutti gli altri campi semplici.

facetable?: boolean

Valore della proprietà

boolean

filterable

Valore che indica se abilitare il campo a cui fare riferimento nelle query $filter. Il filtro è diverso dal modo in cui vengono gestite le 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 un campo f su "giorno sole", $filter=f eq 'sunny' non troverà corrispondenze, ma $filter=f eq 'sunny day' will. L'impostazione predefinita è false.

filterable?: boolean

Valore della proprietà

boolean

hidden

Valore che indica se il campo può essere restituito in un risultato di ricerca. È possibile abilitare 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. La disabilitazione di questa proprietà non causa alcun aumento dei requisiti di archiviazione dell'indice. L'impostazione predefinita è false.

hidden?: boolean

Valore della proprietà

boolean

indexAnalyzerName

Nome dell'analizzatore usato in fase di indicizzazione per il campo. Questa opzione può essere usata solo con campi ricercabili. Deve essere impostato insieme a searchAnalyzer e non può essere impostato insieme all'opzione analizzatore. Una volta scelto, l'analizzatore non può essere cambiato per il campo. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.

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 ed aggiornare o eliminare documenti specifici. L'impostazione predefinita è false.

key?: boolean

Valore della proprietà

boolean

name

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

name: string

Valore della proprietà

string

searchable

Valore che indica se il campo è ricercabile in full-text. Ciò significa che verrà sottoposto ad analisi, ad esempio la suddivisione in parole durante l'indicizzazione. Se si imposta un campo ricercabile su un valore come "sunny day", questo viene suddiviso internamente nei singoli token "sunny" e "day". È così possibile eseguire ricerche full-text di questi termini. Questa proprietà deve essere false per i campi semplici di altri tipi di dati non stringa. Nota: i campi ricercabili usano spazio aggiuntivo nell'indice poiché Ricerca cognitiva di Azure archivierà una versione tokenizzata aggiuntiva del valore del campo per le ricerche full-text. Impostazione predefinita su false per i campi semplici.

searchable?: boolean

Valore della proprietà

boolean

searchAnalyzerName

Nome dell'analizzatore usato in fase di ricerca per il campo. Questa opzione può essere usata solo con campi ricercabili. Deve essere impostato insieme a indexAnalyzer e non può essere impostato insieme all'opzione analizzatore. Questo analizzatore può essere aggiornato per un campo esistente. NotoAnalyzerNames è un enumerazione contenente nomi di analizzatori predefiniti.

searchAnalyzerName?: string

Valore della proprietà

string

sortable

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

sortable?: boolean

Valore della proprietà

boolean

synonymMapNames

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

synonymMapNames?: string[]

Valore della proprietà

string[]

type

Tipo di dati del campo. I valori possibili includono: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'

type: SearchFieldDataType

Valore della proprietà

SearchFieldDataType

vectorSearchDimensions

Dimensione del campo vettore.

vectorSearchDimensions?: number

Valore della proprietà

number

vectorSearchProfileName

Nome della configurazione dell'algoritmo di ricerca vettore che specifica l'algoritmo e i parametri facoltativi per la ricerca del campo vettore.

vectorSearchProfileName?: string

Valore della proprietà

string