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 that defines the config required to initialize the ConvexVectorStore class. It includes the table name, index name, text field name, and embedding field name.

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

    Defaults to "embedding"

  • Optional Readonly get?: GetQuery

    Defaults to internal.langchain.db.get

  • Optional Readonly index?: IndexName

    Defaults to "byEmbedding"

  • Optional Readonly insert?: InsertMutation

    Defaults to internal.langchain.db.insert

  • Optional Readonly metadataField?: MetadataFieldName

    Defaults to "metadata"

  • Optional Readonly table?: TableName

    Defaults to "documents"

  • Optional Readonly textField?: TextFieldName

    Defaults to "text"

Settings

Member Visibility

Theme

Generated using TypeDoc