Index

A

AbstractApp (class in ragcore.app.base_app) add() (ragcore.app.base_app.AbstractApp method) (ragcore.app.RAGCore method) add_documents() (ragcore.models.database_model.BaseVectorDatabaseModel method) (ragcore.models.database_model.ChromaDatabase method) (ragcore.models.database_model.PineconeDatabase method) (ragcore.services.database_service.DatabaseService method)

APIConstants (class in ragcore.shared.constants) AppBaseError AppConstants (class in ragcore.shared.constants) AzureOpenAIEmbedding (class in ragcore.models.embedding_model) AzureOpenAIModel (class in ragcore.models.llm_model)

B

BaseEmbedding (class in ragcore.models.embedding_model) BaseLLMModel (class in ragcore.models.llm_model)

BaseLocalVectorDatabaseModel (class in ragcore.models.database_model) BaseOpenAIEmbeddings (class in ragcore.models.embedding_model) BaseVectorDatabaseModel (class in ragcore.models.database_model)

C

ChromaDatabase (class in ragcore.models.database_model) chunk_list() (in module ragcore.shared.utils) client (ragcore.models.embedding_model.BaseOpenAIEmbeddings attribute) ConfigurationConstants (class in ragcore.shared.constants)

content (ragcore.models.app_model.QueryResponse attribute) (ragcore.models.document_model.Document attribute) contents (ragcore.models.app_model.TitlesResponse attribute) create_prompt() (ragcore.services.llm_service.LLMService method) custom_key_comparator() (in module ragcore.shared.utils)

D

DatabaseConstants (class in ragcore.shared.constants) DatabaseError DatabaseService (class in ragcore.services.database_service) DataConstants (class in ragcore.shared.constants) DEFAULT_CONFIG_FILE_PATH (ragcore.shared.constants.AppConstants attribute) delete() (ragcore.app.base_app.AbstractApp method) (ragcore.app.RAGCore method) delete_documents() (ragcore.models.database_model.BaseVectorDatabaseModel method) (ragcore.models.database_model.ChromaDatabase method) (ragcore.models.database_model.PineconeDatabase method) (ragcore.services.database_service.DatabaseService method)

Document (class in ragcore.models.document_model) document_to_str() (in module ragcore.shared.utils) DocumentDTO (class in ragcore.dto.document_dto) documents (ragcore.models.app_model.QueryResponse attribute) DocumentService (class in ragcore.services.document_service)

E

embed_texts() (ragcore.models.embedding_model.BaseEmbedding method) (ragcore.models.embedding_model.BaseOpenAIEmbeddings method)

EmbeddingConstants (class in ragcore.shared.constants) EmbeddingError ErrorCodes (class in ragcore.shared.errors)

G

GENERIC_ERROR (ragcore.shared.errors.ErrorCodes attribute) get_number_of_documents() (ragcore.models.database_model.BaseVectorDatabaseModel method) (ragcore.models.database_model.ChromaDatabase method) (ragcore.models.database_model.PineconeDatabase method) get_prompt() (ragcore.models.prompt_model.PromptGenerator method)

get_titles() (ragcore.app.base_app.AbstractApp method) (ragcore.app.RAGCore method) (ragcore.models.database_model.BaseVectorDatabaseModel method) (ragcore.models.database_model.ChromaDatabase method) (ragcore.models.database_model.PineconeDatabase method) (ragcore.services.database_service.DatabaseService method)

I

initialize_llm() (ragcore.services.llm_service.LLMService method) initialize_local_database() (ragcore.services.database_service.DatabaseService method)

initialize_logger() (ragcore.app.base_app.AbstractApp method) initialize_remote_database() (ragcore.services.database_service.DatabaseService method)

K

KEY_AZURE_OPENAI_API_KEY (ragcore.shared.constants.EmbeddingConstants attribute) (ragcore.shared.constants.LLMProviderConstants attribute) KEY_AZURE_OPENAI_API_VERSION (ragcore.shared.constants.ConfigurationConstants attribute) KEY_AZURE_OPENAI_AZURE_ENDPOINT (ragcore.shared.constants.ConfigurationConstants attribute) KEY_CHUNK_OVERLAP (ragcore.shared.constants.ConfigurationConstants attribute) KEY_CHUNK_SIZE (ragcore.shared.constants.ConfigurationConstants attribute) KEY_CONFIGURATION_PATH (ragcore.shared.constants.AppConstants attribute) KEY_DATABASE (ragcore.shared.constants.ConfigurationConstants attribute) KEY_DATABASE_BASE_PATH (ragcore.shared.constants.ConfigurationConstants attribute) KEY_DATABASE_BASE_URL (ragcore.shared.constants.ConfigurationConstants attribute) KEY_DATABASE_PROVIDER (ragcore.shared.constants.ConfigurationConstants attribute) KEY_DATABASE_TYPE (ragcore.shared.constants.ConfigurationConstants attribute) KEY_DOC (ragcore.shared.constants.DatabaseConstants attribute) (ragcore.shared.constants.DataConstants attribute) KEY_DOCUMENTS (ragcore.shared.constants.DatabaseConstants attribute) KEY_EMBEDDING (ragcore.shared.constants.ConfigurationConstants attribute) KEY_EMBEDDING_AZURE_OPENAI_API_VERSION (ragcore.shared.constants.ConfigurationConstants attribute) KEY_EMBEDDING_AZURE_OPENAI_AZURE_ENDPOINT (ragcore.shared.constants.ConfigurationConstants attribute) KEY_EMBEDDING_MODEL (ragcore.shared.constants.ConfigurationConstants attribute) KEY_EMBEDDING_PROVIDER (ragcore.shared.constants.ConfigurationConstants attribute) KEY_HEADERS_ACCEPT (ragcore.shared.constants.DatabaseConstants attribute)

