Package com.azure.ai.openai.models

Class OnYourDataVectorSearchAuthenticationOptions

java.lang.Object

com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataVectorSearchAuthenticationOptions>

Direct Known Subclasses:

OnYourDataVectorSearchAccessTokenAuthenticationOptions, OnYourDataVectorSearchApiKeyAuthenticationOptions

public class OnYourDataVectorSearchAuthenticationOptions
extends Object
implements com.azure.json.JsonSerializable<OnYourDataVectorSearchAuthenticationOptions>

The authentication options for Azure OpenAI On Your Data vector search.

Constructor Summary

Constructors

Constructor	Description
OnYourDataVectorSearchAuthenticationOptions()	Creates an instance of OnYourDataVectorSearchAuthenticationOptions class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataVectorSearchAuthenticationOptions	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataVectorSearchAuthenticationOptions from the JsonReader.
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

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

OnYourDataVectorSearchAuthenticationOptions

public OnYourDataVectorSearchAuthenticationOptions()

Creates an instance of OnYourDataVectorSearchAuthenticationOptions class.

Method Details

getType

public OnYourDataVectorSearchAuthenticationType getType()

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

Returns:

the type 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>

Throws:

IOException

fromJson

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

Reads an instance of OnYourDataVectorSearchAuthenticationOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException - If an error occurs while reading the OnYourDataVectorSearchAuthenticationOptions.