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

Class KnowledgeAgentTargetIndex

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

  • Constructor Details

    • KnowledgeAgentTargetIndex

      public KnowledgeAgentTargetIndex(String indexName)
      Creates an instance of KnowledgeAgentTargetIndex class.
      Parameters:
      indexName - the indexName value to set.

  • Method Details

    • getIndexName

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

    • getDefaultRerankerThreshold

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

    • setDefaultRerankerThreshold

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

    • isDefaultIncludeReferenceSourceData

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

    • setDefaultIncludeReferenceSourceData

      public KnowledgeAgentTargetIndex setDefaultIncludeReferenceSourceData(Boolean defaultIncludeReferenceSourceData)
      Set the defaultIncludeReferenceSourceData property: Indicates whether reference source data should be included.
      Parameters:
      defaultIncludeReferenceSourceData - the defaultIncludeReferenceSourceData value to set.
      Returns:
      the KnowledgeAgentTargetIndex object itself.

    • getDefaultMaxDocsForReranker

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

    • setDefaultMaxDocsForReranker

      public KnowledgeAgentTargetIndex setDefaultMaxDocsForReranker(Integer defaultMaxDocsForReranker)
      Set the defaultMaxDocsForReranker property: Limits the number of documents considered for ranking.
      Parameters:
      defaultMaxDocsForReranker - the defaultMaxDocsForReranker value to set.
      Returns:
      the KnowledgeAgentTargetIndex 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<KnowledgeAgentTargetIndex>
      Throws:
      IOException

    • fromJson

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