108 строки
7.4 KiB
YAML
108 строки
7.4 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.models.ScoringFunction"
|
|
fullName: "com.azure.search.models.ScoringFunction"
|
|
name: "ScoringFunction"
|
|
nameWithType: "ScoringFunction"
|
|
summary: "Abstract base class 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**"
|
|
constructors:
|
|
- uid: "com.azure.search.models.ScoringFunction.ScoringFunction()"
|
|
fullName: "com.azure.search.models.ScoringFunction.ScoringFunction()"
|
|
name: "ScoringFunction()"
|
|
nameWithType: "ScoringFunction.ScoringFunction()"
|
|
syntax: "public ScoringFunction()"
|
|
methods:
|
|
- uid: "com.azure.search.models.ScoringFunction.getBoost()"
|
|
fullName: "com.azure.search.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.models.ScoringFunction.getFieldName()"
|
|
fullName: "com.azure.search.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.models.ScoringFunction.getInterpolation()"
|
|
fullName: "com.azure.search.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\". Possible values include: 'linear', 'constant', 'quadratic', 'logarithmic'."
|
|
returns:
|
|
description: "the interpolation value."
|
|
type: "<xref href=\"com.azure.search.models.ScoringFunctionInterpolation?alt=com.azure.search.models.ScoringFunctionInterpolation&text=ScoringFunctionInterpolation\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.ScoringFunction.setBoost(double)"
|
|
fullName: "com.azure.search.models.ScoringFunction.setBoost(double boost)"
|
|
name: "setBoost(double boost)"
|
|
nameWithType: "ScoringFunction.setBoost(double boost)"
|
|
summary: "Set the boost property: A multiplier for the raw score."
|
|
parameters:
|
|
- 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 setBoost(double boost)"
|
|
desc: "Set the boost property: A multiplier for the raw score. Must be a positive number not equal to 1.0."
|
|
returns:
|
|
description: "the ScoringFunction object itself."
|
|
type: "<xref href=\"com.azure.search.models.ScoringFunction?alt=com.azure.search.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.ScoringFunction.setFieldName(java.lang.String)"
|
|
fullName: "com.azure.search.models.ScoringFunction.setFieldName(String fieldName)"
|
|
name: "setFieldName(String fieldName)"
|
|
nameWithType: "ScoringFunction.setFieldName(String fieldName)"
|
|
summary: "Set the field<wbr>Name property: The name of the field used as input to the scoring function."
|
|
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>"
|
|
syntax: "public ScoringFunction setFieldName(String fieldName)"
|
|
desc: "Set the fieldName property: The name of the field used as input to the scoring function."
|
|
returns:
|
|
description: "the ScoringFunction object itself."
|
|
type: "<xref href=\"com.azure.search.models.ScoringFunction?alt=com.azure.search.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.models.ScoringFunction.setInterpolation(com.azure.search.models.ScoringFunctionInterpolation)"
|
|
fullName: "com.azure.search.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.models.ScoringFunctionInterpolation?alt=com.azure.search.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\". Possible values include: 'linear', 'constant', 'quadratic', 'logarithmic'."
|
|
returns:
|
|
description: "the ScoringFunction object itself."
|
|
type: "<xref href=\"com.azure.search.models.ScoringFunction?alt=com.azure.search.models.ScoringFunction&text=ScoringFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Abstract base class for functions that can modify document scores during ranking."
|
|
metadata: {}
|
|
package: "com.azure.search.models"
|
|
artifact: com.azure:azure-search:11.0.0-beta.1
|