mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-13 07:12:57 +00:00
2248aa9508
<!-- 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>
68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / 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
|
|
|
|
- [`FullTextQuery`](../interfaces/FullTextQuery.md)
|
|
|
|
## Constructors
|
|
|
|
### new BoostQuery()
|
|
|
|
```ts
|
|
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`](../interfaces/FullTextQuery.md)
|
|
The positive query that boosts the relevance score.
|
|
|
|
* **negative**: [`FullTextQuery`](../interfaces/FullTextQuery.md)
|
|
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`](BoostQuery.md)
|
|
|
|
## Methods
|
|
|
|
### queryType()
|
|
|
|
```ts
|
|
queryType(): FullTextQueryType
|
|
```
|
|
|
|
The type of the full-text query.
|
|
|
|
#### Returns
|
|
|
|
[`FullTextQueryType`](../enumerations/FullTextQueryType.md)
|
|
|
|
#### Implementation of
|
|
|
|
[`FullTextQuery`](../interfaces/FullTextQuery.md).[`queryType`](../interfaces/FullTextQuery.md#querytype)
|