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

Class KnowledgeAgentIndexParams

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

  • Constructor Details

    • KnowledgeAgentIndexParams

      public KnowledgeAgentIndexParams()
      Creates an instance of KnowledgeAgentIndexParams class.

  • Method Details

    • getIndexName

      public String getIndexName()
      Get the indexName property: The name of the index the params apply to.
      Returns:
      the indexName value.

    • setIndexName

      public KnowledgeAgentIndexParams setIndexName(String indexName)
      Set the indexName property: The name of the index the params apply to.
      Parameters:
      indexName - the indexName value to set.
      Returns:
      the KnowledgeAgentIndexParams object itself.

    • getFilterAddOn

      public String getFilterAddOn()
      Get the filterAddOn property: A filter condition applied to the index (e.g., 'State eq VA').
      Returns:
      the filterAddOn value.

    • setFilterAddOn

      public KnowledgeAgentIndexParams setFilterAddOn(String filterAddOn)
      Set the filterAddOn property: A filter condition applied to the index (e.g., 'State eq VA').
      Parameters:
      filterAddOn - the filterAddOn value to set.
      Returns:
      the KnowledgeAgentIndexParams object itself.

    • getMaxDocsForReranker

      public Integer getMaxDocsForReranker()
      Get the maxDocsForReranker property: Limits the number of documents considered for ranking.
      Returns:
      the maxDocsForReranker value.

    • setMaxDocsForReranker

      public KnowledgeAgentIndexParams setMaxDocsForReranker(Integer maxDocsForReranker)
      Set the maxDocsForReranker property: Limits the number of documents considered for ranking.
      Parameters:
      maxDocsForReranker - the maxDocsForReranker value to set.
      Returns:
      the KnowledgeAgentIndexParams object itself.

    • getRerankerThreshold

      public Float getRerankerThreshold()
      Get the rerankerThreshold property: A threshold for reranking results (range: 0-4).
      Returns:
      the rerankerThreshold value.

    • setRerankerThreshold

      public KnowledgeAgentIndexParams setRerankerThreshold(Float rerankerThreshold)
      Set the rerankerThreshold property: A threshold for reranking results (range: 0-4).
      Parameters:
      rerankerThreshold - the rerankerThreshold value to set.
      Returns:
      the KnowledgeAgentIndexParams object itself.

    • isIncludeReferenceSourceData

      public Boolean isIncludeReferenceSourceData()
      Get the includeReferenceSourceData property: Indicates whether reference source data should be included.
      Returns:
      the includeReferenceSourceData value.

    • setIncludeReferenceSourceData

      public KnowledgeAgentIndexParams setIncludeReferenceSourceData(Boolean includeReferenceSourceData)
      Set the includeReferenceSourceData property: Indicates whether reference source data should be included.
      Parameters:
      includeReferenceSourceData - the includeReferenceSourceData value to set.
      Returns:
      the KnowledgeAgentIndexParams 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<KnowledgeAgentIndexParams>
      Throws:
      IOException

    • fromJson

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