Class KnowledgeSourceParams

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeSourceParams
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeSourceParams>
Direct Known Subclasses:
AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, IndexedSharePointKnowledgeSourceParams, RemoteSharePointKnowledgeSourceParams, SearchIndexKnowledgeSourceParams, WebKnowledgeSourceParams
public class KnowledgeSourceParams extends Object implements com.azure.json.JsonSerializable<KnowledgeSourceParams>
The KnowledgeSourceParams model.

  • Constructor Details

    • KnowledgeSourceParams

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

  • Method Details

    • getKind

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

    • getKnowledgeSourceName

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

    • isIncludeReferences

      public Boolean isIncludeReferences()
      Get the includeReferences property: Indicates whether references should be included for data retrieved from this source.
      Returns:
      the includeReferences value.

    • setIncludeReferences

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

    • isIncludeReferenceSourceData

      public Boolean isIncludeReferenceSourceData()
      Get the includeReferenceSourceData property: Indicates whether references should include the structured data obtained during retrieval in their payload.
      Returns:
      the includeReferenceSourceData value.

    • setIncludeReferenceSourceData

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

    • isAlwaysQuerySource

      public Boolean isAlwaysQuerySource()
      Get the alwaysQuerySource property: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
      Returns:
      the alwaysQuerySource value.

    • setAlwaysQuerySource

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

    • getRerankerThreshold

      public Float getRerankerThreshold()
      Get the rerankerThreshold property: The reranker threshold all retrieved documents must meet to be included in the response.
      Returns:
      the rerankerThreshold value.

    • setRerankerThreshold

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

    • fromJson

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