Package com.microsoft.semantickernel.connectors.ai.openai.util

Class OpenAISettings

java.lang.Object

com.microsoft.semantickernel.connectors.ai.openai.util.AbstractOpenAIClientSettings

com.microsoft.semantickernel.connectors.ai.openai.util.OpenAISettings

public class OpenAISettings
extends AbstractOpenAIClientSettings

Constructor Summary

Constructors

Constructor	Description
OpenAISettings(String settingsPrefix, Map<String,String> settings)
OpenAISettings(Map<String,String> settings)

Method Summary

Modifier and Type	Method	Description
boolean	assertIsValid()	Check if the settings are valid
static String	getDefaultSettingsPrefix()	Get the DEFAULT_SETTINGS_PREFIX value
String	getKey()	Get the OpenAI client key
static String	getOpenAiOrganizationSuffix()	Get the OPEN_AI_ORGANIZATION_SUFFIX value
String	getOrganizationId()

Methods inherited from class com.microsoft.semantickernel.connectors.ai.openai.util.AbstractOpenAIClientSettings

getKeySuffix

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAISettings

public OpenAISettings(Map<String,String> settings)

OpenAISettings

public OpenAISettings(String settingsPrefix,
                      Map<String,String> settings)

Method Detail

getKey

public String getKey()
              throws ConfigurationException

Description copied from class: AbstractOpenAIClientSettings

Get the OpenAI client key

Specified by:

getKey in class AbstractOpenAIClientSettings

Returns:

OpenAI client key

Throws:

ConfigurationException

getOrganizationId

public String getOrganizationId()
                         throws ConfigurationException

Throws:

ConfigurationException

assertIsValid

public boolean assertIsValid()
                      throws ConfigurationException

Description copied from class: AbstractOpenAIClientSettings

Check if the settings are valid

Specified by:

assertIsValid in class AbstractOpenAIClientSettings

Returns:

true if the settings are valid

Throws:

ConfigurationException

getOpenAiOrganizationSuffix

public static String getOpenAiOrganizationSuffix()

Get the OPEN_AI_ORGANIZATION_SUFFIX value

Returns:

the OPEN_AI_ORGANIZATION_SUFFIX value

getDefaultSettingsPrefix

public static String getDefaultSettingsPrefix()

Get the DEFAULT_SETTINGS_PREFIX value

Returns:

the DEFAULT_SETTINGS_PREFIX value