### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.ScoringProfile"
fullName: "com.azure.search.documents.indexes.models.ScoringProfile"
name: "ScoringProfile"
nameWithType: "ScoringProfile"
summary: "Defines parameters for a search index that influence scoring in search queries."
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 final class **ScoringProfile**</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.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.ScoringProfile(java.lang.String)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.ScoringProfile(String name)"
  name: "ScoringProfile(String name)"
  nameWithType: "ScoringProfile.ScoringProfile(String name)"
  summary: "Creates an instance of Scoring<wbr>Profile class."
  parameters:
  - description: "the name value to set."
    name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public ScoringProfile(String name)"
  desc: "Creates an instance of ScoringProfile class."
methods:
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ScoringProfile.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Scoring<wbr>Profile 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 ScoringProfile 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 ScoringProfile from the JsonReader."
  returns:
    description: "An instance of ScoringProfile 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.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.getFunctionAggregation()"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.getFunctionAggregation()"
  name: "getFunctionAggregation()"
  nameWithType: "ScoringProfile.getFunctionAggregation()"
  summary: "Get the function<wbr>Aggregation property: A value indicating how the results of individual scoring functions should be combined."
  syntax: "public ScoringFunctionAggregation getFunctionAggregation()"
  desc: "Get the functionAggregation property: A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions."
  returns:
    description: "the functionAggregation value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunctionAggregation?alt=com.azure.search.documents.indexes.models.ScoringFunctionAggregation&text=ScoringFunctionAggregation\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.getFunctions()"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.getFunctions()"
  name: "getFunctions()"
  nameWithType: "ScoringProfile.getFunctions()"
  summary: "Get the functions property: The collection of functions that influence the scoring of documents."
  syntax: "public List<ScoringFunction> getFunctions()"
  desc: "Get the functions property: The collection of functions that influence the scoring of documents."
  returns:
    description: "the functions value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&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;"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.getName()"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.getName()"
  name: "getName()"
  nameWithType: "ScoringProfile.getName()"
  summary: "Get the name property: The name of the scoring profile."
  syntax: "public String getName()"
  desc: "Get the name property: The name of the scoring profile."
  returns:
    description: "the name 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.ScoringProfile.getTextWeights()"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.getTextWeights()"
  name: "getTextWeights()"
  nameWithType: "ScoringProfile.getTextWeights()"
  summary: "Get the text<wbr>Weights property: Parameters that boost scoring based on text matches in certain index fields."
  syntax: "public TextWeights getTextWeights()"
  desc: "Get the textWeights property: Parameters that boost scoring based on text matches in certain index fields."
  returns:
    description: "the textWeights value."
    type: "<xref href=\"com.azure.search.documents.indexes.models.TextWeights?alt=com.azure.search.documents.indexes.models.TextWeights&text=TextWeights\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctionAggregation(com.azure.search.documents.indexes.models.ScoringFunctionAggregation)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctionAggregation(ScoringFunctionAggregation functionAggregation)"
  name: "setFunctionAggregation(ScoringFunctionAggregation functionAggregation)"
  nameWithType: "ScoringProfile.setFunctionAggregation(ScoringFunctionAggregation functionAggregation)"
  summary: "Set the function<wbr>Aggregation property: A value indicating how the results of individual scoring functions should be combined."
  parameters:
  - description: "the functionAggregation value to set."
    name: "functionAggregation"
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringFunctionAggregation?alt=com.azure.search.documents.indexes.models.ScoringFunctionAggregation&text=ScoringFunctionAggregation\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ScoringProfile setFunctionAggregation(ScoringFunctionAggregation functionAggregation)"
  desc: "Set the functionAggregation property: A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions."
  returns:
    description: "the ScoringProfile object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctions(com.azure.search.documents.indexes.models.ScoringFunction...)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctions(ScoringFunction[] functions)"
  name: "setFunctions(ScoringFunction[] functions)"
  nameWithType: "ScoringProfile.setFunctions(ScoringFunction[] functions)"
  summary: "Set the functions property: The collection of functions that influence the scoring of documents."
  parameters:
  - description: "the functions value to set."
    name: "functions"
    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\" />[]"
  syntax: "public ScoringProfile setFunctions(ScoringFunction[] functions)"
  desc: "Set the functions property: The collection of functions that influence the scoring of documents."
  returns:
    description: "the ScoringProfile object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctions(java.util.List<com.azure.search.documents.indexes.models.ScoringFunction>)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.setFunctions(List<ScoringFunction> functions)"
  name: "setFunctions(List<ScoringFunction> functions)"
  nameWithType: "ScoringProfile.setFunctions(List<ScoringFunction> functions)"
  summary: "Set the functions property: The collection of functions that influence the scoring of documents."
  parameters:
  - description: "the functions value to set."
    name: "functions"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&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;"
  syntax: "public ScoringProfile setFunctions(List<ScoringFunction> functions)"
  desc: "Set the functions property: The collection of functions that influence the scoring of documents."
  returns:
    description: "the ScoringProfile object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.setTextWeights(com.azure.search.documents.indexes.models.TextWeights)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.setTextWeights(TextWeights textWeights)"
  name: "setTextWeights(TextWeights textWeights)"
  nameWithType: "ScoringProfile.setTextWeights(TextWeights textWeights)"
  summary: "Set the text<wbr>Weights property: Parameters that boost scoring based on text matches in certain index fields."
  parameters:
  - description: "the textWeights value to set."
    name: "textWeights"
    type: "<xref href=\"com.azure.search.documents.indexes.models.TextWeights?alt=com.azure.search.documents.indexes.models.TextWeights&text=TextWeights\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ScoringProfile setTextWeights(TextWeights textWeights)"
  desc: "Set the textWeights property: Parameters that boost scoring based on text matches in certain index fields."
  returns:
    description: "the ScoringProfile object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.ScoringProfile.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.ScoringProfile.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ScoringProfile.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: "Defines parameters for a search index that influence scoring in search queries."
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.ScoringProfile?alt=com.azure.search.documents.indexes.models.ScoringProfile&text=ScoringProfile\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3