BaseSearchRequestOptions interface

Pacchetto:

@azure/search-documents

Parametri per il filtro, l'ordinamento, il facet, il paging e altri comportamenti delle query di ricerca.

Proprietà

facets	Elenco di espressioni facet da applicare alla query di ricerca. Ogni espressione facet contiene un nome di campo, seguito facoltativamente da un elenco delimitato da virgole di coppie nome:valore.
filter	L'espressione OData $filter da applicare alla query di ricerca.
highlightFields	Elenco delimitato da virgole di nomi di campo da usare per l'evidenziazione dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati.
highlightPostTag	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>.
highlightPreTag	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>.
hybridSearch	Parametri di query per configurare i comportamenti della ricerca ibrida.
includeTotalCount	Valore che specifica se recuperare il conteggio totale dei risultati. Il valore predefinito è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione.
minimumCoverage	Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di ricerca affinché la query venga segnalata come riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. L'impostazione predefinita è 100.
orderBy	Elenco di espressioni OData $orderby in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
queryLanguage	Linguaggio della query.
queryType	Valore che specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene. I valori possibili includono: 'simple', 'full', 'semantic'
scoringParameters	Elenco dei valori dei parametri da usare nelle funzioni di assegnazione dei punteggi , ad esempio referencePointParameter, usando il formato name-values. Ad esempio, se il profilo di punteggio definisce una funzione con un parametro denominato "mylocation", la stringa di parametro sarà "mylocation--122.2,44.8" (senza virgolette).
scoringProfile	Nome di un profilo di punteggio per valutare i punteggi di corrispondenza per i documenti corrispondenti per ordinare i risultati.
scoringStatistics	Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. I valori possibili includono: 'Local', 'Global'
searchFields	Elenco delimitato da virgole di nomi di campo a cui definire l'ambito della ricerca full-text. Quando si usa la ricerca campiata (fieldName:searchExpression) in una query Lucene completa, i nomi dei campi di ogni espressione di ricerca con campi hanno la precedenza su tutti i nomi di campo elencati in questo parametro.
searchMode	Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza. I valori possibili includono: 'any', 'all'
select	Elenco di campi da recuperare. Se non specificato, vengono inclusi tutti i campi contrassegnati come recuperabili nello schema.
sessionId	Valore da usare per creare una sessione permanente, che consente di ottenere risultati più coerenti. Se si usa lo stesso sessionId, verrà effettuato un tentativo di eseguire un tentativo di destinazione dello stesso set di repliche. Tenere presente che il riutilizzo degli stessi valori sessionID può interferire ripetutamente con il bilanciamento del carico delle richieste tra le repliche e influire negativamente sulle prestazioni del servizio di ricerca. Il valore usato come sessionId non può iniziare con un carattere '_'.
skip	Numero di risultati della ricerca da ignorare. Questo valore non può essere maggiore di 100.000. Se è necessario analizzare i documenti in sequenza, ma non è possibile usare skip a causa di questa limitazione, è consigliabile usare orderby su una chiave completamente ordinata e filtrare con una query di intervallo.
speller	Migliorare il richiamo della ricerca correggendo i singoli termini di query di ricerca.
top	Numero di risultati della ricerca da recuperare. Questa operazione può essere usata in combinazione con $skip per implementare il paging lato client dei risultati della ricerca. Se i risultati vengono troncati a causa del paging lato server, la risposta includerà un token di continuazione che può essere usato per inviare un'altra richiesta di ricerca per la pagina successiva dei risultati.
vectorSearchOptions	Definisce le opzioni per le query di ricerca vettoriale
xMsEnableElevatedRead	Valore che abilita la lettura con privilegi elevati che ignora i controlli delle autorizzazioni a livello di documento per l'operazione di query.
xMsQuerySourceAuthorization	Token che identifica l'utente per il quale viene eseguita la query. Questo token viene utilizzato per applicare restrizioni di sicurezza ai documenti.

Dettagli proprietà

facets

Elenco di espressioni facet da applicare alla query di ricerca. Ogni espressione facet contiene un nome di campo, seguito facoltativamente da un elenco delimitato da virgole di coppie nome:valore.

facets?: string[]

Valore della proprietà

string[]

filter

L'espressione OData $filter da applicare alla query di ricerca.

filter?: string

Valore della proprietà

string

highlightFields

Elenco delimitato da virgole di nomi di campo da usare per l'evidenziazione dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati.

highlightFields?: string

Valore della proprietà

string

highlightPostTag

Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>.

highlightPostTag?: string

Valore della proprietà

string

highlightPreTag

Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>.

highlightPreTag?: string

