com.azure.search.documents.indexes.models.ScoringFunction.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.ScoringFunction"
fullName: "com.azure.search.documents.indexes.models.ScoringFunction"
name: "ScoringFunction"
nameWithType: "ScoringFunction"
summary: "Base type for functions that can modify document scores during ranking."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **ScoringFunction**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.ScoringFunction?alt=com.azure.search.documents.indexes.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.ScoringFunction(java.lang.String,double)"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.ScoringFunction(String fieldName, double boost)"
  name: "ScoringFunction(String fieldName, double boost)"
  nameWithType: "ScoringFunction.ScoringFunction(String fieldName, double boost)"
  summary: "Creates an instance of Scoring<wbr>Function class."
  parameters:
  - description: "the fieldName value to set."
    name: "fieldName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the boost value to set."
    name: "boost"
    type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ScoringFunction(String fieldName, double boost)"
  desc: "Creates an instance of ScoringFunction class."
methods:
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ScoringFunction.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Scoring<wbr>Function from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ScoringFunction fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of ScoringFunction from the JsonReader."
  returns:
    description: "An instance of ScoringFunction if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunction?alt=com.azure.search.documents.indexes.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.getBoost()"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.getBoost()"
  name: "getBoost()"
  nameWithType: "ScoringFunction.getBoost()"
  summary: "Get the boost property: A multiplier for the raw score."
  syntax: "public double getBoost()"
  desc: "Get the boost property: A multiplier for the raw score. Must be a positive number not equal to 1.0."
  returns:
    description: "the boost value."
    type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.getFieldName()"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.getFieldName()"
  name: "getFieldName()"
  nameWithType: "ScoringFunction.getFieldName()"
  summary: "Get the field<wbr>Name property: The name of the field used as input to the scoring function."
  syntax: "public String getFieldName()"
  desc: "Get the fieldName property: The name of the field used as input to the scoring function."
  returns:
    description: "the fieldName value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.getInterpolation()"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.getInterpolation()"
  name: "getInterpolation()"
  nameWithType: "ScoringFunction.getInterpolation()"
  summary: "Get the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"."
  syntax: "public ScoringFunctionInterpolation getInterpolation()"
  desc: "Get the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"."
  returns:
    description: "the interpolation value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunctionInterpolation?alt=com.azure.search.documents.indexes.models.ScoringFunctionInterpolation&text=ScoringFunctionInterpolation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.getType()"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.getType()"
  name: "getType()"
  nameWithType: "ScoringFunction.getType()"
  summary: "Get the type property: Indicates the type of function to use."
  syntax: "public String getType()"
  desc: "Get the type property: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case."
  returns:
    description: "the type value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.setInterpolation(com.azure.search.documents.indexes.models.ScoringFunctionInterpolation)"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.setInterpolation(ScoringFunctionInterpolation interpolation)"
  name: "setInterpolation(ScoringFunctionInterpolation interpolation)"
  nameWithType: "ScoringFunction.setInterpolation(ScoringFunctionInterpolation interpolation)"
  summary: "Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"."
  parameters:
  - description: "the interpolation value to set."
    name: "interpolation"
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunctionInterpolation?alt=com.azure.search.documents.indexes.models.ScoringFunctionInterpolation&text=ScoringFunctionInterpolation\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ScoringFunction setInterpolation(ScoringFunctionInterpolation interpolation)"
  desc: "Set the interpolation property: A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"."
  returns:
    description: "the ScoringFunction object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunction?alt=com.azure.search.documents.indexes.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringFunction.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.ScoringFunction.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ScoringFunction.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Base type for functions that can modify document scores during ranking."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.ScoringFunction?alt=com.azure.search.documents.indexes.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.1