Class KnowledgeBaseRetrievalRequest

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

  • Constructor Details

    • KnowledgeBaseRetrievalRequest

      public KnowledgeBaseRetrievalRequest()
      Creates an instance of KnowledgeBaseRetrievalRequest class.

  • Method Details

    • getMessages

      public List<KnowledgeBaseMessage> getMessages()
      Get the messages property: A list of chat message style input.
      Returns:
      the messages value.

    • setMessages

      public KnowledgeBaseRetrievalRequest setMessages(List<KnowledgeBaseMessage> messages)
      Set the messages property: A list of chat message style input.
      Parameters:
      messages - the messages value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getIntents

      public List<KnowledgeRetrievalIntent> getIntents()
      Get the intents property: A list of intended queries to execute without model query planning.
      Returns:
      the intents value.

    • setIntents

      public KnowledgeBaseRetrievalRequest setIntents(List<KnowledgeRetrievalIntent> intents)
      Set the intents property: A list of intended queries to execute without model query planning.
      Parameters:
      intents - the intents value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getMaxRuntimeInSeconds

      public Integer getMaxRuntimeInSeconds()
      Get the maxRuntimeInSeconds property: The maximum runtime in seconds.
      Returns:
      the maxRuntimeInSeconds value.

    • setMaxRuntimeInSeconds

      public KnowledgeBaseRetrievalRequest setMaxRuntimeInSeconds(Integer maxRuntimeInSeconds)
      Set the maxRuntimeInSeconds property: The maximum runtime in seconds.
      Parameters:
      maxRuntimeInSeconds - the maxRuntimeInSeconds value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getMaxOutputSize

      public Integer getMaxOutputSize()
      Get the maxOutputSize property: Limits the maximum size of the content in the output.
      Returns:
      the maxOutputSize value.

    • setMaxOutputSize

      public KnowledgeBaseRetrievalRequest setMaxOutputSize(Integer maxOutputSize)
      Set the maxOutputSize property: Limits the maximum size of the content in the output.
      Parameters:
      maxOutputSize - the maxOutputSize value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getRetrievalReasoningEffort

      public KnowledgeRetrievalReasoningEffort getRetrievalReasoningEffort()
      Get the retrievalReasoningEffort property: The retrievalReasoningEffort property.
      Returns:
      the retrievalReasoningEffort value.

    • setRetrievalReasoningEffort

      public KnowledgeBaseRetrievalRequest setRetrievalReasoningEffort(KnowledgeRetrievalReasoningEffort retrievalReasoningEffort)
      Set the retrievalReasoningEffort property: The retrievalReasoningEffort property.
      Parameters:
      retrievalReasoningEffort - the retrievalReasoningEffort value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • isIncludeActivity

      public Boolean isIncludeActivity()
      Get the includeActivity property: Indicates retrieval results should include activity information.
      Returns:
      the includeActivity value.

    • setIncludeActivity

      public KnowledgeBaseRetrievalRequest setIncludeActivity(Boolean includeActivity)
      Set the includeActivity property: Indicates retrieval results should include activity information.
      Parameters:
      includeActivity - the includeActivity value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getOutputMode

      public KnowledgeRetrievalOutputMode getOutputMode()
      Get the outputMode property: The output configuration for this retrieval.
      Returns:
      the outputMode value.

    • setOutputMode

      public KnowledgeBaseRetrievalRequest setOutputMode(KnowledgeRetrievalOutputMode outputMode)
      Set the outputMode property: The output configuration for this retrieval.
      Parameters:
      outputMode - the outputMode value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest object itself.

    • getKnowledgeSourceParams

      public List<KnowledgeSourceParams> getKnowledgeSourceParams()
      Get the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.
      Returns:
      the knowledgeSourceParams value.

    • setKnowledgeSourceParams

      public KnowledgeBaseRetrievalRequest setKnowledgeSourceParams(List<KnowledgeSourceParams> knowledgeSourceParams)
      Set the knowledgeSourceParams property: A list of runtime parameters for the knowledge sources.
      Parameters:
      knowledgeSourceParams - the knowledgeSourceParams value to set.
      Returns:
      the KnowledgeBaseRetrievalRequest 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<KnowledgeBaseRetrievalRequest>
      Throws:
      IOException

    • fromJson

      public static KnowledgeBaseRetrievalRequest fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of KnowledgeBaseRetrievalRequest from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of KnowledgeBaseRetrievalRequest 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 KnowledgeBaseRetrievalRequest.