KnowledgeBaseAzureOpenAIModel Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.KnowledgeBaseModel
  • • com.azure.search.documents.indexes.models.KnowledgeBaseAzureOpenAIModel

public final class KnowledgeBaseAzureOpenAIModel
extends KnowledgeBaseModel

Specifies the Azure OpenAI resource used to do query planning.

Constructor Summary

Constructor	Description
KnowledgeBaseAzureOpenAIModel(AzureOpenAIVectorizerParameters azureOpenAIParameters)	Creates an instance of KnowledgeBaseAzureOpenAIModel class.

Method Summary

Modifier and Type	Method and Description
static KnowledgeBaseAzureOpenAIModel	fromJson(JsonReader jsonReader) Reads an instance of KnowledgeBaseAzureOpenAIModel from the JsonReader.
AzureOpenAIVectorizerParameters	getAzureOpenAIParameters() Get the azureOpenAIParameters property: Contains the parameters specific to Azure OpenAI model endpoint.
KnowledgeBaseModelKind	getKind() Get the kind property: The type of AI model.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from KnowledgeBaseModel

fromJson getKind toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeBaseAzureOpenAIModel

public KnowledgeBaseAzureOpenAIModel(AzureOpenAIVectorizerParameters azureOpenAIParameters)

Creates an instance of KnowledgeBaseAzureOpenAIModel class.

Parameters:

azureOpenAIParameters - the azureOpenAIParameters value to set.

Method Details

fromJson

public static KnowledgeBaseAzureOpenAIModel fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseAzureOpenAIModel from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getAzureOpenAIParameters

public AzureOpenAIVectorizerParameters getAzureOpenAIParameters()

Get the azureOpenAIParameters property: Contains the parameters specific to Azure OpenAI model endpoint.

Returns:

the azureOpenAIParameters value.

getKind

public KnowledgeBaseModelKind getKind()

Get the kind property: The type of AI model.

Overrides:

KnowledgeBaseAzureOpenAIModel.getKind()

Returns:

the kind value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KnowledgeBaseAzureOpenAIModel.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException