ScoringProfile interface

  • Reference
Package:
@azure/search-documents

Defines parameters for a search index that influence scoring in search queries.

Properties

functionAggregation

A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching'
functions

The collection of functions that influence the scoring of documents.
name

The name of the scoring profile.
textWeights

Parameters that boost scoring based on text matches in certain index fields.

Property Details

functionAggregation

A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching'

functionAggregation?: ScoringFunctionAggregation

Property Value

ScoringFunctionAggregation

functions

The collection of functions that influence the scoring of documents.

functions?: ScoringFunction[]

Property Value

ScoringFunction[]

name

The name of the scoring profile.

name: string

Property Value

string

textWeights

Parameters that boost scoring based on text matches in certain index fields.

textWeights?: TextWeights

Property Value

TextWeights