hnswclient

Documentation

Index

• type Client
  • func New(ctx context.Context, conf config.HNSW) (*Client, error)
  • func (c *Client) CloseConnection() error
  • func (c *Client) CreateIndex(ctx context.Context, name string) error
  • func (c *Client) DeleteIndex(ctx context.Context, name string) error
  • func (c *Client) DeleteIndexIfExists(ctx context.Context, name string) error
  • func (c *Client) IndexExists(ctx context.Context, name string) (bool, error)
  • func (c *Client) Insert(ctx context.Context, indexName string, id uint, vec []float32) error
  • func (c *Client) SearchKNN(indexName string, vector []float32, k int) ([]*Hit, error)
• type Hit

Types

type Client

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

A Client to the HNSW service. It provides essential functionalities for managing indices, and inserting and searching vectors.

func New

func New(ctx context.Context, conf config.HNSW) (*Client, error)

New creates a new Client. Once done you should call Client.CloseConnection.

func (*Client) CloseConnection

func (c *Client) CloseConnection() error

CloseConnection closes the underlying gRPC connection.

func (*Client) CreateIndex

func (c *Client) CreateIndex(ctx context.Context, name string) error

CreateIndex creates a new HNSW index.

func (*Client) DeleteIndex

func (c *Client) DeleteIndex(ctx context.Context, name string) error

DeleteIndex deletes an HNSW index.

func (*Client) DeleteIndexIfExists

func (c *Client) DeleteIndexIfExists(ctx context.Context, name string) error

DeleteIndexIfExists deletes an HNSW index only if it exists, otherwise it does nothing.

func (*Client) IndexExists

func (c *Client) IndexExists(ctx context.Context, name string) (bool, error)

IndexExists reports whether an HNSW index exists.

func (*Client) Insert

func (c *Client) Insert(ctx context.Context, indexName string, id uint, vec []float32) error

Insert inserts a vector in the given HNSW index.

func (*Client) SearchKNN

func (c *Client) SearchKNN(indexName string, vector []float32, k int) ([]*Hit, error)

SearchKNN performs K-Nearest Neighbor search.

type Hit

type Hit = grpcapi.Hit

Hit is a single result of KNN search.