Class KnowledgeBaseRetrievalResponse

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalResponse
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseRetrievalResponse>
public final class KnowledgeBaseRetrievalResponse extends Object implements com.azure.json.JsonSerializable<KnowledgeBaseRetrievalResponse>
The output contract for the retrieval response.

  • Constructor Details

    • KnowledgeBaseRetrievalResponse

      public KnowledgeBaseRetrievalResponse()
      Creates an instance of KnowledgeBaseRetrievalResponse class.

  • Method Details

    • getResponse

      public List<KnowledgeBaseMessage> getResponse()
      Get the response property: The response property.
      Returns:
      the response value.

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

    • getActivity

      public List<KnowledgeBaseActivityRecord> getActivity()
      Get the activity property: The activity records for tracking progress and billing implications.
      Returns:
      the activity 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.

    • getReferences

      public List<KnowledgeBaseReference> getReferences()
      Get the references property: The references for the retrieval data used in the response.
      Returns:
      the references value.

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<KnowledgeBaseRetrievalResponse>
      Throws:
      IOException

    • fromJson

      public static KnowledgeBaseRetrievalResponse fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.