AiAssistant

Interface defining the contract for an AI Assistant. This interface declares the methods that any AI Assistant implementation must provide.

Properties

The current AiAssistant configuration.

The current data provider.

The current document identifiers.

The current response state.

abstract suspend fun checkIfDocumentIsAlreadyIngested(documentId: String, fileHash: String): AiAssistantRemoteClient.AiAssistantResponse<None>

Checks if a document is already ingested by verifying its ID and file hash.

abstract fun emitMessage(message: String, documentId: String)

Emits a message to the server.

abstract suspend fun getSessionHistory(): AiAssistantRemoteClient.AiAssistantResponse<List<CompletionResponse>>

Retrieves the session history for a given session ID.

abstract suspend fun ingestDocument(dataProvider: DataProvider, jwt: String): AiAssistantRemoteClient.AiAssistantResponse<IngestionResponse>

Ingests a document by uploading it to the server.

abstract suspend fun initialize(dataProvider: DataProvider, documentIdentifiers: DocumentIdentifiers, withSessionHistory: Boolean = true)

Initializes the assistant with the given data.

abstract suspend fun initializeSocketConnection(includeSessionHistory: Boolean = true)

Initializes a socket connection with the given text.

abstract fun terminate()

Terminates the assistant.

abstract suspend fun update(configuration: AiAssistantConfiguration)

abstract suspend fun update(documentIdentifiers: DocumentIdentifiers)

Updates the assistant with the latest data.