Type alias ConvexVectorStoreConfig<DataModel, TableName, IndexName, TextFieldName, EmbeddingFieldName, MetadataFieldName, InsertMutation, GetQuery>
ConvexVectorStoreConfig<DataModel, TableName, IndexName, TextFieldName, EmbeddingFieldName, MetadataFieldName, InsertMutation, GetQuery>: {
ctx: GenericActionCtx<DataModel>;
embeddingField?: EmbeddingFieldName;
get?: GetQuery;
index?: IndexName;
insert?: InsertMutation;
metadataField?: MetadataFieldName;
table?: TableName;
textField?: TextFieldName;
}
Type Parameters
-
DataModel extends GenericDataModel
-
TableName extends TableNamesInDataModel<DataModel>
-
IndexName extends VectorIndexNames<NamedTableInfo<DataModel, TableName>>
-
TextFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>
-
EmbeddingFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>
-
MetadataFieldName extends FieldPaths<NamedTableInfo<DataModel, TableName>>
-
InsertMutation extends FunctionReference<"mutation", "internal", {
document: object;
table: string;
}>
-
GetQuery extends FunctionReference<"query", "internal", {
id: string;
}, object | null>
Type declaration
-
Readonly
ctx: GenericActionCtx<DataModel>
-
Optional
Readonly
embeddingField?: EmbeddingFieldName
-
Optional
Readonly
get?: GetQuery
-
Optional
Readonly
index?: IndexName
-
Optional
Readonly
insert?: InsertMutation
-
Optional
Readonly
metadataField?: MetadataFieldName
-
Optional
Readonly
table?: TableName
-
Optional
Readonly
textField?: TextFieldName
Type that defines the config required to initialize the ConvexVectorStore class. It includes the table name, index name, text field name, and embedding field name.