diff --git a/docs/modules/ROOT/pages/api-ref.adoc b/docs/modules/ROOT/pages/api-ref.adoc index f9c51b67..4a051611 100644 --- a/docs/modules/ROOT/pages/api-ref.adoc +++ b/docs/modules/ROOT/pages/api-ref.adoc @@ -171,6 +171,12 @@ TIP: This document was generated from comments in the Go code in the api/ direct * <> * <> * <> +* <> +* <> +* <> +* <> +* <> +* <> * <> * <> * <> @@ -2004,6 +2010,78 @@ m| classFilter | Blacklist and whitelist for classes when User Code Namespaces i <> +=== VectorCollection + +VectorCollection is the Schema for the vectorcollections API + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#objectmeta-v1-meta[metav1.ObjectMeta] | false | - +m| spec |   m| <> | false | - +m| status |   m| <> | false | - +|=== + +<
> + +=== VectorCollectionList + +VectorCollectionList contains a list of VectorCollection + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| metadata |   m| https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#listmeta-v1-meta[metav1.ListMeta] | false | - +m| items |   m| []<> | true | - +|=== + +<
> + +=== VectorCollectionSpec + +VectorCollectionSpec defines the desired state of VectorCollection + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| name | Name of the data structure config to be created. If empty, CR name will be used. It cannot be updated after the config is created successfully. m| string | false | - +m| hazelcastResourceName | HazelcastResourceName defines the name of the Hazelcast resource that this resource is created for. m| string | true | - +m| indexes | Information about indexes configuration m| []<> | true | - +|=== + +<
> + +=== VectorCollectionStatus + +VectorCollectionStatus defines the observed state of VectorCollection + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| state | State of the data structure m| <> | false | - +m| message | Message explaining the current state m| string | false | - +m| memberStatuses | Holds status of data structure for each Hazelcast member m| map[string]<> | false | - +|=== + +<
> + +=== VectorIndex + + + +[cols="4,8,4,2,4"options="header"] +|=== +| Field | Description | Type | Required | Default +m| name | Name is name of the vector index. Can include letters, numbers, and the symbols - and _. Required for single-index vector collections. Optional for multi-index collection. m| string | false | - +m| dimension | Dimension of the vector. m| int32 | true | - +m| metric | Metric is used to calculate the distance between two vectors. m| <> | true | - +m| maxDegree | MaxDegree is used to calculate the maximum number of neighbors per node. The calculation used is max-degree * 2. m| int32 | true | - +m| efConstruction | EfConstruction is the size of the search queue to use when finding nearest neighbors. m| int32 | true | - +m| useDeduplication | UseDeduplication specify whether to use vector deduplication. m| bool | true | - +|=== + +<
> + === WANConfig @@ -2718,6 +2796,20 @@ m| "Success" |   <
> +=== VectorMetric + + + +[cols="5,10"options="header"] +|=== +| Value | Description +m| "Euclidean" | Euclidean distance. Score definition: 1 / (1 + squareDistance(v1, v2)) +m| "Cosine" | Cosine of the angle between the vectors. Score definition: (1 + cos(v1, v2)) / 2 +m| "Dot" | Dot product of the vectors. Score definition: (1 + dotProduct(v1, v2)) / 2 +|=== + +<
> + === WANServiceType WANServiceType describes the service type where the wan ports are exposed