retriever

Documentation

Overview

Package retriever provides functionality for retrieving relevant documents using various services.

Index

• func AmazonKendraLanguageCodeAttributeFilter(languageCode string) *types.AttributeFilter
• func Run(ctx context.Context, retriever schema.Retriever, query string, ...) ([]schema.Document, error)
• type AmazonKendra
  • func NewAmazonKendra(client AmazonKendraClient, index string, ...) *AmazonKendra
  • func (r *AmazonKendra) Callbacks() []schema.Callback
  • func (r *AmazonKendra) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
  • func (r *AmazonKendra) Verbose() bool
• type AmazonKendraClient
• type AmazonKendraOptions
• type AzureCognitiveSearch
  • func NewAzureCognitiveSearch(apiKey, serviceName, indexName string, ...) *AzureCognitiveSearch
  • func (r *AzureCognitiveSearch) Callbacks() []schema.Callback
  • func (r *AzureCognitiveSearch) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
  • func (r *AzureCognitiveSearch) Verbose() bool
• type AzureCognitiveSearchOptions
• type AzureCognitiveSearchRequest
• type BedrockAgentRuntimeClient
• type BedrockKnowledgeBase
  • func NewBedrockKnowledgeBase(client BedrockAgentRuntimeClient, knowledgeBaseID string, ...) *BedrockKnowledgeBase
  • func (r *BedrockKnowledgeBase) Callbacks() []schema.Callback
  • func (r *BedrockKnowledgeBase) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
  • func (r *BedrockKnowledgeBase) Verbose() bool
• type BedrockKnowledgeBaseOptions
• type HTTPClient
• type Merger
  • func NewMerger(retrievers []schema.Retriever, optFns ...func(o *MergerOptions)) *Merger
  • func (r *Merger) Callbacks() []schema.Callback
  • func (r *Merger) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
  • func (r *Merger) Verbose() bool
• type MergerOptions
• type Options
• type VectorStore
  • func NewVectorStore(vectorStore schema.VectorStore, optFns ...func(o *VectorStoreOptions)) *VectorStore
  • func (r *VectorStore) Callbacks() []schema.Callback
  • func (r *VectorStore) GetRelevantDocuments(ctx context.Context, query string) ([]schema.Document, error)
  • func (r *VectorStore) Verbose() bool
• type VectorStoreOptions
• type VectorStoreSearchType

Functions

func AmazonKendraLanguageCodeAttributeFilter

func AmazonKendraLanguageCodeAttributeFilter(languageCode string) *types.AttributeFilter

func Run

func Run(ctx context.Context, retriever schema.Retriever, query string, optFns ...func(*Options)) ([]schema.Document, error)

Types

type AmazonKendra

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

func NewAmazonKendra

func NewAmazonKendra(client AmazonKendraClient, index string, optFns ...func(o *AmazonKendraOptions)) *AmazonKendra

func (*AmazonKendra) Callbacks

func (r *AmazonKendra) Callbacks() []schema.Callback

Callbacks returns the registered callbacks of the retriever.

func (*AmazonKendra) GetRelevantDocuments

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

func (*AmazonKendra) Verbose

func (r *AmazonKendra) Verbose() bool

Verbose returns the verbosity setting of the retriever.

type AmazonKendraClient

type AmazonKendraClient interface {
	// Retrieve retrieves documents from Amazon Kendra based on the provided input parameters.
	// It returns the retrieval output or an error if the retrieval operation fails.
	Retrieve(ctx context.Context, params *kendra.RetrieveInput, optFns ...func(*kendra.Options)) (*kendra.RetrieveOutput, error)

	// Query performs a query operation on Amazon Kendra using the specified input parameters.
	// It returns the query output or an error if the query operation fails.
	Query(ctx context.Context, params *kendra.QueryInput, optFns ...func(*kendra.Options)) (*kendra.QueryOutput, error)
}

AmazonKendraClient represents a client for interacting with Amazon Kendra.

type AmazonKendraOptions

type AmazonKendraOptions struct {
	*schema.CallbackOptions

	// Number of documents to query for
	TopK int32

	// AttributeFilter provides filtering the results based on document attributes or metadata
	// fields.
	AttributeFilter *types.AttributeFilter

	// UserContext provides information about the user context for an Amazon Kendra index.
	UserContext *types.UserContext

	// DisableRetrieve disabled the Retrieve API call so that only the Query API is used.
	DisableRetrieve bool
}

type AzureCognitiveSearch

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

AzureCognitiveSearch is a retriever implementation for Azure Cognitive Search service.

func NewAzureCognitiveSearch

