nutrient/io.nutrient.domain.ai/AiAssistant

AiAssistant

interface AiAssistant

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

Properties

Link copied to clipboard
abstract val configuration: AiAssistantConfiguration?

The current AiAssistant configuration.

Link copied to clipboard
abstract val identifiers: List<DocumentIdentifiers>

Document identifiers.

Link copied to clipboard
abstract val responseState: Flow<CompletionResponse?>

The current response state.

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun emitContextSpecificMessage(message: String, contextText: String)

Emits a context specific message to the server with contentText It is used in text content selection

Link copied to clipboard
abstract fun emitMessage(message: String)

Emits a message to the server.

Link copied to clipboard
abstract suspend fun emitSelectedText(documentSelectedText: String)

Emits selected text to Ai Assistant

Link copied to clipboard
abstract fun enableTextSelection(enabled: Boolean)

Enables or disables text selection in the AI Assistant chat interface. When disabled, users cannot long-press to select and copy text from chat messages.

Link copied to clipboard
abstract suspend fun getSessionHistory(): AiAssistantRemoteClient.AiAssistantResponse<List<CompletionResponse>>

Retrieves the session history for a given session ID.

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

Ingests a document by uploading it to the server.

Link copied to clipboard
abstract suspend fun initialize(withSessionHistory: Boolean = true)

Initializes the assistant.

Link copied to clipboard
abstract suspend fun initializeSocketConnection(includeSessionHistory: Boolean = true)

Initializes a socket connection.

Link copied to clipboard
abstract suspend fun instantIngestion(documentId: String, layerName: String, sourcePdfSha256: String): AiAssistantRemoteClient.AiAssistantResponse<None>

Ingests a document with optional layer. Requires Document Engine.

Link copied to clipboard
abstract fun isTextSelectionEnabled(): Boolean

Returns whether text selection is currently enabled in the AI Assistant chat interface.

Link copied to clipboard
abstract fun terminate()

Terminates the assistant.

Link copied to clipboard
abstract suspend fun update(configuration: AiAssistantConfiguration)
abstract suspend fun update(listOfDocumentIdentifiers: List<DocumentIdentifiers>)

Updates the assistant with the latest data.

Generated by Dokka
© 2025 Copyright