Package com.azure.ai.openai.models

Class OnYourDataModelIdVectorizationSource

java.lang.Object

com.azure.ai.openai.models.OnYourDataVectorizationSource

com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource

All Implemented Interfaces:

com.azure.json.JsonSerializable<OnYourDataVectorizationSource>

public final class OnYourDataModelIdVectorizationSource
extends OnYourDataVectorizationSource

The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a search service model ID. Currently only supported by Elasticsearch®.

Constructor Summary

Constructors

Constructor	Description
OnYourDataModelIdVectorizationSource(String modelId)	Creates an instance of OnYourDataModelIdVectorizationSource class.

Method Summary

Modifier and Type	Method	Description
static OnYourDataModelIdVectorizationSource	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of OnYourDataModelIdVectorizationSource from the JsonReader.
String	getModelId()	Get the modelId property: The embedding model ID build inside the search service.
OnYourDataVectorizationSourceType	getType()	Get the type property: The type of vectorization source 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

OnYourDataModelIdVectorizationSource

public OnYourDataModelIdVectorizationSource(String modelId)

Creates an instance of OnYourDataModelIdVectorizationSource class.

Parameters:

modelId - the modelId value to set.

Method Details

getModelId

public String getModelId()

Get the modelId property: The embedding model ID build inside the search service. Currently only supported by Elasticsearch®.

Returns:

the modelId value.

getType

public OnYourDataVectorizationSourceType getType()

Get the type property: The type of vectorization source to use.

Overrides:

getType in class OnYourDataVectorizationSource

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<OnYourDataVectorizationSource>

Overrides:

toJson in class OnYourDataVectorizationSource

Throws:

IOException

fromJson

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

Reads an instance of OnYourDataModelIdVectorizationSource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OnYourDataModelIdVectorizationSource 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 OnYourDataModelIdVectorizationSource.