Documentation
¶
Overview ¶
Package pgvector stores and ranks precomputed vectors for an explicitly Host-bound vector space. It does not own an embedding model or the connection pool. Metadata is preserved as opaque bytes; filtered native queries return vectorstore.ErrUnsupportedFilter before querying rows.
Index ¶
Examples ¶
Constants ¶
View Source
const ( DefaultSchemaName = "public" DefaultTableName = "vector_store" DefaultMetadataColumn = "metadata" DefaultIndexSuffix = "_embedding_idx" )
View Source
const Provider = "PgVector"
Variables ¶
This section is empty.
Functions ¶
func NewStore ¶
Example ¶
package main
import (
"context"
"os"
"github.com/jackc/pgx/v5/pgxpool"
"github.com/Tangerg/scope/core/document"
"github.com/Tangerg/scope/core/vectorstore"
"github.com/Tangerg/scope/vectorstores/postgres/pgvector"
)
func main() {
ctx := context.Background()
pool, err := pgxpool.New(ctx, os.Getenv("SCOPE_PGVECTOR_DSN"))
if err != nil {
panic(err)
}
defer pool.Close()
store, err := pgvector.NewStore(ctx, pgvector.StoreConfig{Pool: pool, SchemaName: "scope", TableName: "documents", Space: "release-notes-v1", CreateDimensions: 2})
if err != nil {
panic(err)
}
if err = store.Upsert(ctx, &vectorstore.Batch{Space: "release-notes-v1", Records: []vectorstore.Record{{Document: &document.Document{ID: "one", Text: "current record"}, Values: []float64{1, 0}}}}); err != nil {
panic(err)
}
if _, err = store.Query(ctx, &vectorstore.Query{Space: "release-notes-v1", Values: []float64{1, 0}}); err != nil {
panic(err)
}
if err = store.DeleteIDs(ctx, []string{"one"}); err != nil {
panic(err)
}
}
Output:
Types ¶
type StoreConfig ¶
type StoreConfig struct {
Pool *pgxpool.Pool
SchemaName string
TableName string
IndexName string
MetadataColumn string
// Space is the Host-owned immutable binding for this physical collection.
Space vectorstore.SpaceID
DistanceMetric postgres.DistanceMetric
IndexType IndexType
// CreateDimensions also provisions a missing schema.
CreateDimensions vectorstore.CreateDimensions
}
func (StoreConfig) Validate ¶
func (s StoreConfig) Validate() error
Source Files
Click to show internal directories.
Click to hide internal directories.