pdfcora-ai/com.pdfcora.ai

Package-level declarations

Types

PdfAI

class PdfAI(val document: PdfDocument, val options: PdfAIOptions = PdfAIOptions())

The entry point. One instance per document.

PdfAiAvailability

sealed class PdfAiAvailability

Whether a feature can run right now.

PdfAIOptions

data class PdfAIOptions(val provider: PdfAiProvider? = null, val providerContextTokens: Int = 4096, val context: Context? = null, val experimentalOnDevicePrompt: Boolean = false)

PdfAiOutcome

sealed class PdfAiOutcome<out T>

The outcome of resolving the routes: an answer, or why there wasn't one.

PdfAiProvider

fun interface PdfAiProvider

Implemented by the integrator: their own server, or their own model.

PdfAiRequest

data class PdfAiRequest(val prompt: String, val images: List<ByteArray> = emptyList(), val schema: String? = null)

PdfAiResponse

data class PdfAiResponse(val text: String, val structured: String? = null)

PdfAiResult

data class PdfAiResult<T>(val value: T, val source: PdfAiSource)

PdfAiSource

enum PdfAiSource : Enum<PdfAiSource>

Where an answer came from. Shown to users and logged for audits (PRV-3).

PdfAiUnavailableException

class PdfAiUnavailableException(val reason: PdfAiUnavailableReason) : Exception

Thrown by a route that failed for a reason the host can act on, such as the platform refusing inference from the background. Reported if no later route answers.

PdfAiUnavailableReason

enum PdfAiUnavailableReason : Enum<PdfAiUnavailableReason>

Why a feature cannot run.

PdfAnswer

sealed class PdfAnswer

PdfCitation

data class PdfCitation(val pageIndex: Int, val start: Int, val end: Int, val rects: List<PdfRect>, val quote: String)

A sentence in the document that supports an answer (ANS-5).

PdfGroundedReply

data class PdfGroundedReply(val answer: String, val citations: List<PdfGroundedReply.Citation>)

What the model is asked to return (ANS-2).

PdfPageText

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

One page's text layer. Offsets into text are UTF-16, which the core's character indices count.

PdfPassage

data class PdfPassage(val id: String, val pageIndex: Int, val start: Int, val end: Int, val text: String)

A retrievable piece of a page: whole sentences, with their UTF-16 range.

PdfProposal

data class PdfProposal<T>(val id: String, val kind: PdfProposalKind, val detail: T, val source: PdfAiSource)

A change the user has not agreed to yet.

PdfProposalKind

enum PdfProposalKind : Enum<PdfProposalKind>

PdfProposalSet

class PdfProposalSet<T>(val proposals: List<PdfProposal<T>>, write: suspend (PdfProposal<T>) -> Unit)

PdfSummary

data class PdfSummary(val text: String, val pagesWithoutText: List<Int>)

PdfSummaryStyle

enum PdfSummaryStyle : Enum<PdfSummaryStyle>

PdfTextIndex

data class PdfTextIndex(val pages: List<PdfPageText>, val passages: List<PdfPassage>, val pagesWithoutText: List<Int>)

UnknownProposalException

class UnknownProposalException(id: String) : IllegalArgumentException

Functions

locateQuote

fun locateQuote(source: String, quote: String): IntRange?

Finds a model's quote in the source text and returns its character range there (ANS-3).

resolveRoutes

suspend fun <T> resolveRoutes(onDevice: suspend () -> T?? = null, customProvider: suspend () -> T?? = null, rules: suspend () -> T?? = null): PdfAiOutcome<T>

Tries each route in the fixed order of PRV-2 and reports which one answered.