Class KnowledgeBaseAgenticReasoningActivityRecord

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord
com.azure.search.documents.knowledgebases.models.KnowledgeBaseAgenticReasoningActivityRecord
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>
public final class KnowledgeBaseAgenticReasoningActivityRecord extends KnowledgeBaseActivityRecord
Represents an agentic reasoning activity record.

  • Constructor Details

    • KnowledgeBaseAgenticReasoningActivityRecord

      public KnowledgeBaseAgenticReasoningActivityRecord(int id)
      Creates an instance of KnowledgeBaseAgenticReasoningActivityRecord class.
      Parameters:
      id - the id value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the activity record.
      Overrides:
      getType in class KnowledgeBaseActivityRecord
      Returns:
      the type value.

    • getReasoningTokens

      public Integer getReasoningTokens()
      Get the reasoningTokens property: The number of input tokens for agentic reasoning.
      Returns:
      the reasoningTokens value.

    • setReasoningTokens

      public KnowledgeBaseAgenticReasoningActivityRecord setReasoningTokens(Integer reasoningTokens)
      Set the reasoningTokens property: The number of input tokens for agentic reasoning.
      Parameters:
      reasoningTokens - the reasoningTokens value to set.
      Returns:
      the KnowledgeBaseAgenticReasoningActivityRecord object itself.

    • getRetrievalReasoningEffort

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

    • setRetrievalReasoningEffort

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

    • setElapsedMs

      public KnowledgeBaseAgenticReasoningActivityRecord setElapsedMs(Integer elapsedMs)
      Set the elapsedMs property: The elapsed time in milliseconds for the retrieval activity.
      Overrides:
      setElapsedMs in class KnowledgeBaseActivityRecord
      Parameters:
      elapsedMs - the elapsedMs value to set.
      Returns:
      the KnowledgeBaseActivityRecord object itself.

    • setError

      public KnowledgeBaseAgenticReasoningActivityRecord setError(KnowledgeBaseErrorDetail error)
      Set the error property: The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
      Overrides:
      setError in class KnowledgeBaseActivityRecord
      Parameters:
      error - the error value to set.
      Returns:
      the KnowledgeBaseActivityRecord 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<KnowledgeBaseActivityRecord>
      Overrides:
      toJson in class KnowledgeBaseActivityRecord
      Throws:
      IOException

    • fromJson

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