Class KnowledgeBaseModelQueryPlanningActivityRecord

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord
com.azure.search.documents.knowledgebases.models.KnowledgeBaseModelQueryPlanningActivityRecord
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseActivityRecord>
public final class KnowledgeBaseModelQueryPlanningActivityRecord extends KnowledgeBaseActivityRecord
Represents an LLM query planning activity record.

  • Constructor Details

    • KnowledgeBaseModelQueryPlanningActivityRecord

      public KnowledgeBaseModelQueryPlanningActivityRecord(int id)
      Creates an instance of KnowledgeBaseModelQueryPlanningActivityRecord 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.

    • getInputTokens

      public Integer getInputTokens()
      Get the inputTokens property: The number of input tokens for the LLM query planning activity.
      Returns:
      the inputTokens value.

    • setInputTokens

      public KnowledgeBaseModelQueryPlanningActivityRecord setInputTokens(Integer inputTokens)
      Set the inputTokens property: The number of input tokens for the LLM query planning activity.
      Parameters:
      inputTokens - the inputTokens value to set.
      Returns:
      the KnowledgeBaseModelQueryPlanningActivityRecord object itself.

    • getOutputTokens

      public Integer getOutputTokens()
      Get the outputTokens property: The number of output tokens for the LLM query planning activity.
      Returns:
      the outputTokens value.

    • setOutputTokens

      public KnowledgeBaseModelQueryPlanningActivityRecord setOutputTokens(Integer outputTokens)
      Set the outputTokens property: The number of output tokens for the LLM query planning activity.
      Parameters:
      outputTokens - the outputTokens value to set.
      Returns:
      the KnowledgeBaseModelQueryPlanningActivityRecord object itself.

    • setElapsedMs

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