2024-05-21 07:59:07 +03:00
|
|
|
### YamlMime:JavaEnum
|
|
|
|
|
uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction"
|
|
|
|
|
name: "CosmosVectorDistanceFunction"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction"
|
|
|
|
|
summary: "Distance Function for the embeddings in the Cosmos DB database service."
|
|
|
|
|
inheritances:
|
|
|
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
|
|
|
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
|
|
|
inheritedClassMethods:
|
|
|
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
|
|
|
|
|
methodsRef:
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
|
2024-09-05 23:23:15 +03:00
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#describeConstable--\">describeConstable</a>"
|
2024-05-21 07:59:07 +03:00
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
|
|
|
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
|
|
|
|
|
- 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#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 enum **CosmosVectorDistanceFunction**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a><<xref href=\"com.azure.cosmos.models.CosmosVectorDistanceFunction?alt=com.azure.cosmos.models.CosmosVectorDistanceFunction&text=CosmosVectorDistanceFunction\" data-throw-if-not-resolved=\"False\" />>"
|
|
|
|
|
fields:
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.COSINE"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.COSINE"
|
|
|
|
|
name: "COSINE"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.COSINE"
|
|
|
|
|
summary: "Represents the cosine distance function."
|
|
|
|
|
desc: "Represents the cosine distance function."
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.DOT_PRODUCT"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.DOT_PRODUCT"
|
|
|
|
|
name: "DOT_PRODUCT"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.DOT_PRODUCT"
|
|
|
|
|
summary: "Represents the dot product distance function."
|
|
|
|
|
desc: "Represents the dot product distance function."
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.EUCLIDEAN"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.EUCLIDEAN"
|
|
|
|
|
name: "EUCLIDEAN"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.EUCLIDEAN"
|
|
|
|
|
summary: "Represents the euclidean distance function."
|
|
|
|
|
desc: "Represents the euclidean distance function."
|
|
|
|
|
methods:
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.fromString(java.lang.String)"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.fromString(String value)"
|
|
|
|
|
name: "fromString(String value)"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.fromString(String value)"
|
|
|
|
|
summary: "Method to retrieve the enum constant by its over<wbr>Wire<wbr>Value."
|
|
|
|
|
modifiers:
|
|
|
|
|
- "static"
|
|
|
|
|
parameters:
|
|
|
|
|
- description: "the overWire value of the enum constant"
|
|
|
|
|
name: "value"
|
|
|
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
|
|
|
syntax: "public static CosmosVectorDistanceFunction fromString(String value)"
|
|
|
|
|
desc: "Method to retrieve the enum constant by its overWireValue."
|
|
|
|
|
returns:
|
|
|
|
|
description: "the matching CosmosVectorDataType"
|
|
|
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosVectorDistanceFunction?alt=com.azure.cosmos.models.CosmosVectorDistanceFunction&text=CosmosVectorDistanceFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.toString()"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.toString()"
|
|
|
|
|
name: "toString()"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.toString()"
|
|
|
|
|
overridden: "java.lang.Enum.toString()"
|
|
|
|
|
syntax: "public String toString()"
|
|
|
|
|
returns:
|
|
|
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.valueOf(java.lang.String)"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.valueOf(String name)"
|
|
|
|
|
name: "valueOf(String name)"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.valueOf(String name)"
|
|
|
|
|
modifiers:
|
|
|
|
|
- "static"
|
|
|
|
|
parameters:
|
|
|
|
|
- name: "name"
|
|
|
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
|
|
|
syntax: "public static CosmosVectorDistanceFunction valueOf(String name)"
|
|
|
|
|
returns:
|
|
|
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosVectorDistanceFunction?alt=com.azure.cosmos.models.CosmosVectorDistanceFunction&text=CosmosVectorDistanceFunction\" data-throw-if-not-resolved=\"False\" />"
|
|
|
|
|
- uid: "com.azure.cosmos.models.CosmosVectorDistanceFunction.values()"
|
|
|
|
|
fullName: "com.azure.cosmos.models.CosmosVectorDistanceFunction.values()"
|
|
|
|
|
name: "values()"
|
|
|
|
|
nameWithType: "CosmosVectorDistanceFunction.values()"
|
|
|
|
|
modifiers:
|
|
|
|
|
- "static"
|
|
|
|
|
syntax: "public static CosmosVectorDistanceFunction[] values()"
|
|
|
|
|
returns:
|
|
|
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosVectorDistanceFunction?alt=com.azure.cosmos.models.CosmosVectorDistanceFunction&text=CosmosVectorDistanceFunction\" data-throw-if-not-resolved=\"False\" />[]"
|
|
|
|
|
desc: "Distance Function for the embeddings in the Cosmos DB database service."
|
|
|
|
|
metadata: {}
|
|
|
|
|
package: "com.azure.cosmos.models"
|
2024-10-17 06:24:16 +03:00
|
|
|
artifact: com.azure:azure-cosmos:4.63.4
|
