neo4j

type SimilarityFunction string

type Store struct {
	// contains filtered or unexported fields
}

type StoreConfig struct {
	// Driver is the Neo4j context-aware driver instance. Required.
	Driver neo4j.DriverWithContext

	// Database is the Neo4j database name. Optional: defaults to the
	// driver's default database (typically "neo4j").
	Database string

	// Label is the node label used for documents. Optional: defaults
	// to [DefaultLabel].
	Label string

	// IndexName is the vector index name. Optional: defaults to
	// [DefaultIndexName].
	IndexName string

	// EmbeddingProperty is the node property that stores the vector.
	// Optional: defaults to [DefaultEmbeddingProperty].
	EmbeddingProperty string

	// IDProperty is the node property that stores the document id.
	// Optional: defaults to [DefaultIDProperty].
	IDProperty string

	// TextProperty is the node property that stores the document
	// text. Optional: defaults to [DefaultTextProperty].
	TextProperty string

	// MetadataPrefix is the property-name prefix used for metadata
	// keys (so "metadata.author" instead of "author"). Optional:
	// defaults to [DefaultMetadataPrefix]. The prefix is always present so
	// metadata keys cannot collide with storage properties.
	MetadataPrefix string

	// EmbeddingModel produces vectors for the documents. Required.
	EmbeddingModel embedding.Model

	// DocumentBatcher batches documents before upsert. Required.
	DocumentBatcher vectorstore.Batcher

	// Dimensions sets the vector width recorded in a new index definition, and
	// is required when InitializeSchema is true: the width is part of the index
	// definition, and nothing here can read it off an index that does not exist
	// yet.
	Dimensions int

	// Similarity selects the vector similarity function. Optional:
	// defaults to [SimilarityCosine].
	Similarity SimilarityFunction

	// InitializeSchema, when true, creates the unique-id constraint
	// and the vector index if they don't already exist.
	InitializeSchema bool
}