Package org.apache.tika.inference

Class InferenceConfig.RuntimeConfig

java.lang.Object

org.apache.tika.inference.InferenceConfig

org.apache.tika.inference.InferenceConfig.RuntimeConfig

All Implemented Interfaces:

Serializable

Enclosing class:

InferenceConfig

public static class InferenceConfig.RuntimeConfig
extends InferenceConfig

Runtime-only config that prevents modification of security-sensitive and cost-sensitive fields (baseUrl, apiKey, model) at parse time.

These fields must be set at initialization via the config file. If a runtime ParseContext JSON config attempts to set them, the overridden setters throw TikaConfigException.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tika.inference.InferenceConfig

InferenceConfig.RuntimeConfig

Constructor Summary

Constructors

Constructor	Description
RuntimeConfig()

Method Summary

Modifier and Type	Method	Description
void	setApiKey(String apiKey)
void	setBaseUrl(String baseUrl)
void	setMaxBatchSize(int maxBatchSize)	Set the maximum number of chunks per embeddings API request.
void	setMaxChunks(int maxChunks)	Set the maximum number of chunks per document.
void	setModel(String model)

Methods inherited from class org.apache.tika.inference.InferenceConfig

getApiKey, getBaseUrl, getContentField, getMaxBatchSize, getMaxChunkChars, getMaxChunks, getModel, getOutputField, getOverlapChars, getTimeoutSeconds, isClearContentAfterChunking, isSkipEmbedding, setClearContentAfterChunking, setContentField, setMaxChunkChars, setOutputField, setOverlapChars, setSkipEmbedding, setTimeoutSeconds

Methods inherited from class java.lang.Object

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

Constructor Details

RuntimeConfig

public RuntimeConfig()

Method Details

setBaseUrl

public void setBaseUrl(String baseUrl)
                throws TikaConfigException

Overrides:

setBaseUrl in class InferenceConfig

Throws:

TikaConfigException

setApiKey

public void setApiKey(String apiKey)
               throws TikaConfigException

Overrides:

setApiKey in class InferenceConfig

Throws:

TikaConfigException

setModel

public void setModel(String model)

Overrides:

setModel in class InferenceConfig

setMaxBatchSize

public void setMaxBatchSize(int maxBatchSize)

Description copied from class: InferenceConfig

Set the maximum number of chunks per embeddings API request. Must be at least 1.

Overrides:

setMaxBatchSize in class InferenceConfig

setMaxChunks

public void setMaxChunks(int maxChunks)

Description copied from class: InferenceConfig

Set the maximum number of chunks per document. Set to -1 for no limit. Must be -1 or at least 1.

Overrides:

setMaxChunks in class InferenceConfig