Class SearchIndexKnowledgeSourceParams

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeSourceParams
com.azure.search.documents.knowledgebases.models.SearchIndexKnowledgeSourceParams
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSourceParams>
public final class SearchIndexKnowledgeSourceParams extends KnowledgeSourceParams
Specifies runtime parameters for a search index knowledge source.

  • Constructor Details

    • SearchIndexKnowledgeSourceParams

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

  • Method Details

    • getKind

      public KnowledgeSourceKind getKind()
      Get the kind property: The type of the knowledge source.
      Overrides:
      getKind in class KnowledgeSourceParams
      Returns:
      the kind value.

    • 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 SearchIndexKnowledgeSourceParams 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 SearchIndexKnowledgeSourceParams object itself.

    • setIncludeReferences

      public SearchIndexKnowledgeSourceParams setIncludeReferences(Boolean includeReferences)
      Set the includeReferences property: Indicates whether references should be included for data retrieved from this source.
      Overrides:
      setIncludeReferences in class KnowledgeSourceParams
      Parameters:
      includeReferences - the includeReferences value to set.
      Returns:
      the KnowledgeSourceParams object itself.

    • setIncludeReferenceSourceData

      public SearchIndexKnowledgeSourceParams setIncludeReferenceSourceData(Boolean includeReferenceSourceData)
      Set the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.
      Overrides:
      setIncludeReferenceSourceData in class KnowledgeSourceParams
      Parameters:
      includeReferenceSourceData - the includeReferenceSourceData value to set.
      Returns:
      the KnowledgeSourceParams object itself.

    • setAlwaysQuerySource

      public SearchIndexKnowledgeSourceParams setAlwaysQuerySource(Boolean alwaysQuerySource)
      Set the alwaysQuerySource property: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
      Overrides:
      setAlwaysQuerySource in class KnowledgeSourceParams
      Parameters:
      alwaysQuerySource - the alwaysQuerySource value to set.
      Returns:
      the KnowledgeSourceParams object itself.

    • setRerankerThreshold

      public SearchIndexKnowledgeSourceParams setRerankerThreshold(Float rerankerThreshold)
      Set the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.
      Overrides:
      setRerankerThreshold in class KnowledgeSourceParams
      Parameters:
      rerankerThreshold - the rerankerThreshold value to set.
      Returns:
      the KnowledgeSourceParams 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<KnowledgeSourceParams>
      Overrides:
      toJson in class KnowledgeSourceParams
      Throws:
      IOException

    • fromJson

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