Files
lancedb/docs/src/js/classes/MatchQuery.md
Weston Pace 625bab3f21 feat: update to lance 0.25.3b1 (#2294)
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Chores**
- Updated dependency versions for improved performance and
compatibility.

- **New Features**
- Added support for structured full-text search with expanded query
types (e.g., match, phrase, boost, multi-match) and flexible input
formats.
- Introduced a new method to check server support for structural
full-text search features.
- Enhanced the query system with new classes and interfaces for handling
various full-text queries.
- Expanded the functionality of existing methods to accept more complex
query structures, including updates to method signatures.

- **Bug Fixes**
  - Improved error handling and reporting for full-text search queries.

- **Refactor**
- Enhanced query processing with streamlined input handling and improved
error reporting, ensuring more robust and consistent search results
across platforms.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: BubbleCal <bubble-cal@outlook.com>
Co-authored-by: BubbleCal <bubble-cal@outlook.com>
2025-04-01 06:36:42 -07:00

1.6 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,
   boost,
   fuzziness,
   maxExpansions): 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.

  • boost: number = 1.0 (Optional) The boost factor to influence the relevance score of this query. Default is 1.0.

  • fuzziness: number = 0 (Optional) The allowed edit distance for fuzzy matching. Default is 0.

  • maxExpansions: number = 50 (Optional) The maximum number of terms to consider for fuzzy matching. Default is 50.

Returns

MatchQuery

Methods

queryType()

queryType(): FullTextQueryType

Returns

FullTextQueryType

Implementation of

FullTextQuery.queryType


toDict()

toDict(): Record<string, unknown>

Returns

Record<string, unknown>

Implementation of

FullTextQuery.toDict