Class GenericOaiConnectionConfig

java.lang.Object

de.xima.fc.prompt.ms.impl.service.generic_oai.service.model.GenericOaiConnectionConfig

All Implemented Interfaces:

IPromptConnectionConfig_ApiKey, IPromptConnectionConfig_ApiUrl, IPromptConnectionConfig_ConnectTimeout, IPromptConnectionConfig_Model, IPromptConnectionConfig_ReadTimeout, Serializable

public class GenericOaiConnectionConfig
extends Object
implements Serializable, IPromptConnectionConfig_ApiUrl, IPromptConnectionConfig_ApiKey, IPromptConnectionConfig_ConnectTimeout, IPromptConnectionConfig_Model, IPromptConnectionConfig_ReadTimeout

Model class for the configuration of a Generic OAI connection.

Since:

8.5.0

See Also:

• Serialized Form

Field Summary

Fields inherited from interface IPromptConnectionConfig_ApiKey

ATTR_API_KEY

Fields inherited from interface IPromptConnectionConfig_ApiUrl

ATTR_API_URL

Fields inherited from interface IPromptConnectionConfig_ConnectTimeout

ATTR_CONNECT_TIMEOUT

Fields inherited from interface IPromptConnectionConfig_Model

ATTR_MODEL

Fields inherited from interface IPromptConnectionConfig_ReadTimeout

ATTR_READ_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
GenericOaiConnectionConfig()

Method Summary

Modifier and Type	Method	Description
String	getApiKey()	Gets the API key, i.e. the token needed to authenticate with the prompt service provider.
String	getApiUrl()	Gets the API URL, i.e. the URL of the prompt service provider.
Duration	getConnectTimeout()	Gets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
String	getModel()	Gets the name of the model to use when making requests to the prompt service provider.
Duration	getReadTimeout()	Gets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.
void	setApiKey(String apiKey)	Sets the API key, i.e. the token needed to authenticate with the prompt service provider.
void	setApiUrl(String apiUrl)	Sets the API URL, i.e. the URL of the prompt service provider.
void	setConnectTimeout(Duration connectionTimeout)	Sets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.
void	setModel(String model)	Sets the name of the model to use when making requests to the prompt service provider.
void	setReadTimeout(Duration connectionTimeout)	Sets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.

Methods inherited from class Object

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

Constructor Details

GenericOaiConnectionConfig

public GenericOaiConnectionConfig()

Method Details

getApiKey

public String getApiKey()

Description copied from interface: IPromptConnectionConfig_ApiKey

Gets the API key, i.e. the token needed to authenticate with the prompt service provider.

Specified by:

getApiKey in interface IPromptConnectionConfig_ApiKey

Returns:

The API key.

setApiKey

public void setApiKey(String apiKey)

Description copied from interface: IPromptConnectionConfig_ApiKey

Sets the API key, i.e. the token needed to authenticate with the prompt service provider.

Specified by:

setApiKey in interface IPromptConnectionConfig_ApiKey

Parameters:

apiKey - The API key to set.

getApiUrl

public String getApiUrl()

Description copied from interface: IPromptConnectionConfig_ApiUrl

Gets the API URL, i.e. the URL of the prompt service provider.

Specified by:

getApiUrl in interface IPromptConnectionConfig_ApiUrl

Returns:

The API URL.

setApiUrl

public void setApiUrl(String apiUrl)

Description copied from interface: IPromptConnectionConfig_ApiUrl

Sets the API URL, i.e. the URL of the prompt service provider.

Specified by:

setApiUrl in interface IPromptConnectionConfig_ApiUrl

Parameters:

apiUrl - The API URL to set.

getConnectTimeout

public Duration getConnectTimeout()

Description copied from interface: IPromptConnectionConfig_ConnectTimeout

Gets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.

Specified by:

getConnectTimeout in interface IPromptConnectionConfig_ConnectTimeout

Returns:

The connection timeout.

setConnectTimeout

public void setConnectTimeout(Duration connectionTimeout)

Description copied from interface: IPromptConnectionConfig_ConnectTimeout

Sets the connection timeout, i.e. the maximum time to wait for a connection (to the prompt service provider) to be established.

Specified by:

setConnectTimeout in interface IPromptConnectionConfig_ConnectTimeout

Parameters:

connectionTimeout - The connection timeout to set.

getModel

public String getModel()

Description copied from interface: IPromptConnectionConfig_Model

Gets the name of the model to use when making requests to the prompt service provider.

Specified by:

getModel in interface IPromptConnectionConfig_Model

Returns:

The name of the model to use when making requests to the prompt service provider.

setModel

public void setModel(String model)

Description copied from interface: IPromptConnectionConfig_Model

Sets the name of the model to use when making requests to the prompt service provider.

Specified by:

setModel in interface IPromptConnectionConfig_Model

Parameters:

model - The name of the model to use when making requests to the prompt service provider.

getReadTimeout

public Duration getReadTimeout()

Description copied from interface: IPromptConnectionConfig_ReadTimeout

Gets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.

Specified by:

getReadTimeout in interface IPromptConnectionConfig_ReadTimeout

Returns:

The read timeout.

setReadTimeout

public void setReadTimeout(Duration connectionTimeout)

Description copied from interface: IPromptConnectionConfig_ReadTimeout

Sets the read timeout, i.e. the maximum time to wait for the response from the prompt service provider after sending a request.

Specified by:

setReadTimeout in interface IPromptConnectionConfig_ReadTimeout

Parameters:

connectionTimeout - The read timeout to set.