116 строки
10 KiB
YAML
116 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration"
|
|
name: "ExhaustiveKnnAlgorithmConfiguration"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration"
|
|
summary: "Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration&text=VectorSearchAlgorithmConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.getKind()?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.getKind&text=getKind\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.getName()?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **ExhaustiveKnnAlgorithmConfiguration**</br> extends <xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration&text=VectorSearchAlgorithmConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.ExhaustiveKnnAlgorithmConfiguration(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.ExhaustiveKnnAlgorithmConfiguration(String name)"
|
|
name: "ExhaustiveKnnAlgorithmConfiguration(String name)"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.ExhaustiveKnnAlgorithmConfiguration(String name)"
|
|
summary: "Creates an instance of Exhaustive<wbr>Knn<wbr>Algorithm<wbr>Configuration 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 ExhaustiveKnnAlgorithmConfiguration(String name)"
|
|
desc: "Creates an instance of ExhaustiveKnnAlgorithmConfiguration class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Exhaustive<wbr>Knn<wbr>Algorithm<wbr>Configuration 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 ExhaustiveKnnAlgorithmConfiguration 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 ExhaustiveKnnAlgorithmConfiguration from the JsonReader."
|
|
returns:
|
|
description: "An instance of ExhaustiveKnnAlgorithmConfiguration if the JsonReader was pointing to an instance of it,\n or null if it was pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration&text=ExhaustiveKnnAlgorithmConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.getKind()"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.getKind()"
|
|
name: "getKind()"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.getKind()"
|
|
summary: "Get the kind property: The name of the kind of algorithm being configured for use with vector search."
|
|
overridden: "com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.getKind()"
|
|
syntax: "public VectorSearchAlgorithmKind getKind()"
|
|
desc: "Get the kind property: The name of the kind of algorithm being configured for use with vector search."
|
|
returns:
|
|
description: "the kind value."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.VectorSearchAlgorithmKind?alt=com.azure.search.documents.indexes.models.VectorSearchAlgorithmKind&text=VectorSearchAlgorithmKind\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.getParameters()"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.getParameters()"
|
|
name: "getParameters()"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.getParameters()"
|
|
summary: "Get the parameters property: Contains the parameters specific to exhaustive KNN algorithm."
|
|
syntax: "public ExhaustiveKnnParameters getParameters()"
|
|
desc: "Get the parameters property: Contains the parameters specific to exhaustive KNN algorithm."
|
|
returns:
|
|
description: "the parameters value."
|
|
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.ExhaustiveKnnAlgorithmConfiguration.setParameters(com.azure.search.documents.indexes.models.ExhaustiveKnnParameters)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.setParameters(ExhaustiveKnnParameters parameters)"
|
|
name: "setParameters(ExhaustiveKnnParameters parameters)"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.setParameters(ExhaustiveKnnParameters parameters)"
|
|
summary: "Set the parameters property: Contains the parameters specific to exhaustive KNN algorithm."
|
|
parameters:
|
|
- description: "the parameters value to set."
|
|
name: "parameters"
|
|
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\" />"
|
|
syntax: "public ExhaustiveKnnAlgorithmConfiguration setParameters(ExhaustiveKnnParameters parameters)"
|
|
desc: "Set the parameters property: Contains the parameters specific to exhaustive KNN algorithm."
|
|
returns:
|
|
description: "the ExhaustiveKnnAlgorithmConfiguration object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration?alt=com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration&text=ExhaustiveKnnAlgorithmConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.ExhaustiveKnnAlgorithmConfiguration.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ExhaustiveKnnAlgorithmConfiguration.toJson(JsonWriter jsonWriter)"
|
|
overridden: "com.azure.search.documents.indexes.models.VectorSearchAlgorithmConfiguration.toJson(com.azure.json.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 configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index."
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|