llm_ctrl_embeddings

README

Embeddings and Context Vectors.

This package is an utility module to create vectors and embeddings to use in contexts and RAG.

It requires OLLAMA.

Documentation

Index

• type LLMEmbeddings
  • func NewLLMEmbeddings(args ...any) (instance *LLMEmbeddings, err error)
  • func (instance *LLMEmbeddings) Close()
  • func (instance *LLMEmbeddings) Context(requestContext *llm_commons.LLMRequestContext, contextKnowledge ...string) (response *llm_commons.LLMResponse, err error)
  • func (instance *LLMEmbeddings) Contextualize(sessionId, vectorId, userQuery string, userQueryMaxResults int, ...) (response *llm_commons.LLMResponse, err error)
  • func (instance *LLMEmbeddings) Embeddings(request *llm_commons.LLMRequestEmbeddings) (response []float64, err error)
  • func (instance *LLMEmbeddings) Open() (err error)
  • func (instance *LLMEmbeddings) Submit(request *llm_commons.LLMRequest) (response *llm_commons.LLMResponse, err error)
• type LLMEmbeddingsRAG
  • func NewLLMEmbeddingsRAG(args ...interface{}) (instance *LLMEmbeddingsRAG, err error)
  • func (instance *LLMEmbeddingsRAG) AddToCollection(dbName string, collName string, writeMode string, docs ...interface{}) (err error)
  • func (instance *LLMEmbeddingsRAG) Close()
  • func (instance *LLMEmbeddingsRAG) CollectionExists(dbName, collName string) (response bool)
  • func (instance *LLMEmbeddingsRAG) CollectionHash(dbName, collName string) (response string)
  • func (instance *LLMEmbeddingsRAG) DB(dbName string) (response vectordb_commons.IVectorDB, err error)
  • func (instance *LLMEmbeddingsRAG) DBExists(dbName string) (response bool)
  • func (instance *LLMEmbeddingsRAG) Load(dbName string, filename string, writeMode string) (err error)
  • func (instance *LLMEmbeddingsRAG) Open() (err error)
  • func (instance *LLMEmbeddingsRAG) Options(dbName string) (response *llm_commons.LLMRagOptionsItem)
  • func (instance *LLMEmbeddingsRAG) Put(dbName, name string, writeMode string, docs ...interface{}) (err error)
  • func (instance *LLMEmbeddingsRAG) Query(dbName, collection, query string, wheres []map[string]interface{}, ...) (response []map[string]interface{}, err error)
  • func (instance *LLMEmbeddingsRAG) RemoveCollection(dbName, collName string) (err error)
  • func (instance *LLMEmbeddingsRAG) RemoveFromCollection(dbName string, collName string, params ...interface{}) (err error)
  • func (instance *LLMEmbeddingsRAG) Sanitize(data []map[string]interface{}) (response []map[string]interface{})
  • func (instance *LLMEmbeddingsRAG) Upsert(dbName string, collName string, docs ...interface{}) (err error)
  • func (instance *LLMEmbeddingsRAG) VectorRoot(dbName string) (response string)

Types

type LLMEmbeddings

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

func NewLLMEmbeddings

func NewLLMEmbeddings(args ...any) (instance *LLMEmbeddings, err error)

func (*LLMEmbeddings) Close

func (instance *LLMEmbeddings) Close()

func (*LLMEmbeddings) Context

func (instance *LLMEmbeddings) Context(requestContext *llm_commons.LLMRequestContext, contextKnowledge ...string) (response *llm_commons.LLMResponse, err error)

Context processes a request with context knowledge and returns an LLM response or an error.

func (*LLMEmbeddings) Contextualize

func (instance *LLMEmbeddings) Contextualize(sessionId, vectorId, userQuery string, userQueryMaxResults int, lang, model string, contextKnowledge ...string) (response *llm_commons.LLMResponse, err error)

