Package com.datastax.astra.client.collections.definition

Class CollectionDefinition

java.lang.Object
com.datastax.astra.client.collections.definition.CollectionDefinition
public class CollectionDefinition extends Object
Set of options to define and initialize a collection.

  • Constructor Details

    • CollectionDefinition

      public CollectionDefinition()
      Default constructor.

  • Method Details

    • getDefaultId

      public CollectionDefinition.DefaultIdOptions getDefaultId()
      Gets defaultId
      Returns:
      value of defaultId

    • defaultId

      public CollectionDefinition defaultId(CollectionDefaultIdTypes type)
      Builder pattern.
      Parameters:
      type - default id type
      Returns:
      self reference

    • getIndexing

      public CollectionDefinition.IndexingOptions getIndexing()
      Access the indexing options.
      Returns:
      indexing options

    • indexingDeny

      public CollectionDefinition indexingDeny(@NonNull @NonNull String... properties)
      Builder pattern.
      Parameters:
      properties - size
      Returns:
      self reference

    • indexingAllow

      public CollectionDefinition indexingAllow(String... properties)
      Builder pattern.
      Parameters:
      properties - size
      Returns:
      self reference

    • getVector

      public VectorOptions getVector()
      Access the vector options.
      Returns:
      vector options

    • vector

      public CollectionDefinition vector(VectorOptions vectorOptions)
      Builder pattern.
      Parameters:
      vectorOptions - size
      Returns:
      self reference

    • vectorDimension

      public CollectionDefinition vectorDimension(int size)
      Builder pattern.
      Parameters:
      size - size
      Returns:
      self reference

    • vectorSimilarity

      public CollectionDefinition vectorSimilarity(@NonNull @NonNull SimilarityMetric metric)
      Builder pattern.
      Parameters:
      metric - similarity metric
      Returns:
      self reference

    • vector

      public CollectionDefinition vector(int dimension, @NonNull @NonNull SimilarityMetric function)
      Builder pattern.
      Parameters:
      dimension - dimension
      function - function
      Returns:
      self reference

    • vectorize

      public CollectionDefinition vectorize(String provider, String modeName)
      Enable Vectorization within the collection.
      Parameters:
      provider - provider Name (LLM)
      modeName - mode name
      Returns:
      self reference

    • vectorize

      public CollectionDefinition vectorize(String provider, String modeName, String sharedSecretKey)
      Enable Vectorization within the collection.
      Parameters:
      provider - provider Name (LLM)
      modeName - mode name
      sharedSecretKey - name of the key in the system
      Returns:
      self reference

    • vectorize

      public CollectionDefinition vectorize(String provider, String modeName, String sharedSecretKey, Map<String,Object> parameters)
      Enable Vectorization within the collection.
      Parameters:
      provider - provider Name (LLM)
      modeName - mode name
      sharedSecretKey - name of the key in the system
      parameters - expected parameters for vectorize
      Returns:
      self reference

    • getLexical

      public LexicalOptions getLexical()
      Gets lexical
      Returns:
      value of lexical

    • disableLexical

      public CollectionDefinition disableLexical()
      Builder pattern, disabled lexical
      Returns:
      self reference

    • lexical

      public CollectionDefinition lexical(LexicalOptions lexicalOptions)
      Builder pattern.
      Parameters:
      lexicalOptions - lexical options positioned on Collection creation
      Returns:
      self reference

    • lexical

      public CollectionDefinition lexical(Analyzer analyzer)
      Builder pattern.
      Parameters:
      analyzer - analyzer structure
      Returns:
      self reference

    • lexical

      public CollectionDefinition lexical(AnalyzerTypes analyzerType)
      Builder pattern.
      Parameters:
      analyzerType - type of analyzer
      Returns:
      self reference

    • getRerank

      public CollectionRerankOptions getRerank()
      Gets reranking
      Returns:
      value of reranking

    • rerank

      public CollectionDefinition rerank(CollectionRerankOptions collectionRerankOptions)
      Builder pattern.
      Parameters:
      collectionRerankOptions - reranking service information
      Returns:
      self reference

    • rerank

      public CollectionDefinition rerank(String provider, String model)
      Builder pattern.
      Parameters:
      provider - reranker provider
      model - model
      Returns:
      self reference

    • disableRerank

      public CollectionDefinition disableRerank()
      Builder pattern, disable reranking
      Returns:
      self reference