rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-05-26 16:30:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update FTS docs for JS SDK (#1634)

Browse Source 
Signed-off-by: BubbleCal <bubble-cal@outlook.com>
This commit is contained in:
BubbleCal
2024-09-13 20:48:29 +08:00
committed by GitHub
parent c7732585bf
commit bf7d2d6fb0
4 changed files with 39 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/src/js/classes/Table.md
View File

@@ -501,16 +501,28 @@ Get the schema of the table.
#### search(query)
> `abstract` **search**(`query`): [`VectorQuery`](VectorQuery.md)
> `abstract` **search**(`query`, `queryType`, `ftsColumns`): [`VectorQuery`](VectorQuery.md)
Create a search query to find the nearest neighbors
of the given query vector
of the given query vector, or the documents
with the highest relevance to the query string.
##### Parameters
• **query**: `string`
the query. This will be converted to a vector using the table's provided embedding function
the query. This will be converted to a vector using the table's provided embedding function,
or the query string for full-text search if `queryType` is "fts".
• **queryType**: `string` = `"auto"` \| `"fts"`
the type of query to run. If "auto", the query type will be determined based on the query.
• **ftsColumns**: `string[] | str` = undefined
the columns to search in. If not provided, all indexed columns will be searched.
For now, this can support to search only one column.
##### Returns