pinecone

Documentation

Index

• type CreateIndexOptions
• type Index
  • func New(options Options, embedder index.Embedder) *Index
  • func (p *Index) Add(ctx context.Context, item *index.Data) error
  • func (p *Index) IsEmpty(ctx context.Context) (bool, error)
  • func (p *Index) LoadFromDocuments(ctx context.Context, documents []document.Document) error
  • func (p *Index) Query(ctx context.Context, query string, opts ...option.Option) (index.SearchResults, error)
  • func (p *Index) Search(ctx context.Context, values []float64, opts ...option.Option) (index.SearchResults, error)
  • func (p *Index) WithAPIKeyAndEnvironment(apiKey, environment string) *Index
• type Options

Types

type CreateIndexOptions

type CreateIndexOptions struct {
	Dimension int
	Replicas  int
	Metric    string
	PodType   string
}

type Index

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

func New

func New(options Options, embedder index.Embedder) *Index

func (*Index) Add

func (p *Index) Add(ctx context.Context, item *index.Data) error

func (*Index) IsEmpty

func (p *Index) IsEmpty(ctx context.Context) (bool, error)

func (*Index) LoadFromDocuments

func (p *Index) LoadFromDocuments(ctx context.Context, documents []document.Document) error

func (*Index) Query

func (p *Index) Query(ctx context.Context, query string, opts ...option.Option) (index.SearchResults, error)

func (*Index) Search

func (p *Index) Search(ctx context.Context, values []float64, opts ...option.Option) (index.SearchResults, error)

func (*Index) WithAPIKeyAndEnvironment

func (p *Index) WithAPIKeyAndEnvironment(apiKey, environment string) *Index

type Options

type Options struct {
	IndexName       string
	Namespace       string
	IncludeContent  bool
	IncludeValues   bool
	BatchUpsertSize *int
	CreateIndex     *CreateIndexOptions
}