Contextualize processes contextual knowledge to generate an LLM response or returns an error if input is invalid.

func (*LLMEmbeddings) Embeddings

func (instance *LLMEmbeddings) Embeddings(request *llm_commons.LLMRequestEmbeddings) (response []float64, err error)

Embeddings https://ollama.com/blog/embedding-models

func (*LLMEmbeddings) Open

func (instance *LLMEmbeddings) Open() (err error)

func (*LLMEmbeddings) Submit

func (instance *LLMEmbeddings) Submit(request *llm_commons.LLMRequest) (response *llm_commons.LLMResponse, err error)

type LLMEmbeddingsRAG

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

LLMEmbeddingsRAG represents a structure with access to vectorDB. This object is the gate for the RAG for LLMs

func NewLLMEmbeddingsRAG

func NewLLMEmbeddingsRAG(args ...interface{}) (instance *LLMEmbeddingsRAG, err error)

func (*LLMEmbeddingsRAG) AddToCollection

func (instance *LLMEmbeddingsRAG) AddToCollection(dbName string, collName string, writeMode string, docs ...interface{}) (err error)

func (*LLMEmbeddingsRAG) Close

func (instance *LLMEmbeddingsRAG) Close()

func (*LLMEmbeddingsRAG) CollectionExists

func (instance *LLMEmbeddingsRAG) CollectionExists(dbName, collName string) (response bool)

func (*LLMEmbeddingsRAG) CollectionHash

func (instance *LLMEmbeddingsRAG) CollectionHash(dbName, collName string) (response string)

func (*LLMEmbeddingsRAG) DB

func (instance *LLMEmbeddingsRAG) DB(dbName string) (response vectordb_commons.IVectorDB, err error)

func (*LLMEmbeddingsRAG) DBExists

func (instance *LLMEmbeddingsRAG) DBExists(dbName string) (response bool)

func (*LLMEmbeddingsRAG) Load

func (instance *LLMEmbeddingsRAG) Load(dbName string, filename string, writeMode string) (err error)

func (*LLMEmbeddingsRAG) Open

func (instance *LLMEmbeddingsRAG) Open() (err error)

func (*LLMEmbeddingsRAG) Options

func (instance *LLMEmbeddingsRAG) Options(dbName string) (response *llm_commons.LLMRagOptionsItem)

func (*LLMEmbeddingsRAG) Put

func (instance *LLMEmbeddingsRAG) Put(dbName, name string, writeMode string, docs ...interface{}) (err error)

func (*LLMEmbeddingsRAG) Query

func (instance *LLMEmbeddingsRAG) Query(dbName, collection, query string, wheres []map[string]interface{}, maxResults int) (response []map[string]interface{}, err error)

Query executes a search query on a specified collection within the VectorDB, applying given filters and returning results. "wheres" is an array of filters. More filters and more loops to get different data

func (*LLMEmbeddingsRAG) RemoveCollection

func (instance *LLMEmbeddingsRAG) RemoveCollection(dbName, collName string) (err error)

func (*LLMEmbeddingsRAG) RemoveFromCollection

func (instance *LLMEmbeddingsRAG) RemoveFromCollection(dbName string, collName string, params ...interface{}) (err error)

func (*LLMEmbeddingsRAG) Sanitize

func (instance *LLMEmbeddingsRAG) Sanitize(data []map[string]interface{}) (response []map[string]interface{})

Sanitize processes and filters the input data to remove unwanted fields and sanitize the content field. Only specific fields ("content", "similarity", "metadata", "id") are retained in the response. The "content" field is sanitized by removing specific text patterns ("search_document: ").

func (*LLMEmbeddingsRAG) Upsert

func (instance *LLMEmbeddingsRAG) Upsert(dbName string, collName string, docs ...interface{}) (err error)

func (*LLMEmbeddingsRAG) VectorRoot

func (instance *LLMEmbeddingsRAG) VectorRoot(dbName string) (response string)