azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents....

98 строки
7.2 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.models.VectorFilterMode"
fullName: "com.azure.search.documents.models.VectorFilterMode"
name: "VectorFilterMode"
nameWithType: "VectorFilterMode"
summary: "Determines whether or not filters are applied before or after the vector search is performed."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>fromString(java.lang.String,java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>fromString&text=<T>fromString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.<T>values(java.lang.Class<T>)?alt=com.azure.core.util.ExpandableStringEnum.<T>values&text=<T>values\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.equals(java.lang.Object)?alt=com.azure.core.util.ExpandableStringEnum.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.hashCode()?alt=com.azure.core.util.ExpandableStringEnum.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.core.util.ExpandableStringEnum.toString()?alt=com.azure.core.util.ExpandableStringEnum.toString&text=toString\" 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#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#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#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 **VectorFilterMode**</br> extends <xref href=\"com.azure.core.util.ExpandableStringEnum?alt=com.azure.core.util.ExpandableStringEnum&text=ExpandableStringEnum\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.models.VectorFilterMode?alt=com.azure.search.documents.models.VectorFilterMode&text=VectorFilterMode\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.models.VectorFilterMode.VectorFilterMode()"
fullName: "com.azure.search.documents.models.VectorFilterMode.VectorFilterMode()"
name: "VectorFilterMode()"
nameWithType: "VectorFilterMode.VectorFilterMode()"
summary: "Creates a new instance of Vector<wbr>Filter<wbr>Mode value."
deprecatedTag: "Use the <xref uid=\"com.azure.search.documents.models.VectorFilterMode.fromString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#fromString(String)\"></xref> factory method."
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public VectorFilterMode()"
desc: "Creates a new instance of VectorFilterMode value."
hasDeprecatedTag: true
fields:
- uid: "com.azure.search.documents.models.VectorFilterMode.POST_FILTER"
fullName: "com.azure.search.documents.models.VectorFilterMode.POST_FILTER"
name: "POST_FILTER"
nameWithType: "VectorFilterMode.POST_FILTER"
summary: "The filter will be applied after the candidate set of vector results is returned."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"com.azure.search.documents.models.VectorFilterMode?alt=com.azure.search.documents.models.VectorFilterMode&text=VectorFilterMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final VectorFilterMode POST_FILTER"
desc: "The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'."
- uid: "com.azure.search.documents.models.VectorFilterMode.PRE_FILTER"
fullName: "com.azure.search.documents.models.VectorFilterMode.PRE_FILTER"
name: "PRE_FILTER"
nameWithType: "VectorFilterMode.PRE_FILTER"
summary: "The filter will be applied before the search query."
modifiers:
- "static"
- "final"
field:
type: "<xref href=\"com.azure.search.documents.models.VectorFilterMode?alt=com.azure.search.documents.models.VectorFilterMode&text=VectorFilterMode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static final VectorFilterMode PRE_FILTER"
desc: "The filter will be applied before the search query."
methods:
- uid: "com.azure.search.documents.models.VectorFilterMode.fromString(java.lang.String)"
fullName: "com.azure.search.documents.models.VectorFilterMode.fromString(String name)"
name: "fromString(String name)"
nameWithType: "VectorFilterMode.fromString(String name)"
summary: "Creates or finds a Vector<wbr>Filter<wbr>Mode from its string representation."
modifiers:
- "static"
parameters:
- description: "a name to look for."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static VectorFilterMode fromString(String name)"
desc: "Creates or finds a VectorFilterMode from its string representation."
returns:
description: "the corresponding VectorFilterMode."
type: "<xref href=\"com.azure.search.documents.models.VectorFilterMode?alt=com.azure.search.documents.models.VectorFilterMode&text=VectorFilterMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.models.VectorFilterMode.values()"
fullName: "com.azure.search.documents.models.VectorFilterMode.values()"
name: "values()"
nameWithType: "VectorFilterMode.values()"
summary: "Gets known Vector<wbr>Filter<wbr>Mode values."
modifiers:
- "static"
syntax: "public static Collection<VectorFilterMode> values()"
desc: "Gets known VectorFilterMode values."
returns:
description: "known VectorFilterMode values."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html\">Collection</a>&lt;<xref href=\"com.azure.search.documents.models.VectorFilterMode?alt=com.azure.search.documents.models.VectorFilterMode&text=VectorFilterMode\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "Determines whether or not filters are applied before or after the vector search is performed."
metadata: {}
package: "com.azure.search.documents.models"
artifact: com.azure:azure-search-documents:11.7.1