Share via

KnowledgeBaseRetrievalResponse Class

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

Implements

JsonSerializable<KnowledgeBaseRetrievalResponse>

public final class KnowledgeBaseRetrievalResponse
implements JsonSerializable<KnowledgeBaseRetrievalResponse>

The output contract for the retrieval response.

Constructor Summary

Constructor Description
KnowledgeBaseRetrievalResponse()

Creates an instance of KnowledgeBaseRetrievalResponse class.

Method Summary

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

Reads an instance of KnowledgeBaseRetrievalResponse 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 property.
KnowledgeBaseRetrievalResponse setActivity(List<KnowledgeBaseActivityRecord> activity)

Set the activity property: The activity records for tracking progress and billing implications.
KnowledgeBaseRetrievalResponse setReferences(List<KnowledgeBaseReference> references)

Set the references property: The references for the retrieval data used in the response.
KnowledgeBaseRetrievalResponse setResponse(List<KnowledgeBaseMessage> response)

Set the response property: The response property.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

KnowledgeBaseRetrievalResponse

public KnowledgeBaseRetrievalResponse()

Creates an instance of KnowledgeBaseRetrievalResponse class.

Method Details

fromJson

public static KnowledgeBaseRetrievalResponse fromJson(JsonReader jsonReader)

Reads an instance of KnowledgeBaseRetrievalResponse from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

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

Returns:

the response value.

setActivity

public KnowledgeBaseRetrievalResponse setActivity(List<KnowledgeBaseActivityRecord> activity)

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

Parameters:

activity - the activity value to set.

Returns:

the KnowledgeBaseRetrievalResponse object itself.

setReferences

public KnowledgeBaseRetrievalResponse setReferences(List<KnowledgeBaseReference> references)

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

Parameters:

references - the references value to set.

Returns:

the KnowledgeBaseRetrievalResponse object itself.

setResponse

public KnowledgeBaseRetrievalResponse setResponse(List<KnowledgeBaseMessage> response)

Set the response property: The response property.

Parameters:

response - the response value to set.

Returns:

the KnowledgeBaseRetrievalResponse object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to