ScoringFunction Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.6

Source:: ScoringFunction.cs

Source:: ScoringFunction.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base type for functions that can modify document scores during ranking. Please note ScoringFunction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include DistanceScoringFunction, FreshnessScoringFunction, MagnitudeScoringFunction and TagScoringFunction.

public class ScoringFunction

public class ScoringFunction : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.ScoringFunction>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.ScoringFunction>

type ScoringFunction = class

type ScoringFunction = class
    interface IJsonModel<ScoringFunction>
    interface IPersistableModel<ScoringFunction>

Public Class ScoringFunction

Public Class ScoringFunction
Implements IJsonModel(Of ScoringFunction), IPersistableModel(Of ScoringFunction)

Inheritance: Object
ScoringFunction

Derived: Azure.Search.Documents.Indexes.Models.DistanceScoringFunction

Azure.Search.Documents.Indexes.Models.FreshnessScoringFunction

Azure.Search.Documents.Indexes.Models.MagnitudeScoringFunction

Azure.Search.Documents.Indexes.Models.TagScoringFunction

Implements: IJsonModel<ScoringFunction> IPersistableModel<ScoringFunction> IPersistableModel<T>

Properties

Boost	A multiplier for the raw score. Must be a positive number not equal to 1.0.
FieldName	The name of the field used as input to the scoring function.
Interpolation	A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ScoringFunction>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ScoringFunction>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ScoringFunction>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ScoringFunction>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ScoringFunction>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to