Package com.azure.search.documents.indexes.models

Class KnowledgeAgent

java.lang.Object
com.azure.search.documents.indexes.models.KnowledgeAgent
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeAgent>
public final class KnowledgeAgent extends Object implements com.azure.json.JsonSerializable<KnowledgeAgent>
The KnowledgeAgent model.

  • Constructor Details

    • KnowledgeAgent

      public KnowledgeAgent(String name, List<KnowledgeAgentModel> models, List<KnowledgeAgentTargetIndex> targetIndexes)
      Creates an instance of KnowledgeAgent class.
      Parameters:
      name - the name value to set.
      models - the models value to set.
      targetIndexes - the targetIndexes value to set.

  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the knowledge agent.
      Returns:
      the name value.

    • getModels

      public List<KnowledgeAgentModel> getModels()
      Get the models property: Contains configuration options on how to connect to AI models.
      Returns:
      the models value.

    • getTargetIndexes

      public List<KnowledgeAgentTargetIndex> getTargetIndexes()
      Get the targetIndexes property: The targetIndexes property.
      Returns:
      the targetIndexes value.

    • getRequestLimits

      public KnowledgeAgentRequestLimits getRequestLimits()
      Get the requestLimits property: Guardrails to limit how much resources are utilized for a single agent retrieval request.
      Returns:
      the requestLimits value.

    • setRequestLimits

      public KnowledgeAgent setRequestLimits(KnowledgeAgentRequestLimits requestLimits)
      Set the requestLimits property: Guardrails to limit how much resources are utilized for a single agent retrieval request.
      Parameters:
      requestLimits - the requestLimits value to set.
      Returns:
      the KnowledgeAgent object itself.

    • getETag

      public String getETag()
      Get the eTag property: The ETag of the agent.
      Returns:
      the eTag value.

    • setETag

      public KnowledgeAgent setETag(String eTag)
      Set the eTag property: The ETag of the agent.
      Parameters:
      eTag - the eTag value to set.
      Returns:
      the KnowledgeAgent object itself.

    • getEncryptionKey

      public SearchResourceEncryptionKey getEncryptionKey()
      Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
      Returns:
      the encryptionKey value.

    • setEncryptionKey

      public KnowledgeAgent setEncryptionKey(SearchResourceEncryptionKey encryptionKey)
      Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.
      Parameters:
      encryptionKey - the encryptionKey value to set.
      Returns:
      the KnowledgeAgent object itself.

    • getDescription

      public String getDescription()
      Get the description property: The description of the agent.
      Returns:
      the description value.

    • setDescription

      public KnowledgeAgent setDescription(String description)
      Set the description property: The description of the agent.
      Parameters:
      description - the description value to set.
      Returns:
      the KnowledgeAgent 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<KnowledgeAgent>
      Throws:
      IOException

    • fromJson

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