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

Class AzureOpenAISettings

java.lang.Object

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

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

public class AzureOpenAISettings
extends AbstractOpenAIClientSettings

Settings for Azure OpenAI client

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	assertIsValid()	Check if the settings are valid
AzureCredentialType	getAzureOpenAiCredentialsType()
static String	getAzureOpenAiDeploymentNameSuffix()	Get the AZURE_OPEN_AI_DEPLOYMENT_NAME_SUFFIX value
static String	getAzureOpenAiEndpointSuffix()	Get the AZURE_OPEN_AI_ENDPOINT_SUFFIX value
static String	getDefaultSettingsPrefix()	Get the DEFAULT_SETTINGS_PREFIX value
String	getDeploymentName()	Get the Azure OpenAI deployment name
String	getEndpoint()	Get the Azure OpenAI endpoint
String	getKey()	Get the OpenAI client key

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

AzureOpenAISettings

public AzureOpenAISettings(Map<String,String> settings)

AzureOpenAISettings

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

Method Detail

getEndpoint

public String getEndpoint()
                   throws ConfigurationException

Get the Azure OpenAI endpoint

Returns:

Azure OpenAI endpoint

Throws:

ConfigurationException

getDeploymentName

public String getDeploymentName()
                         throws ConfigurationException

Get the Azure OpenAI deployment name

Returns:

Azure OpenAI deployment name

Throws:

ConfigurationException

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

getAzureOpenAiCredentialsType

public AzureCredentialType getAzureOpenAiCredentialsType()

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

getDefaultSettingsPrefix

public static String getDefaultSettingsPrefix()

Get the DEFAULT_SETTINGS_PREFIX value

Returns:

the DEFAULT_SETTINGS_PREFIX value

getAzureOpenAiEndpointSuffix

public static String getAzureOpenAiEndpointSuffix()

Get the AZURE_OPEN_AI_ENDPOINT_SUFFIX value

Returns:

the AZURE_OPEN_AI_ENDPOINT_SUFFIX value

getAzureOpenAiDeploymentNameSuffix

public static String getAzureOpenAiDeploymentNameSuffix()

Get the AZURE_OPEN_AI_DEPLOYMENT_NAME_SUFFIX value

Returns:

the AZURE_OPEN_AI_DEPLOYMENT_NAME_SUFFIX value