Package glide.api.models.commands.FT

Class FTCreateOptions

java.lang.Object

glide.api.models.commands.FT.FTCreateOptions

public class FTCreateOptions
extends java.lang.Object

Additional parameters for FT.create(BaseClient, String, FieldInfo[], FTCreateOptions) command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FTCreateOptions.DataType	Type of the index dataset.
static class	FTCreateOptions.DistanceMetric	Distance metrics to measure the degree of similarity between two vectors. The above metrics calculate distance between two vectors, where the smaller the value is, the closer the two vectors are in the vector space.
static interface	FTCreateOptions.Field	A vector search field.
static class	FTCreateOptions.FieldInfo	Field definition to be added into index schema.
static class	FTCreateOptions.FTCreateOptionsBuilder
static class	FTCreateOptions.NumericField	Field contains a number.
static class	FTCreateOptions.TagField	Tag fields are similar to full-text fields, but they interpret the text as a simple list of tags delimited by a separator character. For FTCreateOptions.DataType.HASH fields, separator default is a comma (,).
static class	FTCreateOptions.TextField	Field contains any blob of data.
static class	FTCreateOptions.VectorFieldFlat	Vector field that supports vector search by FLAT (brute force) algorithm. The algorithm is a brute force linear processing of each vector in the index, yielding exact answers within the bounds of the precision of the distance computations.
static class	FTCreateOptions.VectorFieldFlatBuilder
static class	FTCreateOptions.VectorFieldHnsw	Vector field that supports vector search by HNSM (Hierarchical Navigable Small World) algorithm. The algorithm provides an approximation of the correct answer in exchange for substantially lower execution times.
static class	FTCreateOptions.VectorFieldHnswBuilder

Constructor Summary

Constructors

Constructor	Description
FTCreateOptions(FTCreateOptions.DataType dataType, GlideString[] prefixes)	Backward-compatible convenience constructor for callers that only need dataType and prefixes.

Method Summary

Modifier and Type	Method	Description
static FTCreateOptions.FTCreateOptionsBuilder	builder()
GlideString[]	toArgs()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FTCreateOptions

public FTCreateOptions(FTCreateOptions.DataType dataType,
                       GlideString[] prefixes)

Backward-compatible convenience constructor for callers that only need dataType and prefixes. All other options use their defaults.

Parameters:

dataType - The index data type. If null a FTCreateOptions.DataType.HASH index is created.

prefixes - A list of prefixes of index definitions.

Method Detail

builder

public static FTCreateOptions.FTCreateOptionsBuilder builder()

toArgs

public GlideString[] toArgs()