Package dev.cachly.api.model

Class SearchRequest

java.lang.Object
dev.cachly.api.model.SearchRequest
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-04-17T00:43:25.074268745Z[Etc/UTC]", comments="Generator version: 7.5.0") public class SearchRequest extends Object
SearchRequest

  • Field Details

  • Constructor Details

    • SearchRequest

      public SearchRequest()

  • Method Details

    • embedding

      public SearchRequest embedding(List<BigDecimal> embedding)

    • addEmbeddingItem

      public SearchRequest addEmbeddingItem(BigDecimal embeddingItem)

    • getEmbedding

      @Nullable public List<BigDecimal> getEmbedding()
      Float64 text embedding vector (e.g. 1536 dims for OpenAI text-embedding-3-small)
      Returns:
      embedding

    • setEmbedding

      public void setEmbedding(List<BigDecimal> embedding)

    • embeddingQ8

      public SearchRequest embeddingQ8(QuantizedEmbedding embeddingQ8)

    • getEmbeddingQ8

      @Nullable public QuantizedEmbedding getEmbeddingQ8()
      int8-quantized text embedding (§7) – reduces payload by ~8x
      Returns:
      embeddingQ8

    • setEmbeddingQ8

      public void setEmbeddingQ8(QuantizedEmbedding embeddingQ8)

    • imageEmbedding

      public SearchRequest imageEmbedding(List<BigDecimal> imageEmbedding)

    • addImageEmbeddingItem

      public SearchRequest addImageEmbeddingItem(BigDecimal imageEmbeddingItem)

    • getImageEmbedding

      @Nullable public List<BigDecimal> getImageEmbedding()
      Float64 image embedding vector for multimodal search
      Returns:
      imageEmbedding

    • setImageEmbedding

      public void setImageEmbedding(List<BigDecimal> imageEmbedding)

    • imageEmbeddingQ8

      public SearchRequest imageEmbeddingQ8(QuantizedEmbedding imageEmbeddingQ8)

    • getImageEmbeddingQ8

      @Nullable public QuantizedEmbedding getImageEmbeddingQ8()
      int8-quantized image embedding for multimodal search
      Returns:
      imageEmbeddingQ8

    • setImageEmbeddingQ8

      public void setImageEmbeddingQ8(QuantizedEmbedding imageEmbeddingQ8)

    • embeddingType

      public SearchRequest embeddingType(SearchRequest.EmbeddingTypeEnum embeddingType)

    • getEmbeddingType

      @Nullable public SearchRequest.EmbeddingTypeEnum getEmbeddingType()
      Modality of the search: text-only, image-only, or multimodal (combined)
      Returns:
      embeddingType

    • setEmbeddingType

      public void setEmbeddingType(SearchRequest.EmbeddingTypeEnum embeddingType)

    • namespace

      public SearchRequest namespace(String namespace)

    • getNamespace

      @Nullable public String getNamespace()
      Use 'auto' for automatic namespace detection (§4)
      Returns:
      namespace

    • setNamespace

      public void setNamespace(String namespace)

    • threshold

      public SearchRequest threshold(Double threshold)

    • getThreshold

      @Nullable public Double getThreshold()
      Get threshold minimum: 0.0 maximum: 1.0
      Returns:
      threshold

    • setThreshold

      public void setThreshold(Double threshold)

    • useAdaptiveThreshold

      public SearchRequest useAdaptiveThreshold(Boolean useAdaptiveThreshold)

    • getUseAdaptiveThreshold

      @Nullable public Boolean getUseAdaptiveThreshold()
      Override threshold with F1-calibrated value (§1)
      Returns:
      useAdaptiveThreshold

    • setUseAdaptiveThreshold

      public void setUseAdaptiveThreshold(Boolean useAdaptiveThreshold)

    • prompt

      public SearchRequest prompt(String prompt)

    • getPrompt

      @Nullable public String getPrompt()
      Required when hybrid=true (§3 BM25+Vector)
      Returns:
      prompt

    • setPrompt

      public void setPrompt(String prompt)

    • hybrid

      public SearchRequest hybrid(Boolean hybrid)

    • getHybrid

      @Nullable public Boolean getHybrid()
      Enable hybrid BM25+Vector RRF search (§3)
      Returns:
      hybrid

    • setHybrid

      public void setHybrid(Boolean hybrid)

    • equals

      public boolean equals(Object o)
      Return true if this SearchRequest object is equal to o.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string

    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string