Package com.azure.ai.openai.models

Class OnYourDataVectorSearchApiKeyAuthenticationOptions

java.lang.Object

com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions

com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataVectorSearchAuthenticationOptions>

public final class OnYourDataVectorSearchApiKeyAuthenticationOptions
extends OnYourDataVectorSearchAuthenticationOptions

The authentication options for Azure OpenAI On Your Data when using an API key.

Constructor Summary

Constructors

Constructor	Description
OnYourDataVectorSearchApiKeyAuthenticationOptions(String key)	Creates an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataVectorSearchApiKeyAuthenticationOptions	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions from the JsonReader.
String	getKey()	Get the key property: The API key to use for authentication.
OnYourDataVectorSearchAuthenticationType	getType()	Get the type property: The type of authentication to use.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

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

Constructor Details

OnYourDataVectorSearchApiKeyAuthenticationOptions

public OnYourDataVectorSearchApiKeyAuthenticationOptions(String key)

Creates an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions class.

Parameters:

key - the key value to set.

Method Details

getType

public OnYourDataVectorSearchAuthenticationType getType()

Get the type property: The type of authentication to use.

Overrides:

getType in class OnYourDataVectorSearchAuthenticationOptions

Returns:

the type value.

getKey

public String getKey()

Get the key property: The API key to use for authentication.

Returns:

the key value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<OnYourDataVectorSearchAuthenticationOptions>

Overrides:

toJson in class OnYourDataVectorSearchAuthenticationOptions

Throws:

IOException

fromJson

public static OnYourDataVectorSearchApiKeyAuthenticationOptions fromJson(com.azure.json.JsonReader jsonReader)
                                                                  throws IOException

Reads an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OnYourDataVectorSearchApiKeyAuthenticationOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the OnYourDataVectorSearchApiKeyAuthenticationOptions.