mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-10 05:42:58 +00:00
1453bf4e7a
The eslint rules specify some formatting requirements that are rather strict and conflict with vscode's default formatter. I was unable to get auto-formatting to setup correctly. Also, eslint has quite recently [given up on formatting](https://eslint.org/blog/2023/10/deprecating-formatting-rules/) and recommends using a 3rd party formatter. This PR adds prettier as the formatter. It restores the eslint rules to their defaults. This does mean we now have the "no explicit any" check back on. I know that rule is pedantic but it did help me catch a few corner cases in type testing that weren't covered in the current code. Leaving in draft as this is dependent on other PRs.
78 lines
2.3 KiB
TypeScript
78 lines
2.3 KiB
TypeScript
// Copyright 2023 Lance Developers.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
import { type Float } from "apache-arrow";
|
|
|
|
/**
|
|
* An embedding function that automatically creates vector representation for a given column.
|
|
*/
|
|
export interface EmbeddingFunction<T> {
|
|
/**
|
|
* The name of the column that will be used as input for the Embedding Function.
|
|
*/
|
|
sourceColumn: string;
|
|
|
|
/**
|
|
* The data type of the embedding
|
|
*
|
|
* The embedding function should return `number`. This will be converted into
|
|
* an Arrow float array. By default this will be Float32 but this property can
|
|
* be used to control the conversion.
|
|
*/
|
|
embeddingDataType?: Float;
|
|
|
|
/**
|
|
* The dimension of the embedding
|
|
*
|
|
* This is optional, normally this can be determined by looking at the results of
|
|
* `embed`. If this is not specified, and there is an attempt to apply the embedding
|
|
* to an empty table, then that process will fail.
|
|
*/
|
|
embeddingDimension?: number;
|
|
|
|
/**
|
|
* The name of the column that will contain the embedding
|
|
*
|
|
* By default this is "vector"
|
|
*/
|
|
destColumn?: string;
|
|
|
|
/**
|
|
* Should the source column be excluded from the resulting table
|
|
*
|
|
* By default the source column is included. Set this to true and
|
|
* only the embedding will be stored.
|
|
*/
|
|
excludeSource?: boolean;
|
|
|
|
/**
|
|
* Creates a vector representation for the given values.
|
|
*/
|
|
embed: (data: T[]) => Promise<number[][]>;
|
|
}
|
|
|
|
export function isEmbeddingFunction<T>(
|
|
value: unknown,
|
|
): value is EmbeddingFunction<T> {
|
|
if (typeof value !== "object" || value === null) {
|
|
return false;
|
|
}
|
|
if (!("sourceColumn" in value) || !("embed" in value)) {
|
|
return false;
|
|
}
|
|
return (
|
|
typeof value.sourceColumn === "string" && typeof value.embed === "function"
|
|
);
|
|
}
|