Package org.apache.tika.parser.vlm

Class VLMOCRConfig.RuntimeConfig

java.lang.Object

org.apache.tika.parser.vlm.VLMOCRConfig

org.apache.tika.parser.vlm.VLMOCRConfig.RuntimeConfig

All Implemented Interfaces:

Serializable

Enclosing class:

VLMOCRConfig

public static class VLMOCRConfig.RuntimeConfig
extends VLMOCRConfig

Runtime-only config that prevents modification of security-sensitive and cost-sensitive fields at parse time.

Always blocked: baseUrl, apiKey, model, maxTokens, maxRetries, allowRuntimePrompt.

Blocked by default (opt-in): prompt — set allowRuntimePrompt=true at initialization time to permit per-request prompt overrides.

The model field is unconditionally blocked because there is no legitimate reason to swap models per-request; if a different model is needed, configure a separate parser instance.

The maxTokens field cannot be raised above the init-time value at runtime to prevent cost attacks on paid API endpoints.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tika.parser.vlm.VLMOCRConfig

VLMOCRConfig.RuntimeConfig

Constructor Summary

Constructors

Constructor	Description
RuntimeConfig()
RuntimeConfig(VLMOCRConfig initConfig)	Creates a RuntimeConfig that inherits the init-time allowRuntimePrompt setting and the maxTokens ceiling from the given parent config.

Method Summary

Modifier and Type	Method	Description
void	setAllowRuntimePrompt(boolean allowRuntimePrompt)
void	setApiKey(String apiKey)
void	setBaseUrl(String baseUrl)
void	setMaxImagePixels(long maxImagePixels)	Set the maximum total pixels (width × height) for an image.
void	setMaxRetries(int maxRetries)
void	setMaxTokens(int maxTokens)
void	setModel(String model)
void	setPrompt(String prompt)
void	setTextRecognizer(boolean textRecognizer)

Methods inherited from class org.apache.tika.parser.vlm.VLMOCRConfig

getApiKey, getBaseUrl, getCompletionsPath, getMaxFileSizeToOcr, getMaxImagePixels, getMaxRetries, getMaxTokens, getMinFileSizeToOcr, getModel, getPrompt, getTimeoutMillis, isAllowRuntimePrompt, isInlineContent, isSkipOcr, isTextRecognizer, setCompletionsPath, setInlineContent, setMaxFileSizeToOcr, setMinFileSizeToOcr, setSkipOcr, setTimeoutMillis

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RuntimeConfig

public RuntimeConfig()

RuntimeConfig

public RuntimeConfig(VLMOCRConfig initConfig)

Creates a RuntimeConfig that inherits the init-time allowRuntimePrompt setting and the maxTokens ceiling from the given parent config.

Method Details

setBaseUrl

public void setBaseUrl(String baseUrl)
                throws TikaConfigException

Overrides:

setBaseUrl in class VLMOCRConfig

Throws:

TikaConfigException

setApiKey

public void setApiKey(String apiKey)
               throws TikaConfigException

Overrides:

setApiKey in class VLMOCRConfig

Throws:

TikaConfigException

setModel

public void setModel(String model)

Overrides:

setModel in class VLMOCRConfig

setMaxRetries

public void setMaxRetries(int maxRetries)

Overrides:

setMaxRetries in class VLMOCRConfig

setPrompt

public void setPrompt(String prompt)

Overrides:

setPrompt in class VLMOCRConfig

setTextRecognizer

public void setTextRecognizer(boolean textRecognizer)

Overrides:

setTextRecognizer in class VLMOCRConfig

setMaxTokens

public void setMaxTokens(int maxTokens)

Overrides:

setMaxTokens in class VLMOCRConfig

setAllowRuntimePrompt

public void setAllowRuntimePrompt(boolean allowRuntimePrompt)

Overrides:

setAllowRuntimePrompt in class VLMOCRConfig

setMaxImagePixels

public void setMaxImagePixels(long maxImagePixels)

Description copied from class: VLMOCRConfig

Set the maximum total pixels (width × height) for an image. Default is 100,000,000. Set to -1 for no limit (not recommended).

Overrides:

setMaxImagePixels in class VLMOCRConfig