mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-25 13:12:39 +00:00
docs: document scoring autoprojection query methods
This commit is contained in:
@@ -83,6 +83,39 @@ AnalyzeExec verbose=true, metrics=[]
|
||||
|
||||
***
|
||||
|
||||
### disableScoringAutoprojection()
|
||||
|
||||
```ts
|
||||
disableScoringAutoprojection(): this
|
||||
```
|
||||
|
||||
Disable autoprojection of scoring columns.
|
||||
|
||||
When you specify an explicit projection with [select](AutoQuery.md#select) that does not
|
||||
include scoring columns (e.g. `_score` for FTS or `_distance` for vector
|
||||
search), Lance currently auto-includes those columns and emits a
|
||||
deprecation warning. Calling this method disables that behavior so the
|
||||
scoring columns are only returned if explicitly selected.
|
||||
|
||||
#### Returns
|
||||
|
||||
`this`
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const results = await table.vectorSearch([0.1, 0.2])
|
||||
.select(["id"])
|
||||
.disableScoringAutoprojection()
|
||||
.toArray();
|
||||
```
|
||||
|
||||
#### Inherited from
|
||||
|
||||
`StandardQueryBase.disableScoringAutoprojection`
|
||||
|
||||
***
|
||||
|
||||
### execute()
|
||||
|
||||
```ts
|
||||
|
||||
@@ -83,6 +83,39 @@ AnalyzeExec verbose=true, metrics=[]
|
||||
|
||||
***
|
||||
|
||||
### disableScoringAutoprojection()
|
||||
|
||||
```ts
|
||||
disableScoringAutoprojection(): this
|
||||
```
|
||||
|
||||
Disable autoprojection of scoring columns.
|
||||
|
||||
When you specify an explicit projection with [select](Query.md#select) that does not
|
||||
include scoring columns (e.g. `_score` for FTS or `_distance` for vector
|
||||
search), Lance currently auto-includes those columns and emits a
|
||||
deprecation warning. Calling this method disables that behavior so the
|
||||
scoring columns are only returned if explicitly selected.
|
||||
|
||||
#### Returns
|
||||
|
||||
`this`
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const results = await table.vectorSearch([0.1, 0.2])
|
||||
.select(["id"])
|
||||
.disableScoringAutoprojection()
|
||||
.toArray();
|
||||
```
|
||||
|
||||
#### Inherited from
|
||||
|
||||
`StandardQueryBase.disableScoringAutoprojection`
|
||||
|
||||
***
|
||||
|
||||
### execute()
|
||||
|
||||
```ts
|
||||
|
||||
@@ -149,6 +149,39 @@ whose data type is a fixed-size-list of floats.
|
||||
|
||||
***
|
||||
|
||||
### disableScoringAutoprojection()
|
||||
|
||||
```ts
|
||||
disableScoringAutoprojection(): this
|
||||
```
|
||||
|
||||
Disable autoprojection of scoring columns.
|
||||
|
||||
When you specify an explicit projection with [select](VectorQuery.md#select) that does not
|
||||
include scoring columns (e.g. `_score` for FTS or `_distance` for vector
|
||||
search), Lance currently auto-includes those columns and emits a
|
||||
deprecation warning. Calling this method disables that behavior so the
|
||||
scoring columns are only returned if explicitly selected.
|
||||
|
||||
#### Returns
|
||||
|
||||
`this`
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
const results = await table.vectorSearch([0.1, 0.2])
|
||||
.select(["id"])
|
||||
.disableScoringAutoprojection()
|
||||
.toArray();
|
||||
```
|
||||
|
||||
#### Inherited from
|
||||
|
||||
`StandardQueryBase.disableScoringAutoprojection`
|
||||
|
||||
***
|
||||
|
||||
### distanceRange()
|
||||
|
||||
```ts
|
||||
|
||||
Reference in New Issue
Block a user