95 строки
7.5 KiB
YAML
95 строки
7.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters"
|
|
name: "ExhaustiveKnnParameters"
|
|
nameWithType: "ExhaustiveKnnParameters"
|
|
summary: "Contains the parameters specific to exhaustive KNN algorithm."
|
|
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 **ExhaustiveKnnParameters**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnParameters?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnParameters&text=ExhaustiveKnnParameters\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.ExhaustiveKnnParameters()"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.ExhaustiveKnnParameters()"
|
|
name: "ExhaustiveKnnParameters()"
|
|
nameWithType: "ExhaustiveKnnParameters.ExhaustiveKnnParameters()"
|
|
summary: "Creates an instance of Exhaustive<wbr>Knn<wbr>Parameters class."
|
|
syntax: "public ExhaustiveKnnParameters()"
|
|
desc: "Creates an instance of ExhaustiveKnnParameters class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ExhaustiveKnnParameters.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Exhaustive<wbr>Knn<wbr>Parameters 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 ExhaustiveKnnParameters fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the ExhaustiveKnnParameters."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ExhaustiveKnnParameters from the JsonReader."
|
|
returns:
|
|
description: "An instance of ExhaustiveKnnParameters if the JsonReader was pointing to an instance of it, or null if it\n was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnParameters?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnParameters&text=ExhaustiveKnnParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.getMetric()"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.getMetric()"
|
|
name: "getMetric()"
|
|
nameWithType: "ExhaustiveKnnParameters.getMetric()"
|
|
summary: "Get the metric property: The similarity metric to use for vector comparisons."
|
|
syntax: "public VectorSearchAlgorithmMetric getMetric()"
|
|
desc: "Get the metric property: The similarity metric to use for vector comparisons."
|
|
returns:
|
|
description: "the metric value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric&text=VectorSearchAlgorithmMetric\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.setMetric(com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.setMetric(VectorSearchAlgorithmMetric metric)"
|
|
name: "setMetric(VectorSearchAlgorithmMetric metric)"
|
|
nameWithType: "ExhaustiveKnnParameters.setMetric(VectorSearchAlgorithmMetric metric)"
|
|
summary: "Set the metric property: The similarity metric to use for vector comparisons."
|
|
parameters:
|
|
- description: "the metric value to set."
|
|
name: "metric"
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric&text=VectorSearchAlgorithmMetric\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ExhaustiveKnnParameters setMetric(VectorSearchAlgorithmMetric metric)"
|
|
desc: "Set the metric property: The similarity metric to use for vector comparisons."
|
|
returns:
|
|
description: "the ExhaustiveKnnParameters object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnParameters?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnParameters&text=ExhaustiveKnnParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnParameters.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ExhaustiveKnnParameters.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: "Contains the parameters specific to exhaustive KNN algorithm."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnParameters?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnParameters&text=ExhaustiveKnnParameters\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|