ScoringFunction Class
Definition
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.
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
interface IJsonModel<ScoringFunction>
interface IPersistableModel<ScoringFunction>
Public Class ScoringFunction
Implements IJsonModel(Of ScoringFunction), IPersistableModel(Of ScoringFunction)
- Inheritance
-
ScoringFunction
- Derived
- Implements
Constructors
| Name | Description |
|---|---|
| ScoringFunction(String, Double, String) |
Initializes a new instance of ScoringFunction. |
Properties
| Name | Description |
|---|---|
| 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
Explicit Interface Implementations
| Name | Description |
|---|---|
| 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. |