KnowledgeBase 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.KnowledgeBase

Implements

JsonSerializable<KnowledgeBase>

public final class KnowledgeBase
implements JsonSerializable<KnowledgeBase>

The KnowledgeBase model.

Constructor Summary

Constructor	Description
KnowledgeBase(String name, List<KnowledgeSourceReference> knowledgeSources)	Creates an instance of KnowledgeBase class.

Method Summary

Modifier and Type	Method and Description
static KnowledgeBase	fromJson(JsonReader jsonReader) Reads an instance of KnowledgeBase from the JsonReader.
String	getAnswerInstructions() Get the answerInstructions property: Instructions considered by the knowledge knowledge base when generating answers.
String	getDescription() Get the description property: The description of the knowledge base.
SearchResourceEncryptionKey	getEncryptionKey() Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
String	getETag() Get the eTag property: The ETag of the knowledge base.
List<KnowledgeSourceReference>	getKnowledgeSources() Get the knowledgeSources property: The knowledgeSources property.
List<KnowledgeBaseModel>	getModels() Get the models property: Contains configuration options on how to connect to AI models.
String	getName() Get the name property: The name of the knowledge knowledge base.
KnowledgeRetrievalOutputMode	getOutputMode() Get the outputMode property: The output configuration for this retrieval.
String	getRetrievalInstructions() Get the retrievalInstructions property: Instructions considered by the knowledge knowledge base when developing query plan.
KnowledgeRetrievalReasoningEffort	getRetrievalReasoningEffort() Get the retrievalReasoningEffort property: The retrievalReasoningEffort property.
KnowledgeBase	setAnswerInstructions(String answerInstructions) Set the answerInstructions property: Instructions considered by the knowledge knowledge base when generating answers.
KnowledgeBase	setDescription(String description) Set the description property: The description of the knowledge base.
KnowledgeBase	setEncryptionKey(SearchResourceEncryptionKey encryptionKey) Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
KnowledgeBase	setETag(String eTag) Set the eTag property: The ETag of the knowledge base.
KnowledgeBase	setModels(List<KnowledgeBaseModel> models) Set the models property: Contains configuration options on how to connect to AI models.
KnowledgeBase	setOutputMode(KnowledgeRetrievalOutputMode outputMode) Set the outputMode property: The output configuration for this retrieval.
KnowledgeBase	setRetrievalInstructions(String retrievalInstructions) Set the retrievalInstructions property: Instructions considered by the knowledge knowledge base when developing query plan.
KnowledgeBase	setRetrievalReasoningEffort(KnowledgeRetrievalReasoningEffort retrievalReasoningEffort) Set the retrievalReasoningEffort property: The retrievalReasoningEffort property.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeBase

public KnowledgeBase(String name, List<KnowledgeSourceReference> knowledgeSources)

Creates an instance of KnowledgeBase class.

Parameters:

name - the name value to set.

knowledgeSources - the knowledgeSources value to set.

Method Details

fromJson

public static KnowledgeBase fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBase from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getAnswerInstructions

public String getAnswerInstructions()

Get the answerInstructions property: Instructions considered by the knowledge knowledge base when generating answers.

Returns:

the answerInstructions value.

getDescription

public String getDescription()

Get the description property: The description of the knowledge base.

Returns:

the description value.

getEncryptionKey

public SearchResourceEncryptionKey getEncryptionKey()

Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

Returns:

the encryptionKey value.

getETag

public String getETag()

Get the eTag property: The ETag of the knowledge base.

Returns:

the eTag value.

getKnowledgeSources

public List<KnowledgeSourceReference> getKnowledgeSources()

Get the knowledgeSources property: The knowledgeSources property.

Returns:

the knowledgeSources value.

getModels

public List<KnowledgeBaseModel> getModels()

Get the models property: Contains configuration options on how to connect to AI models.

Returns:

the models value.

getName

public String getName()

Get the name property: The name of the knowledge knowledge base.

Returns:

the name value.

getOutputMode

public KnowledgeRetrievalOutputMode getOutputMode()

Get the outputMode property: The output configuration for this retrieval.

Returns:

the outputMode value.

getRetrievalInstructions

public String getRetrievalInstructions()

Get the retrievalInstructions property: Instructions considered by the knowledge knowledge base when developing query plan.

Returns:

the retrievalInstructions value.

getRetrievalReasoningEffort

public KnowledgeRetrievalReasoningEffort getRetrievalReasoningEffort()

Get the retrievalReasoningEffort property: The retrievalReasoningEffort property.

Returns:

the retrievalReasoningEffort value.

setAnswerInstructions

public KnowledgeBase setAnswerInstructions(String answerInstructions)

Set the answerInstructions property: Instructions considered by the knowledge knowledge base when generating answers.

Parameters:

answerInstructions - the answerInstructions value to set.

Returns:

the KnowledgeBase object itself.

setDescription

public KnowledgeBase setDescription(String description)

Set the description property: The description of the knowledge base.

Parameters:

description - the description value to set.

Returns:

the KnowledgeBase object itself.

setEncryptionKey

public KnowledgeBase setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your knowledge base definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your knowledge base definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your knowledge base definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

Parameters:

encryptionKey - the encryptionKey value to set.

Returns:

the KnowledgeBase object itself.

setETag

public KnowledgeBase setETag(String eTag)

Set the eTag property: The ETag of the knowledge base.

Parameters:

eTag - the eTag value to set.

Returns:

the KnowledgeBase object itself.

setModels

public KnowledgeBase setModels(List<KnowledgeBaseModel> models)

Set the models property: Contains configuration options on how to connect to AI models.

Parameters:

models - the models value to set.

Returns:

the KnowledgeBase object itself.

setOutputMode

public KnowledgeBase setOutputMode(KnowledgeRetrievalOutputMode outputMode)

Set the outputMode property: The output configuration for this retrieval.

Parameters:

outputMode - the outputMode value to set.

Returns:

the KnowledgeBase object itself.

setRetrievalInstructions

public KnowledgeBase setRetrievalInstructions(String retrievalInstructions)

Set the retrievalInstructions property: Instructions considered by the knowledge knowledge base when developing query plan.

Parameters:

retrievalInstructions - the retrievalInstructions value to set.

Returns:

the KnowledgeBase object itself.

setRetrievalReasoningEffort

public KnowledgeBase setRetrievalReasoningEffort(KnowledgeRetrievalReasoningEffort retrievalReasoningEffort)

Set the retrievalReasoningEffort property: The retrievalReasoningEffort property.

Parameters:

retrievalReasoningEffort - the retrievalReasoningEffort value to set.

Returns:

the KnowledgeBase object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException