167 строки
13 KiB
YAML
167 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.HnswParameters"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters"
|
|
name: "HnswParameters"
|
|
nameWithType: "HnswParameters"
|
|
summary: "Contains the parameters specific to the HNSW 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 **HnswParameters**</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.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.HnswParameters()"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.HnswParameters()"
|
|
name: "HnswParameters()"
|
|
nameWithType: "HnswParameters.HnswParameters()"
|
|
summary: "Creates an instance of Hnsw<wbr>Parameters class."
|
|
syntax: "public HnswParameters()"
|
|
desc: "Creates an instance of HnswParameters class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "HnswParameters.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Hnsw<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 HnswParameters fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the HnswParameters."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of HnswParameters from the JsonReader."
|
|
returns:
|
|
description: "An instance of HnswParameters 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.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.getEfConstruction()"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.getEfConstruction()"
|
|
name: "getEfConstruction()"
|
|
nameWithType: "HnswParameters.getEfConstruction()"
|
|
summary: "Get the ef<wbr>Construction property: The size of the dynamic list containing the nearest neighbors, which is used during index time."
|
|
syntax: "public Integer getEfConstruction()"
|
|
desc: "Get the efConstruction property: The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns."
|
|
returns:
|
|
description: "the efConstruction value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.getEfSearch()"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.getEfSearch()"
|
|
name: "getEfSearch()"
|
|
nameWithType: "HnswParameters.getEfSearch()"
|
|
summary: "Get the ef<wbr>Search property: The size of the dynamic list containing the nearest neighbors, which is used during search time."
|
|
syntax: "public Integer getEfSearch()"
|
|
desc: "Get the efSearch property: The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns."
|
|
returns:
|
|
description: "the efSearch value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.getM()"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.getM()"
|
|
name: "getM()"
|
|
nameWithType: "HnswParameters.getM()"
|
|
summary: "Get the m property: The number of bi-directional links created for every new element during construction."
|
|
syntax: "public Integer getM()"
|
|
desc: "Get the m property: The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time."
|
|
returns:
|
|
description: "the m value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.getMetric()"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.getMetric()"
|
|
name: "getMetric()"
|
|
nameWithType: "HnswParameters.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.HnswParameters.setEfConstruction(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.setEfConstruction(Integer efConstruction)"
|
|
name: "setEfConstruction(Integer efConstruction)"
|
|
nameWithType: "HnswParameters.setEfConstruction(Integer efConstruction)"
|
|
summary: "Set the ef<wbr>Construction property: The size of the dynamic list containing the nearest neighbors, which is used during index time."
|
|
parameters:
|
|
- description: "the efConstruction value to set."
|
|
name: "efConstruction"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public HnswParameters setEfConstruction(Integer efConstruction)"
|
|
desc: "Set the efConstruction property: The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns."
|
|
returns:
|
|
description: "the HnswParameters object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.setEfSearch(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.setEfSearch(Integer efSearch)"
|
|
name: "setEfSearch(Integer efSearch)"
|
|
nameWithType: "HnswParameters.setEfSearch(Integer efSearch)"
|
|
summary: "Set the ef<wbr>Search property: The size of the dynamic list containing the nearest neighbors, which is used during search time."
|
|
parameters:
|
|
- description: "the efSearch value to set."
|
|
name: "efSearch"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public HnswParameters setEfSearch(Integer efSearch)"
|
|
desc: "Set the efSearch property: The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns."
|
|
returns:
|
|
description: "the HnswParameters object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.setM(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.setM(Integer m)"
|
|
name: "setM(Integer m)"
|
|
nameWithType: "HnswParameters.setM(Integer m)"
|
|
summary: "Set the m property: The number of bi-directional links created for every new element during construction."
|
|
parameters:
|
|
- description: "the m value to set."
|
|
name: "m"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public HnswParameters setM(Integer m)"
|
|
desc: "Set the m property: The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time."
|
|
returns:
|
|
description: "the HnswParameters object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.setMetric(com.azure.search.documents.indexes.models.VectorSearchAlgorithmMetric)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.setMetric(VectorSearchAlgorithmMetric metric)"
|
|
name: "setMetric(VectorSearchAlgorithmMetric metric)"
|
|
nameWithType: "HnswParameters.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 HnswParameters setMetric(VectorSearchAlgorithmMetric metric)"
|
|
desc: "Set the metric property: The similarity metric to use for vector comparisons."
|
|
returns:
|
|
description: "the HnswParameters object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.HnswParameters.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.HnswParameters.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "HnswParameters.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 the HNSW 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.HnswParameters?alt=com.azure.search.documents.indexes.models.HnswParameters&text=HnswParameters\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|