Skip to main content

internal/reportcandidate/reportcandidate.go

internal/reportcandidate · 108 lines · 15 declarations · source

This file carries the package documentation, rendered on the package page.

Declarations​

const DefaultLimit​

const DefaultLimit = 10

source

const MaxLimit​

const MaxLimit = 32

source

const MaxCandidates​

const MaxCandidates = 1000

source

var ErrInvalidQuery​

var ErrInvalidQuery = errors.New("invalid report candidate query")

source

var ErrProvider​

var ErrProvider = errors.New("report candidate embedding provider failed")

source

var ErrConfiguration​

var ErrConfiguration = errors.New("report candidate retrieval is not configured")

source

type Embedder​

type Embedder interface {
	Embed(context.Context, []string) ([][]float32, error)
}

source

type Store​

type Store interface {
	Active(context.Context, string) (pg.ReportEmbeddingGeneration, error)
	FindCandidates(context.Context, string, pg.EmbeddingModel, []float32, pg.ReportCandidateOptions) (pg.ReportCandidateResult, error)
}

source

type Binding​

type Binding struct{ Name, Revision, EndpointHash string }

source

type Query​

type Query struct {
	Question          string
	Limit, Candidates int
}

source

type Page​

type Page struct {
	GenerationID string               `json:"generation_id"`
	TargetCount  int64                `json:"target_count"`
	BuildState   string               `json:"build_state"`
	Approximate  bool                 `json:"approximate"`
	Candidates   []pg.ReportCandidate `json:"candidates"`
}

source

type Retriever​

type Retriever struct {
	store    Store
	embedder Embedder
	binding  Binding
}

source

func New​

func New(store Store, embedder Embedder, binding Binding) (*Retriever, error)

source

method Query.Validate​

func (q Query) Validate() error

source

method Retriever.Search​

func (r *Retriever) Search(ctx context.Context, scope string, query Query) (Page, error)

source