Valore della proprietà

string

hybridSearch

Parametri di query per configurare i comportamenti della ricerca ibrida.

hybridSearch?: HybridSearch

Valore della proprietà

HybridSearchOptions

includeTotalCount

Valore che specifica se recuperare il conteggio totale dei risultati. Il valore predefinito è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione.

includeTotalCount?: boolean

Valore della proprietà

boolean

minimumCoverage

Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di ricerca affinché la query venga segnalata come riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. L'impostazione predefinita è 100.

minimumCoverage?: number

Valore della proprietà

number

orderBy

Elenco di espressioni OData $orderby in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.

orderBy?: string[]

Valore della proprietà

string[]

queryLanguage

Linguaggio della query.

queryLanguage?: string

Valore della proprietà

string

queryType

Valore che specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene. I valori possibili includono: 'simple', 'full', 'semantic'

queryType?: QueryType

Valore della proprietà

QueryType

scoringParameters

Elenco dei valori dei parametri da usare nelle funzioni di assegnazione dei punteggi , ad esempio referencePointParameter, usando il formato name-values. Ad esempio, se il profilo di punteggio definisce una funzione con un parametro denominato "mylocation", la stringa di parametro sarà "mylocation--122.2,44.8" (senza virgolette).

scoringParameters?: string[]

Valore della proprietà

string[]

scoringProfile

Nome di un profilo di punteggio per valutare i punteggi di corrispondenza per i documenti corrispondenti per ordinare i risultati.

scoringProfile?: string

Valore della proprietà

string

scoringStatistics

Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. I valori possibili includono: 'Local', 'Global'

scoringStatistics?: ScoringStatistics

Valore della proprietà

ScoringStatistics

searchFields

Elenco delimitato da virgole di nomi di campo a cui definire l'ambito della ricerca full-text. Quando si usa la ricerca campiata (fieldName:searchExpression) in una query Lucene completa, i nomi dei campi di ogni espressione di ricerca con campi hanno la precedenza su tutti i nomi di campo elencati in questo parametro.

searchFields?: SearchFieldArray<TModel>

Valore della proprietà

SearchFieldArray<TModel>

searchMode

Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza. I valori possibili includono: 'any', 'all'

searchMode?: SearchMode

Valore della proprietà

SearchMode

select

Elenco di campi da recuperare. Se non specificato, vengono inclusi tutti i campi contrassegnati come recuperabili nello schema.

select?: SelectArray<TFields>

Valore della proprietà

SelectArray<TFields>

sessionId

Valore da usare per creare una sessione permanente, che consente di ottenere risultati più coerenti. Se si usa lo stesso sessionId, verrà effettuato un tentativo di eseguire un tentativo di destinazione dello stesso set di repliche. Tenere presente che il riutilizzo degli stessi valori sessionID può interferire ripetutamente con il bilanciamento del carico delle richieste tra le repliche e influire negativamente sulle prestazioni del servizio di ricerca. Il valore usato come sessionId non può iniziare con un carattere '_'.

sessionId?: string

Valore della proprietà

string

skip

Numero di risultati della ricerca da ignorare. Questo valore non può essere maggiore di 100.000. Se è necessario analizzare i documenti in sequenza, ma non è possibile usare skip a causa di questa limitazione, è consigliabile usare orderby su una chiave completamente ordinata e filtrare con una query di intervallo.

skip?: number

Valore della proprietà

number

speller

Migliorare il richiamo della ricerca correggendo i singoli termini di query di ricerca.

speller?: string

Valore della proprietà

string

top

Numero di risultati della ricerca da recuperare. Questa operazione può essere usata in combinazione con $skip per implementare il paging lato client dei risultati della ricerca. Se i risultati vengono troncati a causa del paging lato server, la risposta includerà un token di continuazione che può essere usato per inviare un'altra richiesta di ricerca per la pagina successiva dei risultati.

top?: number

Valore della proprietà

number

vectorSearchOptions

Definisce le opzioni per le query di ricerca vettoriale

vectorSearchOptions?: VectorSearchOptions<TModel>

Valore della proprietà

VectorSearchOptions<TModel>

xMsEnableElevatedRead

Valore che abilita la lettura con privilegi elevati che ignora i controlli delle autorizzazioni a livello di documento per l'operazione di query.

xMsEnableElevatedRead?: boolean

Valore della proprietà

boolean

xMsQuerySourceAuthorization

Token che identifica l'utente per il quale viene eseguita la query. Questo token viene utilizzato per applicare restrizioni di sicurezza ai documenti.

xMsQuerySourceAuthorization?: string

Valore della proprietà

string