Package com.azure.search.documents.agents.models

Class KnowledgeAgentRetrievalRequest

java.lang.Object
com.azure.search.documents.agents.models.KnowledgeAgentRetrievalRequest
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeAgentRetrievalRequest>
public final class KnowledgeAgentRetrievalRequest extends Object implements com.azure.json.JsonSerializable<KnowledgeAgentRetrievalRequest>
The input contract for the retrieval request.

  • Constructor Details

    • KnowledgeAgentRetrievalRequest

      public KnowledgeAgentRetrievalRequest(List<KnowledgeAgentMessage> messages)
      Creates an instance of KnowledgeAgentRetrievalRequest class.
      Parameters:
      messages - the messages value to set.

  • Method Details

    • getMessages

      public List<KnowledgeAgentMessage> getMessages()
      Get the messages property: The messages property.
      Returns:
      the messages value.

    • getTargetIndexParams

      public List<KnowledgeAgentIndexParams> getTargetIndexParams()
      Get the targetIndexParams property: The targetIndexParams property.
      Returns:
      the targetIndexParams value.

    • setTargetIndexParams

      public KnowledgeAgentRetrievalRequest setTargetIndexParams(List<KnowledgeAgentIndexParams> targetIndexParams)
      Set the targetIndexParams property: The targetIndexParams property.
      Parameters:
      targetIndexParams - the targetIndexParams value to set.
      Returns:
      the KnowledgeAgentRetrievalRequest 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<KnowledgeAgentRetrievalRequest>
      Throws:
      IOException

    • fromJson

      public static KnowledgeAgentRetrievalRequest fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KnowledgeAgentRetrievalRequest from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KnowledgeAgentRetrievalRequest if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the KnowledgeAgentRetrievalRequest.