Files
lancedb/docs/src/js/classes/MatchQuery.md
BubbleCal 2248aa9508 fix: bugs for new FTS APIs (#2314)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Enhanced full-text search capabilities with support for phrase
queries, fuzzy matching, boosting, and multi-column matching.
- Search methods now accept full-text query objects directly, improving
query flexibility and precision.
- Python and JavaScript SDKs updated to handle full-text queries
seamlessly, including async search support.

- **Tests**
- Added comprehensive tests covering fuzzy search, phrase search, and
boosted queries to ensure robust full-text search functionality.

- **Documentation**
- Updated query class documentation to reflect new constructor options
and removal of deprecated methods for clarity and simplicity.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: BubbleCal <bubble-cal@outlook.com>
2025-04-15 11:51:35 +08:00

1.4 KiB

@lancedb/lancedbDocs


@lancedb/lancedb / MatchQuery

Class: MatchQuery

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 MatchQuery()

new MatchQuery(
   query,
   column,
   options?): MatchQuery

Creates an instance of MatchQuery.

Parameters

  • query: string The text query to search for.

  • column: string The name of the column to search within.

  • options? Optional parameters for the match query.

    • boost: The boost factor for the query (default is 1.0).
    • fuzziness: The fuzziness level for the query (default is 0).
    • maxExpansions: The maximum number of terms to consider for fuzzy matching (default is 50).
  • options.boost?: number

  • options.fuzziness?: number

  • options.maxExpansions?: number

Returns

MatchQuery

Methods

queryType()

queryType(): FullTextQueryType

The type of the full-text query.

Returns

FullTextQueryType

Implementation of

FullTextQuery.queryType