Package com.azure.ai.openai.models

Class NonAzureOpenAIKeyCredential

java.lang.Object

com.azure.ai.openai.models.NonAzureOpenAIKeyCredential

public final class NonAzureOpenAIKeyCredential
extends Object

Non-Azure OpenAI API keys credential class for accepting non-Azure OpenAI API key credential string.

Constructor Summary

Constructors

Constructor	Description
NonAzureOpenAIKeyCredential(String key)	Create a non-Azure OpenAI API key credential.

Method Summary

Modifier and Type	Method	Description
String	getKey()	Retrieves the key associated to this credential.
NonAzureOpenAIKeyCredential	update(String key)	Update the OpenAI API key value.

Methods inherited from class java.lang.Object

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

Constructor Details

NonAzureOpenAIKeyCredential

public NonAzureOpenAIKeyCredential(String key)

Create a non-Azure OpenAI API key credential.

Parameters:

key - non-Azure OpenAI API key.

Throws:

NullPointerException - If key is null.

IllegalArgumentException - If key is an empty string.

Method Details

getKey

public String getKey()

Retrieves the key associated to this credential.

Returns:

The key being used to authorize requests.

update

public NonAzureOpenAIKeyCredential update(String key)

Update the OpenAI API key value.

Parameters:

key - The OpenAI API key value.

Returns:

the object itself.