cache

Documentation

Index

• type CachedProviderMetadata
  • func NewCachedProviderMetadata(cfg CachedProviderMetadataConfig) (*CachedProviderMetadata, error)
  • func (p *CachedProviderMetadata) Capabilities(ctx context.Context) (types.CapabilitySet, error)
  • func (p *CachedProviderMetadata) DeleteBySource(ctx context.Context, index, registrationKey string, sourceIDs []string) error
  • func (p *CachedProviderMetadata) DeleteDocuments(ctx context.Context, index string, ids []string) error
  • func (p *CachedProviderMetadata) EnsureIndex(ctx context.Context, def types.IndexDefinition) error
  • func (p *CachedProviderMetadata) Health(ctx context.Context, req types.HealthRequest) (types.HealthStatus, error)
  • func (p *CachedProviderMetadata) Name() string
  • func (p *CachedProviderMetadata) ReplaceDocuments(ctx context.Context, index, registrationKey string, sourceIDs []string, ...) error
  • func (p *CachedProviderMetadata) ResetRegistration(ctx context.Context, index, registrationKey string) error
  • func (p *CachedProviderMetadata) Search(ctx context.Context, req types.SearchRequest) (types.SearchResultPage, error)
  • func (p *CachedProviderMetadata) SearchBatch(ctx context.Context, requests []types.SearchRequest) ([]types.SearchResultPage, error)
  • func (p *CachedProviderMetadata) Suggest(ctx context.Context, req types.SuggestRequest) (types.SuggestResult, error)
  • func (p *CachedProviderMetadata) UpsertDocuments(ctx context.Context, index string, docs []types.Document) error
• type CachedProviderMetadataConfig
• type CachedSearch
  • func NewCachedSearch(cfg CachedSearchConfig) (*CachedSearch, error)
  • func (q *CachedSearch) Query(ctx context.Context, req types.SearchRequest) (types.SearchResultPage, error)
• type CachedSearchConfig
• type CachedSuggest
  • func NewCachedSuggest(cfg CachedSuggestConfig) (*CachedSuggest, error)
  • func (q *CachedSuggest) Query(ctx context.Context, req types.SuggestRequest) (types.SuggestResult, error)
• type CachedSuggestConfig
• type SearchQuerier
• type Store
• type SuggestQuerier

Types

type CachedProviderMetadata

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

func NewCachedProviderMetadata

func NewCachedProviderMetadata(cfg CachedProviderMetadataConfig) (*CachedProviderMetadata, error)

func (*CachedProviderMetadata) Capabilities

func (p *CachedProviderMetadata) Capabilities(ctx context.Context) (types.CapabilitySet, error)

func (*CachedProviderMetadata) DeleteBySource

func (p *CachedProviderMetadata) DeleteBySource(ctx context.Context, index, registrationKey string, sourceIDs []string) error

func (*CachedProviderMetadata) DeleteDocuments

func (p *CachedProviderMetadata) DeleteDocuments(ctx context.Context, index string, ids []string) error

func (*CachedProviderMetadata) EnsureIndex

func (p *CachedProviderMetadata) EnsureIndex(ctx context.Context, def types.IndexDefinition) error

func (*CachedProviderMetadata) Health

func (p *CachedProviderMetadata) Health(ctx context.Context, req types.HealthRequest) (types.HealthStatus, error)

func (*CachedProviderMetadata) Name

func (p *CachedProviderMetadata) Name() string

func (*CachedProviderMetadata) ReplaceDocuments

func (p *CachedProviderMetadata) ReplaceDocuments(ctx context.Context, index, registrationKey string, sourceIDs []string, docs []types.Document) error

func (*CachedProviderMetadata) ResetRegistration

func (p *CachedProviderMetadata) ResetRegistration(ctx context.Context, index, registrationKey string) error

func (*CachedProviderMetadata) Search

func (p *CachedProviderMetadata) Search(ctx context.Context, req types.SearchRequest) (types.SearchResultPage, error)

func (*CachedProviderMetadata) SearchBatch

func (p *CachedProviderMetadata) SearchBatch(ctx context.Context, requests []types.SearchRequest) ([]types.SearchResultPage, error)

func (*CachedProviderMetadata) Suggest

func (p *CachedProviderMetadata) Suggest(ctx context.Context, req types.SuggestRequest) (types.SuggestResult, error)

func (*CachedProviderMetadata) UpsertDocuments

func (p *CachedProviderMetadata) UpsertDocuments(ctx context.Context, index string, docs []types.Document) error

type CachedProviderMetadataConfig

type CachedProviderMetadataConfig struct {
	Provider        providers.Provider
	CapabilityCache Store[types.CapabilitySet]
	HealthCache     Store[types.HealthStatus]
	CapabilityTTL   time.Duration
	HealthTTL       time.Duration
	Strict          bool
	Logger          types.Logger
	Metrics         []types.MetricsHook
}

type CachedSearch

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

func NewCachedSearch

func NewCachedSearch(cfg CachedSearchConfig) (*CachedSearch, error)

func (*CachedSearch) Query

func (q *CachedSearch) Query(ctx context.Context, req types.SearchRequest) (types.SearchResultPage, error)

type CachedSearchConfig

type CachedSearchConfig struct {
	Delegate            SearchQuerier
	Cache               Store[types.SearchResultPage]
	GenerationStore     generationLookup
	ProviderName        string
	TTL                 time.Duration
	Strict              bool
	Logger              types.Logger
	Metrics             []types.MetricsHook
	CacheActorSensitive bool
}

type CachedSuggest

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

func NewCachedSuggest

func NewCachedSuggest(cfg CachedSuggestConfig) (*CachedSuggest, error)

func (*CachedSuggest) Query

func (q *CachedSuggest) Query(ctx context.Context, req types.SuggestRequest) (types.SuggestResult, error)

type CachedSuggestConfig

type CachedSuggestConfig struct {
	Delegate            SuggestQuerier
	Cache               Store[types.SuggestResult]
	GenerationStore     generationLookup
	ProviderName        string
	TTL                 time.Duration
	Strict              bool
	Logger              types.Logger
	Metrics             []types.MetricsHook
	CacheActorSensitive bool
}

type SearchQuerier

type SearchQuerier interface {
	Query(ctx context.Context, req types.SearchRequest) (types.SearchResultPage, error)
}

type Store

type Store[V any] interface {
	Get(ctx context.Context, key string) (V, bool, error)
	Set(ctx context.Context, key string, value V, ttl time.Duration) error
	Delete(ctx context.Context, key string) error
}

type SuggestQuerier

type SuggestQuerier interface {
	Query(ctx context.Context, req types.SuggestRequest) (types.SuggestResult, error)
}