retriever

Documentation

Index

• type AWSKendra
  • func NewAWSKendra(client KendraClient, index string, optFns ...func(o *AWSKendraOptions)) *AWSKendra
  • func (r *AWSKendra) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
• type AWSKendraOptions
• type KendraClient
• type VectorStore
  • func NewVectorStore(vectorStore schema.VectorStore, optFns ...func(o *VectorStoreOptions)) *VectorStore
  • func (r *VectorStore) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
• type VectorStoreOptions
• type VectorStoreSearchType

Types

type AWSKendra

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

func NewAWSKendra

func NewAWSKendra(client KendraClient, index string, optFns ...func(o *AWSKendraOptions)) *AWSKendra

func (*AWSKendra) GetRelevantDocuments

func (r *AWSKendra) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)

type AWSKendraOptions

type AWSKendraOptions struct {
	// Number of documents to query for
	K int

	// Languagecode used for querying.
	LanguageCode string
}

type KendraClient

type KendraClient interface {
	Query(ctx context.Context, params *kendra.QueryInput, optFns ...func(*kendra.Options)) (*kendra.QueryOutput, error)
}

type VectorStore

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

func NewVectorStore

func NewVectorStore(vectorStore schema.VectorStore, optFns ...func(o *VectorStoreOptions)) *VectorStore

func (*VectorStore) GetRelevantDocuments

func (r *VectorStore) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)

GetRelevantDocuments returns documents using the vector store.

type VectorStoreOptions

type VectorStoreOptions struct {
	SearchType VectorStoreSearchType
}

type VectorStoreSearchType

type VectorStoreSearchType string

const (
	VectorStoreSearchTypeSimilarity VectorStoreSearchType = "similarity"
)