Skip to content

@lancedb/lancedb • Docs

@lancedb/lancedb / BoostQuery

Class: BoostQuery

Represents a full-text query interface. This interface defines the structure and behavior for full-text queries, including methods to retrieve the query type and convert the query to a dictionary format.

Implements

Constructors

new BoostQuery()

new BoostQuery(
   positive,
   negative,
   options?): BoostQuery

Creates an instance of BoostQuery. The boost returns documents that match the positive query, but penalizes those that match the negative query. the penalty is controlled by the negativeBoost parameter.

Parameters

  • positive: FullTextQuery The positive query that boosts the relevance score.

  • negative: FullTextQuery The negative query that reduces the relevance score.

  • options? Optional parameters for the boost query.

    • negativeBoost: The boost factor for the negative query (default is 0.0).

  • options.negativeBoost?: number

Returns

BoostQuery

Methods

queryType()

queryType(): FullTextQueryType

The type of the full-text query.

Returns

FullTextQueryType

Implementation of

FullTextQuery.queryType