nutrient/io.nutrient.data.models

Package-level declarations

Types

@Serializable

data class AdditionalContext(val pageIndex: Int?, val text: String?)

Additional context information associated with an AI Assistant response.

@Serializable

data class AgentCompletionRequest(val requestId: String, val issuer: String, val documents: List<Document>, val parameters: AgentCompletionRequestParameters, val chatId: String, val agent: String? = null)

Request to get an agent-specific completion response from the AI Assistant.

AgentCompletionRequestParameters

@Serializable

data class AgentCompletionRequestParameters(val input: String? = null, val context: Context)

Parameters for an agent completion request.

AiAssistantConfiguration

data class AiAssistantConfiguration(val serverUrl: String, val jwt: String, val sessionId: String, val userId: String? = null)

Configuration for AI Assistant. With AI Assistant, users can use AI chat to summarize, translate, and ask questions about documents.

AiAssistantError

@Serializable

data class AiAssistantError(val request: CompletionRequest? = null, val code: String? = null, val message: String? = null)

Error information from the AI Assistant.

AiAssistantEvents

@Serializable

sealed class AiAssistantEvents

Sealed class representing the various states of the AI Assistant.

CompletionRequest

@Serializable

data class CompletionRequest(val requestId: String, val issuer: String, val documents: List<Document>, val parameters: Map<String, String>, val chatId: String, val agent: String? = null)

Request to get a completion response from the AI Assistant.

CompletionResponse

@Serializable

data class CompletionResponse(val requestId: String = UUID.randomUUID().toString(), val sender: String = "", val documents: List<Document> = emptyList(), val timestamp: Long = 0, val index: Int = 0, val content: String? = null, val end: Boolean = true, val suggestions: List<Suggestion>? = null, val additionalContext: AdditionalContext? = null, val links: List<Link> = emptyList(), val state: AiAssistantEvents = AiAssistantEvents.Loading)

Response from an AI Assistant completion request.

Context

@Serializable

data class Context(val pageIndex: Int, val text: String)

Context information for an AI Assistant request, specifying the relevant page and selected text.

Document

@Serializable

data class Document(val documentId: String, val layerName: String = "")

Reference to a document for AI Assistant requests.

DocumentErrorStates

@Serializable

enum DocumentErrorStates : Enum<DocumentErrorStates>

Enum class representing the possible error states of a document during AI Assistant operations.

DocumentIdentifiers

data class DocumentIdentifiers(val dataProvider: DataProvider, val permanentId: String, val sourcePdfSha256: String?, val changingId: String?, val layerName: String?)

Data class representing the document identifiers.

DocumentLinkResponse

@Serializable

data class DocumentLinkResponse(val rects: List<LinkRect>, val pageIndex: Int, val document: Document)

Response containing link information within a document.

IngestionResponse

@Serializable

data class IngestionResponse(val permanentId: String? = null, val changingId: String? = null, val token: String? = null)

Response from the document ingestion process.

InitializationRequest

@Serializable

data class InitializationRequest(val requestId: String?, val userId: String?, val sessionId: String, val clientFeatures: Array<String>)

Request to initialize an AI Assistant session.

Issuer

@Serializable

enum Issuer : Enum<Issuer>

Represents the issuer of a message in AI Assistant communication.

Link

@Serializable

data class Link(val href: String = "", val text: String = "")

A hyperlink reference returned from the AI Assistant.

LinkRect

@Serializable

data class LinkRect(val top: Double, val left: Double, val width: Double, val height: Double)

A rectangular region representing the position and size of a link within a document.

None

@Serializable

open class None

A placeholder class representing an empty or absent value.

Parameters

@Serializable

data class Parameters(val input: String? = null, val context: AdditionalContext? = null)

Parameters associated with a suggestion from the AI Assistant.

RestApiError

@Serializable

data class RestApiError(val type: String? = "", val message: String? = "")

Error information from a REST API call.

Suggestion

@Serializable

data class Suggestion(val text: String, val type: String, val agent: String, val template: String? = null, val parameters: Parameters)

A suggested action or response from the AI Assistant.