KnowledgeBaseRetrievalResult Class

Package:
com.azure.search.documents.knowledgebases.models
Maven Artifact:
com.azure:azure-search-documents:12.1.0-beta.1
  • java.lang.Object
    • com.azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalResult

Implements

JsonSerializable<KnowledgeBaseRetrievalResult>

public final class KnowledgeBaseRetrievalResult
implements JsonSerializable<KnowledgeBaseRetrievalResult>

The output contract for the retrieval response.

Method Summary

Modifier and Type Method and Description
static KnowledgeBaseRetrievalResult fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseRetrievalResult from the JsonReader.
List<KnowledgeBaseActivityRecord> getActivity()

Get the activity property: The activity records for tracking progress and billing implications.
List<KnowledgeBaseReference> getReferences()

Get the references property: The references for the retrieval data used in the response.
List<KnowledgeBaseMessage> getResponse()

Get the response property: The response messages.
PurviewSensitivityLabelInfo getResponseSensitivityLabelInfo()

Get the responseSensitivityLabelInfo property: The sensitivity label information for the overall response.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

fromJson

public static KnowledgeBaseRetrievalResult fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseRetrievalResult from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getActivity

public List<KnowledgeBaseActivityRecord> getActivity()

Get the activity property: The activity records for tracking progress and billing implications.

Returns:

the activity value.

getReferences

public List<KnowledgeBaseReference> getReferences()

Get the references property: The references for the retrieval data used in the response.

Returns:

the references value.

getResponse

public List<KnowledgeBaseMessage> getResponse()

Get the response property: The response messages.

Returns:

the response value.

getResponseSensitivityLabelInfo

public PurviewSensitivityLabelInfo getResponseSensitivityLabelInfo()

Get the responseSensitivityLabelInfo property: The sensitivity label information for the overall response.

Returns:

the responseSensitivityLabelInfo value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to