chains

Nov 24, 2023

Changes in this version

type ToShould

+ IsReplace bool

Nov 24, 2023

Changes in this version

type AttributeInfo

+ IsCustom interface{}

type Comparison

+ Processed bool

Nov 13, 2023

Changes in this version

type SelfQueryRetriever

+ func (r SelfQueryRetriever) SetEsTmpl(esTmpl string)

Nov 13, 2023

Changes in this version

type AttributeInfo

+ ToShould *ToShould

+ type ToShould struct

+ AddQuery []map[string]interface{}

Nov 9, 2023

Changes in this version

type SelfQueryRetriever

+ func NewSelfQueryRetrieverByTmpl(llm *openai.LLM, metadata []AttributeInfo, ...) SelfQueryRetriever

Nov 6, 2023

Changes in this version

type AttributeInfo

+ Sortable bool

Nov 3, 2023

Changes in this version

type AttributeInfo

+ Contain *ToQuery

Nov 2, 2023

Changes in this version

type AttributeInfo

+ EQ *ToQuery

+ type ToQuery struct

+ CompressArray bool

+ Field string

+ IsTerm bool

Oct 30, 2023

Changes in this version

+ type Sort struct

+ Field string

+ Order string

type StructuredQuery

+ Sort *Sort

Oct 24, 2023

Changes in this version

+ var ErrChainInitialization = errors.New("error initializing chain")

+ var ErrInputValuesWrongType = errors.New("input key is of wrong type")

+ var ErrInvalidInputNumberInSimpleSeq = errors.New("single input expected for chains supplied to SimpleSequentialChain")

+ var ErrInvalidInputValues = errors.New("invalid input values")

+ var ErrInvalidOutputNumberInSimpleSeq = errors.New("single output expected for chains supplied to SimpleSequentialChain")

+ var ErrInvalidOutputValues = errors.New("missing key in output values")

+ var ErrMemoryValuesWrongType = errors.New("memory key is of wrong type")

+ var ErrMissingInputValues = errors.New("missing key in input values")

+ var ErrMissingMemoryKeyValues = errors.New("missing memory key in input values")

+ var ErrMultipleInputsInRun = errors.New("run not supported in chain with more then one expected input")

+ var ErrMultipleOutputsInPredict = errors.New("predict is not supported with a chain that returns multiple values")

+ var ErrMultipleOutputsInRun = errors.New("run not supported in chain with more then one expected output")

+ var ErrOutputNotStringInPredict = errors.New("predict is not supported with a chain that does not return a string")

+ var ErrWrongOutputTypeInRun = errors.New("run not supported in chain that returns value that is not string")

+ func Apply(ctx context.Context, c Chain, inputValues []map[string]any, maxWorkers int, ...) ([]map[string]any, error)

+ func Call(ctx context.Context, c Chain, inputValues map[string]any, ...) (map[string]any, error)

+ func Predict(ctx context.Context, c Chain, inputValues map[string]any, ...) (string, error)

+ func Run(ctx context.Context, c Chain, input any, options ...ChainCallOption) (string, error)

+ type APIChain struct

+ AnswerChain *LLMChain

+ Request HTTPRequest

+ RequestChain *LLMChain

+ func NewAPIChain(llm llms.LanguageModel, request HTTPRequest) APIChain

+ func (a APIChain) Call(ctx context.Context, values map[string]any, opts ...ChainCallOption) (map[string]any, error)

+ func (a APIChain) GetInputKeys() []string

+ func (a APIChain) GetMemory() schema.Memory

+ func (a APIChain) GetOutputKeys() []string

+ type AttributeInfo struct

+ Description string

+ Name string

+ Type string

+ type Chain interface

+ Call func(ctx context.Context, inputs map[string]any, options ...ChainCallOption) (map[string]any, error)

+ GetInputKeys func() []string

+ GetMemory func() schema.Memory

+ GetOutputKeys func() []string

+ type ChainCallOption func(*chainCallOption)

+ func WithMaxLength(maxLength int) ChainCallOption

+ func WithMaxTokens(maxTokens int) ChainCallOption

+ func WithMinLength(minLength int) ChainCallOption

+ func WithModel(model string) ChainCallOption

+ func WithOptions(options chainCallOption) ChainCallOption

+ func WithRepetitionPenalty(repetitionPenalty float64) ChainCallOption

+ func WithSeed(seed int) ChainCallOption

+ func WithStopWords(stopWords []string) ChainCallOption

+ func WithStreamingFunc(streamingFunc func(ctx context.Context, chunk []byte) error) ChainCallOption

+ func WithTemperature(temperature float64) ChainCallOption

+ func WithTopK(topK int) ChainCallOption

+ func WithTopP(topP float64) ChainCallOption

+ type Comparator string

+ const CONTAIN

+ const EQ

+ const GT

+ const GTE

+ const IN

+ const LIKE

+ const LT

+ const LTE

+ const NE

+ const NIN

+ type Comparison struct

+ Attribute string

+ Comparator Comparator

+ Value interface{}

+ func (c Comparison) Accept(t *ElasticsearchTranslator) interface{}

+ type ConditionalPromptSelector struct

+ Conditionals []struct{ ... }

+ DefaultPrompt prompts.PromptTemplate

+ func (s ConditionalPromptSelector) GetPrompt(llm llms.LanguageModel) prompts.PromptTemplate

+ type ConversationalRetrievalQA struct

+ CombineDocumentsChain Chain

+ CondenseQuestionChain Chain

+ InputKey string

+ Memory schema.Memory

+ OutputKey string

+ RephraseQuestion bool

+ Retriever schema.Retriever

+ ReturnGeneratedQuestion bool

+ ReturnSourceDocuments bool

+ func NewConversationalRetrievalQA(combineDocumentsChain Chain, condenseQuestionChain Chain, ...) ConversationalRetrievalQA

+ func NewConversationalRetrievalQAFromLLM(llm llms.LanguageModel, retriever schema.Retriever, memory schema.Memory) ConversationalRetrievalQA

+ func (c ConversationalRetrievalQA) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c ConversationalRetrievalQA) GetInputKeys() []string

+ func (c ConversationalRetrievalQA) GetMemory() schema.Memory

+ func (c ConversationalRetrievalQA) GetOutputKeys() []string

+ type ElasticsearchTranslator struct

+ AllowedComparators []Comparator

+ AllowedOperators []Operator

+ func NewElasticsearchTranslator() *ElasticsearchTranslator

+ func (t *ElasticsearchTranslator) FormatFunc(funcType interface{}) string

+ func (t *ElasticsearchTranslator) ValidateFunc(funcType interface{})

+ func (t *ElasticsearchTranslator) VisitComparison(comparison Comparison) map[string]interface{}

+ func (t *ElasticsearchTranslator) VisitOperation(operation Operation) map[string]interface{}

+ func (t *ElasticsearchTranslator) VisitStructuredQuery(structuredQuery StructuredQuery) (string, map[string]interface{}, int)

+ type EmbeddingFunc func(query string) []float64

+ type FilterDirective interface

+ Accept func(t *ElasticsearchTranslator) interface{}

+ func AstParse(input string) (FilterDirective, error)

+ type HTTPRequest interface

+ Do func(*http.Request) (*http.Response, error)

+ type LLMChain struct

+ CallbacksHandler callbacks.Handler

+ LLM llms.LanguageModel

+ Memory schema.Memory

+ OutputKey string

+ OutputParser schema.OutputParser[any]

+ Prompt prompts.FormatPrompter

+ func LoadCondenseQuestionGenerator(llm llms.LanguageModel) *LLMChain

+ func NewConversation(llm llms.LanguageModel, memory schema.Memory) LLMChain

+ func NewLLMChain(llm llms.LanguageModel, prompt prompts.FormatPrompter) *LLMChain

+ func (c LLMChain) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c LLMChain) GetCallbackHandler() callbacks.Handler

+ func (c LLMChain) GetInputKeys() []string

+ func (c LLMChain) GetMemory() schema.Memory

+ func (c LLMChain) GetOutputKeys() []string

+ type LLMMathChain struct

+ LLMChain *LLMChain

+ func NewLLMMathChain(llm llms.LanguageModel) LLMMathChain

+ func (c LLMMathChain) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c LLMMathChain) GetInputKeys() []string

+ func (c LLMMathChain) GetMemory() schema.Memory

+ func (c LLMMathChain) GetOutputKeys() []string

+ type MapReduceDocuments struct

+ InputKey string

+ LLMChain *LLMChain

+ LLMChainInputVariableName string

+ MaxNumberOfConcurrent int

+ Memory schema.Memory

+ ReduceChain Chain

+ ReduceDocumentVariableName string

+ ReturnIntermediateSteps bool

+ func LoadMapReduceQA(llm llms.LanguageModel) MapReduceDocuments

+ func LoadMapReduceSummarization(llm llms.LanguageModel) MapReduceDocuments

+ func NewMapReduceDocuments(llmChain *LLMChain, reduceChain Chain) MapReduceDocuments

+ func (c MapReduceDocuments) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c MapReduceDocuments) GetInputKeys() []string

+ func (c MapReduceDocuments) GetMemory() schema.Memory

+ func (c MapReduceDocuments) GetOutputKeys() []string

+ type MapRerankDocuments struct

+ AnswerKey string

+ DocumentVariableName string

+ InputKey string

+ LLMChain *LLMChain

+ LLMChainInputVariableName string

+ MaxConcurrentWorkers int

+ OutputKey string

+ RankKey string

+ ReturnIntermediateSteps bool

+ func LoadMapRerankQA(llm llms.LanguageModel) MapRerankDocuments

+ func NewMapRerankDocuments(mapRerankLLMChain *LLMChain) *MapRerankDocuments

+ func (c MapRerankDocuments) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c MapRerankDocuments) GetInputKeys() []string

+ func (c MapRerankDocuments) GetMemory() schema.Memory

+ func (c MapRerankDocuments) GetOutputKeys() []string

+ type Operation struct

+ Arguments []FilterDirective

+ Operator Operator

+ func (o Operation) Accept(t *ElasticsearchTranslator) interface{}

+ type Operator string

+ const AND

+ const NOT

+ const OR

+ type OutputParserException struct

+ Message string

+ func (e OutputParserException) Error() string

+ type PromptSelector interface

+ GetPrompt func(llms.LanguageModel) prompts.PromptTemplate

+ type RefineDocuments struct

+ DocumentPrompt prompts.PromptTemplate

+ DocumentVariableName string

+ InitialResponseName string

+ InputKey string

+ LLMChain *LLMChain

+ OutputKey string

+ RefineLLMChain *LLMChain

+ func LoadRefineQA(llm llms.LanguageModel) RefineDocuments

+ func LoadRefineSummarization(llm llms.LanguageModel) RefineDocuments

+ func NewRefineDocuments(initialLLMChain, refineLLMChain *LLMChain) RefineDocuments

+ func (c RefineDocuments) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c RefineDocuments) GetInputKeys() []string

+ func (c RefineDocuments) GetMemory() schema.Memory

+ func (c RefineDocuments) GetOutputKeys() []string

+ type RetrievalQA struct

+ CombineDocumentsChain Chain

+ InputKey string

+ Retriever schema.Retriever

+ ReturnSourceDocuments bool

+ func NewRetrievalQA(combineDocumentsChain Chain, retriever schema.Retriever) RetrievalQA

+ func NewRetrievalQAFromLLM(llm llms.LanguageModel, retriever schema.Retriever) RetrievalQA

+ func (c RetrievalQA) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c RetrievalQA) GetInputKeys() []string

+ func (c RetrievalQA) GetMemory() schema.Memory

+ func (c RetrievalQA) GetOutputKeys() []string

+ type SQLDatabaseChain struct

+ Database *sqldatabase.SQLDatabase

+ LLMChain *LLMChain

+ OutputKey string

+ TopK int

+ func NewSQLDatabaseChain(llm llms.LanguageModel, topK int, database *sqldatabase.SQLDatabase) *SQLDatabaseChain

+ func (s SQLDatabaseChain) Call(ctx context.Context, inputs map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (s SQLDatabaseChain) GetInputKeys() []string

+ func (s SQLDatabaseChain) GetMemory() schema.Memory

+ func (s SQLDatabaseChain) GetOutputKeys() []string

+ type SearchFunc func(esDsl string) ([]schema.Document, error)

+ type SelfQueryRetriever struct

+ func NewSelfQueryRetriever(llm *openai.LLM, metadata []AttributeInfo, ...) SelfQueryRetriever

+ func (r SelfQueryRetriever) GetRelevantDocuments(c context.Context, query string, sessionID string) ([]schema.Document, error)

+ type SequentialChain struct

+ func NewSequentialChain(chains []Chain, inputKeys []string, outputKeys []string, ...) (*SequentialChain, error)

+ func (c *SequentialChain) Call(ctx context.Context, inputs map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c *SequentialChain) GetInputKeys() []string

+ func (c *SequentialChain) GetMemory() schema.Memory

+ func (c *SequentialChain) GetOutputKeys() []string

+ type SequentialChainOption func(*SequentialChain)

+ func WithSeqChainMemory(memory schema.Memory) SequentialChainOption

+ type SimpleSequentialChain struct

+ func NewSimpleSequentialChain(chains []Chain) (*SimpleSequentialChain, error)

+ func (c *SimpleSequentialChain) Call(ctx context.Context, inputs map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c *SimpleSequentialChain) GetInputKeys() []string

+ func (c *SimpleSequentialChain) GetMemory() schema.Memory

+ func (c *SimpleSequentialChain) GetOutputKeys() []string

+ type StructuredQuery struct

+ Filter FilterDirective

+ Limit int

+ Query string

+ type StructuredQueryOutputParser struct

+ func NewStructuredQueryOutputParser() StructuredQueryOutputParser

+ func (p StructuredQueryOutputParser) Parse(text string) (StructuredQuery, error)

+ type StuffDocuments struct

+ DocumentVariableName string

+ InputKey string

+ LLMChain *LLMChain

+ Separator string

+ func LoadStuffQA(llm llms.LanguageModel) StuffDocuments

+ func LoadStuffSummarization(llm llms.LanguageModel) StuffDocuments

+ func NewStuffDocuments(llmChain *LLMChain) StuffDocuments

+ func (c StuffDocuments) Call(ctx context.Context, values map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c StuffDocuments) GetInputKeys() []string

+ func (c StuffDocuments) GetMemory() schema.Memory

+ func (c StuffDocuments) GetOutputKeys() []string

+ type Transform struct

+ InputKeys []string

+ Memory schema.Memory

+ OutputKeys []string

+ Transform TransformFunc

+ func NewTransform(f TransformFunc, inputVariables []string, outputVariables []string) Transform

+ func (c Transform) Call(ctx context.Context, inputs map[string]any, options ...ChainCallOption) (map[string]any, error)

+ func (c Transform) GetInputKeys() []string

+ func (c Transform) GetMemory() schema.Memory

+ func (c Transform) GetOutputKeys() []string

+ type TransformFunc func(context.Context, map[string]any, ...ChainCallOption) (map[string]any, error)