KnowledgeSourceParams Class

Package:

com.azure.search.documents.knowledgebases.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

• java.lang.Object
• • com.azure.search.documents.knowledgebases.models.KnowledgeSourceParams

Implements

JsonSerializable<KnowledgeSourceParams>

public class KnowledgeSourceParams
implements JsonSerializable<KnowledgeSourceParams>

Base type for knowledge source runtime parameters.

Constructor Summary

Constructor	Description
KnowledgeSourceParams(String knowledgeSourceName)	Creates an instance of KnowledgeSourceParams class.

Method Summary

Modifier and Type	Method and Description
static KnowledgeSourceParams	fromJson(JsonReader jsonReader) Reads an instance of KnowledgeSourceParams from the JsonReader.
KnowledgeSourceKind	getKind() Get the kind property: The type of the knowledge source.
String	getKnowledgeSourceName() Get the knowledgeSourceName property: The name of the index the params apply to.
Float	getRerankerThreshold() Get the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.
Boolean	isIncludeReferences() Get the includeReferences property: Indicates whether references should be included for data retrieved from this source.
Boolean	isIncludeReferenceSourceData() Get the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.
KnowledgeSourceParams	setIncludeReferences(Boolean includeReferences) Set the includeReferences property: Indicates whether references should be included for data retrieved from this source.
KnowledgeSourceParams	setIncludeReferenceSourceData(Boolean includeReferenceSourceData) Set the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.
KnowledgeSourceParams	setRerankerThreshold(Float rerankerThreshold) Set the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeSourceParams

public KnowledgeSourceParams(String knowledgeSourceName)

Creates an instance of KnowledgeSourceParams class.

Parameters:

knowledgeSourceName - the knowledgeSourceName value to set.

Method Details

fromJson

public static KnowledgeSourceParams fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeSourceParams from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getKind

public KnowledgeSourceKind getKind()

Get the kind property: The type of the knowledge source.

Returns:

the kind value.

getKnowledgeSourceName

public String getKnowledgeSourceName()

Get the knowledgeSourceName property: The name of the index the params apply to.

Returns:

the knowledgeSourceName value.

getRerankerThreshold

public Float getRerankerThreshold()

Get the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.

Returns:

the rerankerThreshold value.

isIncludeReferences

public Boolean isIncludeReferences()

Get the includeReferences property: Indicates whether references should be included for data retrieved from this source.

Returns:

the includeReferences value.

isIncludeReferenceSourceData

public Boolean isIncludeReferenceSourceData()

Get the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.

Returns:

the includeReferenceSourceData value.

setIncludeReferences

public KnowledgeSourceParams setIncludeReferences(Boolean includeReferences)

Set the includeReferences property: Indicates whether references should be included for data retrieved from this source.

Parameters:

includeReferences - the includeReferences value to set.

Returns:

the KnowledgeSourceParams object itself.

setIncludeReferenceSourceData

public KnowledgeSourceParams setIncludeReferenceSourceData(Boolean includeReferenceSourceData)

Set the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.

Parameters:

includeReferenceSourceData - the includeReferenceSourceData value to set.

Returns:

the KnowledgeSourceParams object itself.

setRerankerThreshold

public KnowledgeSourceParams setRerankerThreshold(Float rerankerThreshold)

Set the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.

Parameters:

rerankerThreshold - the rerankerThreshold value to set.

Returns:

the KnowledgeSourceParams object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException