Package-level declarations

Types

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

Link copied to clipboard
@Serializable
data class AiAssistantError(val request: CompletionRequest? = null, val code: String? = null, val message: String? = null)
Link copied to clipboard
@Serializable
sealed class AiAssistantEvents
Link copied to clipboard
@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)
Link copied to clipboard
@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 links: List<Link> = emptyList(), val state: AiAssistantEvents = AiAssistantEvents.Loading)
Link copied to clipboard
@Serializable
data class Document(val documentId: String, val layerName: String = "")
Link copied to clipboard

Enum class representing the possible error states of a document.

Link copied to clipboard
data class DocumentIdentifiers(val permanentId: String, val changingId: String)

Data class representing the document identifiers.

Link copied to clipboard
@Serializable
data class DocumentLinkResponse(val rects: List<LinkRect>, val pageIndex: Int)
Link copied to clipboard
@Serializable
data class IngestionResponse(val permanentId: String? = null, val changingId: String? = null, val token: String? = null)
Link copied to clipboard
@Serializable
data class InitializationRequest(val requestId: String?, val userId: String?, val sessionId: String, val clientFeatures: Array<String>)
Link copied to clipboard
@Serializable
enum Issuer : Enum<Issuer>
Link copied to clipboard
@Serializable
data class Link(val href: String = "", val text: String = "")
Link copied to clipboard
@Serializable
data class LinkRect(val top: Double, val left: Double, val width: Double, val height: Double)
Link copied to clipboard
@Serializable
open class None
Link copied to clipboard
@Serializable
data class Parameters(val input: String)
Link copied to clipboard
@Serializable
data class RestApiError(val type: String? = "", val message: String? = "")
Link copied to clipboard
@Serializable
data class Suggestion(val text: String, val type: String, val agent: String, val parameters: Parameters)