Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIError ¶
type APIError = internalreader.APIError
APIError is returned for non-2xx docling-serve responses.
type ChunkOptions ¶
type ChunkOptions = internalreader.ChunkOptions
ChunkOptions tunes docling-serve's hybrid chunker.
type ChunkParser ¶
type ChunkParser = internalreader.ChunkParser
ChunkParser translates a server's raw chunk-endpoint response body into []Chunk.
type ConversionResult ¶
type ConversionResult = internalreader.ConversionResult
ConversionResult is what we get back from docling-serve for a single file.
type ConvertOptions ¶
type ConvertOptions = internalreader.ConvertOptions
ConvertOptions tunes docling-serve conversion. Zero values keep server defaults, which is the safest behavior across docling-serve versions.
type ConvertParser ¶
type ConvertParser = internalreader.ConvertParser
ConvertParser translates a server's raw convert-endpoint response body into ConversionResult.
type Converter ¶
type Converter = internalreader.Converter
Converter is anything that can convert documents to markdown. See internalreader.Converter's own doc comment.
type ExtractedImage ¶
type ExtractedImage = internalreader.ExtractedImage
ExtractedImage is one picture found inside the converted document.
type GenericClient ¶
type GenericClient = internalreader.GenericClient
GenericClient is a configurable client for any document-intelligence HTTP server that accepts a multipart file upload and returns JSON - every protocol detail (paths, the multipart file field name, response parsing) is supplied via GenericConfig.
func NewGenericClient ¶
func NewGenericClient(cfg GenericConfig) (*GenericClient, error)
NewGenericClient validates cfg and builds a GenericClient - see GenericConfig's own field docs for what's required.
type GenericConfig ¶
type GenericConfig = internalreader.GenericConfig
GenericConfig configures a GenericClient.
type HybridChunker ¶
type HybridChunker = internalreader.HybridChunker
HybridChunker is anything that can produce document-aware hybrid chunks. See internalreader.HybridChunker's own doc comment.
type RetryConfig ¶
type RetryConfig = internalreader.RetryConfig
RetryConfig controls best-effort retries for replayable docling-serve calls.
Source Files