Documentation
¶
Overview ¶
Package weaviate provides a vector retriever backed by Weaviate's nearText GraphQL API. The server embeds query text internally; callers supply plain-text queries only.
Index ¶
- type Option
- func WithClassName(className string) Option
- func WithClient(client *client.Client) Option
- func WithContentField(contentField string) Option
- func WithHost(host string) Option
- func WithLogLevel(logLevel string) Option
- func WithLogger(logger logger.Logger) Option
- func WithMinScore(minScore float64) Option
- func WithScheme(scheme string) Option
- func WithSourceField(sourceField string) Option
- func WithTopK(topK int) Option
- type WeaviateRetriever
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*WeaviateRetriever)
Option configures WeaviateRetriever.
func WithClassName ¶
WithClassName sets the Weaviate class name.
func WithClient ¶
WithClient sets the Weaviate client.
func WithContentField ¶
WithContentField sets the Weaviate content field.
func WithLogLevel ¶
WithLogLevel sets the Weaviate log level.
func WithMinScore ¶
WithMinScore sets the Weaviate minimum score.
func WithSourceField ¶
WithSourceField sets the Weaviate source field.
type WeaviateRetriever ¶
type WeaviateRetriever struct {
// contains filtered or unexported fields
}
WeaviateRetriever searches a Weaviate class via nearText and maps hits to interfaces.Document.
func NewRetriever ¶
func NewRetriever(name string, opts ...Option) (*WeaviateRetriever, error)
NewRetriever builds a WeaviateRetriever. name is the stable identifier returned by [Name] and must be non-empty and unique across all retrievers registered with the same agent. className is required. When WithClient is omitted, host is required and scheme defaults to types.DefaultScheme. Zero-valued topK and minScore default to types.DefaultTopK and types.DefaultMinScore.
func (*WeaviateRetriever) Name ¶
func (r *WeaviateRetriever) Name() string
Name implements interfaces.Retriever.
func (*WeaviateRetriever) Search ¶
func (r *WeaviateRetriever) Search(ctx context.Context, query string) ([]interfaces.Document, error)
Search runs a nearText GraphQL query against the configured class and returns ranked documents.
Source Files