docs: improve the docs and API param name (#1629)

Signed-off-by: BubbleCal <bubble-cal@outlook.com>
This commit is contained in:
BubbleCal
2024-09-11 10:18:29 +08:00
committed by GitHub
parent 622a2922e2
commit 4b79db72bf
5 changed files with 6 additions and 6 deletions

View File

@@ -872,7 +872,7 @@ describe.each([arrow13, arrow14, arrow15, arrow16, arrow17])(
];
const table = await db.createTable("test", data);
await table.createIndex("text", {
config: Index.fts({ withPositions: false }),
config: Index.fts({ withPosition: false }),
});
const results = await table.search("hello").toArray();

View File

@@ -142,7 +142,7 @@ export interface FtsOptions {
* If set to false, the index will not store the positions of the tokens in the text,
* which will make the index smaller and faster to build, but will not support phrase queries.
*/
withPositions?: boolean;
withPosition?: boolean;
}
export class Index {
@@ -244,7 +244,7 @@ export class Index {
* For now, the full text search index only supports English, and doesn't support phrase search.
*/
static fts(options?: Partial<FtsOptions>) {
return new Index(LanceDbIndex.fts(options?.withPositions));
return new Index(LanceDbIndex.fts(options?.withPosition));
}
/**