func NewAzureCognitiveSearch(apiKey, serviceName, indexName string, optFns ...func(o *AzureCognitiveSearchOptions)) *AzureCognitiveSearch

NewAzureCognitiveSearch creates a new instance of AzureCognitiveSearch retriever with the provided options.

func (*AzureCognitiveSearch) Callbacks

func (r *AzureCognitiveSearch) Callbacks() []schema.Callback

Callbacks returns the registered callbacks of the retriever.

func (*AzureCognitiveSearch) GetRelevantDocuments

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

GetRelevantDocuments retrieves relevant documents for the given query using Azure Cognitive Search.

func (*AzureCognitiveSearch) Verbose

func (r *AzureCognitiveSearch) Verbose() bool

Verbose returns the verbosity setting of the retriever.

type AzureCognitiveSearchOptions

type AzureCognitiveSearchOptions struct {
	*schema.CallbackOptions
	// Number of documents to query for
	TopK uint

	// Azure Cognitive Search API version.
	APIVersion string

	// Key to extract content from response.
	ContentKey string

	// HTTP client to use for making requests.
	HTTPClient HTTPClient
}

AzureCognitiveSearchOptions contains options for configuring the AzureCognitiveSearch retriever.

type AzureCognitiveSearchRequest

type AzureCognitiveSearchRequest struct {
	Search string `json:"search"`
	Top    uint   `json:"top"`
}

AzureCognitiveSearchRequest represents the request payload for Azure Cognitive Search.

type BedrockAgentRuntimeClient

type BedrockAgentRuntimeClient interface {
	Retrieve(context.Context, *bedrockagentruntime.RetrieveInput, ...func(*bedrockagentruntime.Options)) (*bedrockagentruntime.RetrieveOutput, error)
}

BedrockAgentRuntimeClient is an interface representing the Bedrock Agent Runtime client.

type BedrockKnowledgeBase

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

BedrockKnowledgeBase is a retriever implementation for retrieving documents from a knowledge base using the Bedrock Agent Runtime client.

func NewBedrockKnowledgeBase

func NewBedrockKnowledgeBase(client BedrockAgentRuntimeClient, knowledgeBaseID string, optFns ...func(o *BedrockKnowledgeBaseOptions)) *BedrockKnowledgeBase

NewBedrockKnowledgeBase creates a new BedrockKnowledgeBase retriever with the specified client, knowledge base ID, and options.

func (*BedrockKnowledgeBase) Callbacks

func (r *BedrockKnowledgeBase) Callbacks() []schema.Callback

Callbacks returns the registered callbacks of the retriever.

func (*BedrockKnowledgeBase) GetRelevantDocuments

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

GetRelevantDocuments retrieves relevant documents from the knowledge base based on the given query.

func (*BedrockKnowledgeBase) Verbose

func (r *BedrockKnowledgeBase) Verbose() bool

Verbose returns the verbosity setting of the retriever.

type BedrockKnowledgeBaseOptions

type BedrockKnowledgeBaseOptions struct {
	*schema.CallbackOptions

	// RetrievalConfiguration provides search parameters for retrieving from knowledge base.
	RetrievalConfiguration types.KnowledgeBaseRetrievalConfiguration
}

BedrockKnowledgeBaseOptions represents the options for configuring BedrockKnowledgeBase.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type Merger

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

func NewMerger

func NewMerger(retrievers []schema.Retriever, optFns ...func(o *MergerOptions)) *Merger

func (*Merger) Callbacks

func (r *Merger) Callbacks() []schema.Callback

Callbacks returns the registered callbacks of the retriever.

func (*Merger) GetRelevantDocuments

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

func (*Merger) Verbose

func (r *Merger) Verbose() bool

Verbose returns the verbosity setting of the retriever.

type MergerOptions

type MergerOptions struct {
	*schema.CallbackOptions
}

type Options

type Options struct {
	Callbacks   []schema.Callback
	ParentRunID string
}

type VectorStore

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

func NewVectorStore

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

func (*VectorStore) Callbacks

func (r *VectorStore) Callbacks() []schema.Callback

Callbacks returns the registered callbacks of the retriever.

func (*VectorStore) GetRelevantDocuments

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

GetRelevantDocuments returns documents using the vector store.

func (*VectorStore) Verbose

func (r *VectorStore) Verbose() bool

Verbose returns the verbosity setting of the retriever.

type VectorStoreOptions

type VectorStoreOptions struct {
	*schema.CallbackOptions
	SearchType VectorStoreSearchType
}

type VectorStoreSearchType

type VectorStoreSearchType string

const (
	VectorStoreSearchTypeSimilarity VectorStoreSearchType = "similarity"
)