KEY_LLM (ragcore.shared.constants.ConfigurationConstants attribute) KEY_LLM_MODEL (ragcore.shared.constants.ConfigurationConstants attribute) KEY_LLM_PROVIDER (ragcore.shared.constants.ConfigurationConstants attribute) KEY_LOGGER_FLAG (ragcore.shared.constants.AppConstants attribute) KEY_METADATA (ragcore.shared.constants.DatabaseConstants attribute) KEY_METADATAS (ragcore.shared.constants.DatabaseConstants attribute) KEY_NUMBER_SEARCH_RESULTS (ragcore.shared.constants.ConfigurationConstants attribute) KEY_OPENAI_API_KEY (ragcore.shared.constants.LLMProviderConstants attribute) KEY_PAGE (ragcore.shared.constants.DataConstants attribute) KEY_PINECONE_DEFAULT_INDEX (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_HEADERS_API_KEY (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_ID (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_MATCHES (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_NAMESPACE (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_NEXT (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_PAGINATION (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_PAGINATION_TOKEN (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_PREFIX (ragcore.shared.constants.DatabaseConstants attribute) KEY_PINECONE_VECTORS (ragcore.shared.constants.DatabaseConstants attribute) KEY_SPLITTER (ragcore.shared.constants.ConfigurationConstants attribute) KEY_TITLE (ragcore.shared.constants.DatabaseConstants attribute) (ragcore.shared.constants.DataConstants attribute)

L

LLM_PROVIDER_AZUREOPENAI (ragcore.shared.constants.ConfigurationConstants attribute) LLM_PROVIDER_OPENAI (ragcore.shared.constants.ConfigurationConstants attribute) LLMError LLMProviderConstants (class in ragcore.shared.constants)

LLMService (class in ragcore.services.llm_service) load_and_split() (ragcore.models.document_loader_model.PDFLoader method) load_texts() (ragcore.services.document_service.DocumentService method) logger (ragcore.app.base_app.AbstractApp attribute)

M

make_llm_request() (ragcore.services.llm_service.LLMService method) metadata (ragcore.models.document_model.Document attribute) MetadataError model (ragcore.models.embedding_model.BaseOpenAIEmbeddings attribute) module ragcore.app ragcore.app.base_app ragcore.dto.document_dto ragcore.models.app_model ragcore.models.document_loader_model ragcore.models.document_model ragcore.models.prompt_model ragcore.services.database_service ragcore.services.document_service ragcore.services.llm_service ragcore.services.text_splitter_service ragcore.shared.constants ragcore.shared.errors ragcore.shared.utils

O

OpenAIEmbedding (class in ragcore.models.embedding_model)

OpenAIModel (class in ragcore.models.llm_model)

P

PDFLoader (class in ragcore.models.document_loader_model) PINECONE_LIST_VECTORS (ragcore.shared.constants.APIConstants attribute) PineconeDatabase (class in ragcore.models.database_model) PromptError

PromptGenerator (class in ragcore.models.prompt_model) PROVIDER_AZURE_OPENAI (ragcore.shared.constants.EmbeddingConstants attribute) PROVIDER_CHROMA (ragcore.shared.constants.DatabaseConstants attribute) PROVIDER_OPENAI (ragcore.shared.constants.EmbeddingConstants attribute) PROVIDER_PINECONE (ragcore.shared.constants.DatabaseConstants attribute)

Q

query() (ragcore.app.base_app.AbstractApp method) (ragcore.app.RAGCore method) (ragcore.models.database_model.BaseVectorDatabaseModel method) (ragcore.models.database_model.ChromaDatabase method) (ragcore.models.database_model.PineconeDatabase method) (ragcore.services.database_service.DatabaseService method)

QueryResponse (class in ragcore.models.app_model)

R

RAGCore (class in ragcore.app) ragcore.app module ragcore.app.base_app module ragcore.dto.document_dto module ragcore.models.app_model module ragcore.models.document_loader_model module ragcore.models.document_model module ragcore.models.prompt_model module ragcore.services.database_service module

ragcore.services.document_service module ragcore.services.llm_service module ragcore.services.text_splitter_service module ragcore.shared.constants module ragcore.shared.errors module ragcore.shared.utils module remove_file_extension() (in module ragcore.shared.utils) request() (ragcore.models.llm_model.AzureOpenAIModel method) (ragcore.models.llm_model.BaseLLMModel method) (ragcore.models.llm_model.OpenAIModel method)

S

slice_list() (in module ragcore.shared.utils)

split_documents() (ragcore.services.text_splitter_service.TextSplitterService method) split_pages() (ragcore.services.document_service.DocumentService method)

T

TextSplitterService (class in ragcore.services.text_splitter_service) title (ragcore.models.document_model.Document attribute) TitlesResponse (class in ragcore.models.app_model)

to_langchain() (ragcore.dto.document_dto.DocumentDTO method) to_ragcore() (ragcore.dto.document_dto.DocumentDTO method) to_ragcore_list() (ragcore.dto.document_dto.DocumentDTO static method)

U

user (ragcore.models.app_model.QueryResponse attribute) (ragcore.models.app_model.TitlesResponse attribute)

UserConfigurationError

V

VALUE_PINECONE_API_KEY (ragcore.shared.constants.DatabaseConstants attribute)