Class BaseRemoteEmbeddingSettings

java.lang.Object

com.flowable.agent.engine.impl.model.embedding.BaseEmbeddingSettings

com.flowable.agent.engine.impl.model.embedding.BaseRemoteEmbeddingSettings

Direct Known Subclasses:

AzureOpenAiEmbeddingSettings, OpenAiEmbeddingSettings

public class BaseRemoteEmbeddingSettings
extends BaseEmbeddingSettings

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentDefinitionModel.Credentials	apiKey	Deprecated.
protected FlowableAuthenticationApiKey	apiKeyValueProvider
protected AgentAuthentication	authentication
protected List<AgentDefinitionModel.CustomHeader>	customHeaders
protected Integer	dimension

Fields inherited from class BaseEmbeddingSettings

type

Constructor Summary

Constructors

Constructor	Description
BaseRemoteEmbeddingSettings()

Method Summary

Modifier and Type	Method	Description
AgentDefinitionModel.Credentials	getApiKey()	Deprecated.
FlowableAuthenticationApiKey	getApiKeyValueProvider()
AgentAuthentication	getAuthentication()
List<AgentDefinitionModel.CustomHeader>	getCustomHeaders()
Integer	getDimension()
void	setApiKey(AgentDefinitionModel.Credentials apiKey)	Deprecated.
void	setApiKeyValueProvider(FlowableAuthenticationApiKey apiKeyValueProvider)
void	setAuthentication(AgentAuthentication authentication)
void	setCustomHeaders(List<AgentDefinitionModel.CustomHeader> customHeaders)
void	setDimension(Integer dimension)

Methods inherited from class BaseEmbeddingSettings

getType, setType

Methods inherited from class Object

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

Field Details

dimension

protected Integer dimension

apiKey

@Deprecated
protected AgentDefinitionModel.Credentials apiKey

Deprecated.

Legacy single-credential API key. New KBs use authentication instead. Existing KBs are migrated on read by KnowledgeBaseResourceConverterImpl.

authentication

protected AgentAuthentication authentication

customHeaders

protected List<AgentDefinitionModel.CustomHeader> customHeaders

apiKeyValueProvider

protected FlowableAuthenticationApiKey apiKeyValueProvider

Constructor Details

BaseRemoteEmbeddingSettings

public BaseRemoteEmbeddingSettings()

Method Details

getDimension

public Integer getDimension()

setDimension

public void setDimension(Integer dimension)

getApiKey

@Deprecated
public AgentDefinitionModel.Credentials getApiKey()

Deprecated.

setApiKey

@Deprecated
public void setApiKey(AgentDefinitionModel.Credentials apiKey)

Deprecated.

getAuthentication

public AgentAuthentication getAuthentication()

setAuthentication

public void setAuthentication(AgentAuthentication authentication)

getCustomHeaders

public List<AgentDefinitionModel.CustomHeader> getCustomHeaders()

setCustomHeaders

public void setCustomHeaders(List<AgentDefinitionModel.CustomHeader> customHeaders)

getApiKeyValueProvider

public FlowableAuthenticationApiKey getApiKeyValueProvider()

setApiKeyValueProvider

public void setApiKeyValueProvider(FlowableAuthenticationApiKey apiKeyValueProvider)