llmtuner.llms.anyllm

Attributes

workspacemap_server_db

Classes

AnyLLMBase	Base class to handle interface to AnythingLLM
AnyLLMBuilder	Interface to create workspaces and embed documents in AnythingLLM
AnyLLMChatter	Interface to chat with a specific workspace.
AnyLLMDocuments	Class to manage documents in Anything LLM with vector database.
AnyLLMSpace	Class to interact with space/model in Anything LLM

Module Contents

class llmtuner.llms.anyllm.AnyLLMBase(config='')

Bases: llmtuner.interface.Interface

Base class to handle interface to AnythingLLM

syncronize_store(updatestore=False)

Check consistency between instance and store and update if required.

get_workspaces_list(synchronize=False)

Get currently available workspace list from AnythingLLM and synchronize with local DB if ‘synchronize’=True

class llmtuner.llms.anyllm.AnyLLMBuilder(workspace_slug='')

Bases: AnyLLMBase

Interface to create workspaces and embed documents in AnythingLLM

workspace = None

vectordb

docids = []

get_available_documents(include_staged=True, include_embedded=True, include_workspace=True, filters={'indexed': {}, 'staged': {}, 'embedded': {}, 'added': {}}, common_only=False, docids_only=True)

Get list of available documents indexed, staged, embedded in vector database, and, if workspace is set, added to the workspace, sorted by docid. You can provide a dictionary to filter for specific entries by providing column names and values for the tables.

add_document(url, metadata={})

Manually add a document to the document index by providing the url and optionally additional metadata.

stage_documents(docids=[], update=True)

Download documents locally and prepare for embedding

embed_documents(docids=[])

Add a datafile to the vector database according to docid

move_documents_to_space(docids=[])

Adding embedded documents to the selected space

list_documents_in_space()

List documents added to the workspace

remove_documents_from_space(docids=[])

Removing documents from the selected space (will still be in the database)

delete_documents(docids=[])

Delete documents from the vector database

unstage_documents(docids=[])

Deletes entries from local storage

unlist_documents(docids=[])

Remove a document from the document index.

set_workspace(workspaceslug, create_new=False)

Set the workspace slug and load workspace from server, or set up a new workspace if ‘create_new’ = True

class llmtuner.llms.anyllm.AnyLLMChatter(workspaceslug='', historylength=5)

Bases: AnyLLMBase

Interface to chat with a specific workspace.

workspace = False

chathistory = []

historylength = 5

set_workspace(workspaceslug)

chat(prompt, return_metadata=False, display_only=False)

Get a reply to a prompt from the workspace

_format_for_jupyter(response='')

Make a nice output of the reply and references for a Jupyter notebook

class llmtuner.llms.anyllm.AnyLLMDocuments

Bases: AnyLLMBase

Class to manage documents in Anything LLM with vector database.

_get_document(documentname)

Getting info for one document.

upload_document(filepath='', content='', uploadname='', referenceid='', fileformat='')

Uploads a file or text content from local storage and updates vectordatabase local table.

get_documents_list(synchronize=False)

Get currently embedded document list from AnythingLLM and synchronize with local DB if ‘synchronize’=True

_delete_documents(docnames)

Deleting documents from the vector database with the internal anythingllm name (docnames []).

remove_documents(docids)

Removing documents from the vector database based on their docids

llmtuner.llms.anyllm.workspacemap_server_db

class llmtuner.llms.anyllm.AnyLLMSpace(spaceslug='', config=None)

Bases: AnyLLMBase

Class to interact with space/model in Anything LLM

slug = ''

meta

_get_metadata_from_server(updateobject=False, getfulldocs=False)

Read metadata for workspace from AnythingLLM server, and update the metadata of this instance. Returns either list of docids or full information on included documents.

_set_metadata_on_server(metadata={})

_get_metadata_from_database(updateobject=False)

_set_metadata_to_database(metadata={})

Set local database entry from object metadata

from_file(filepath, config, initialize_on_server=False)

get_metadata(printit=False)

Display the metadata of the current workspace. If ‘printit’, info will be displayed, not returned.

write(filepath)

Write configuration of a workspace to a local yaml file

create_on_server()

Create a new workspace from the local metadata

delete_from_server()

Remove a workspace from the server

set_workspacename(slug)

Set the name of the workspace and check existance of configuration

chat(prompt, provide_metadata=False)

Use the workspace for chatting

move_documents(docids_add=[], docids_remove=[])

Add documents to the workspace