Class KnowledgeBaseSearchIndexReference

java.lang.Object
com.azure.search.documents.knowledgebases.models.KnowledgeBaseReference
com.azure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexReference
All Implemented Interfaces:
com.azure.json.JsonSerializable<KnowledgeBaseReference>
public final class KnowledgeBaseSearchIndexReference extends KnowledgeBaseReference
Represents an Azure Search document reference.

  • Constructor Details

    • KnowledgeBaseSearchIndexReference

      public KnowledgeBaseSearchIndexReference(String id, int activitySource)
      Creates an instance of KnowledgeBaseSearchIndexReference class.
      Parameters:
      id - the id value to set.
      activitySource - the activitySource value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the reference.
      Overrides:
      getType in class KnowledgeBaseReference
      Returns:
      the type value.

    • getDocKey

      public String getDocKey()
      Get the docKey property: The document key for the reference.
      Returns:
      the docKey value.

    • setDocKey

      public KnowledgeBaseSearchIndexReference setDocKey(String docKey)
      Set the docKey property: The document key for the reference.
      Parameters:
      docKey - the docKey value to set.
      Returns:
      the KnowledgeBaseSearchIndexReference object itself.

    • setSourceData

      public KnowledgeBaseSearchIndexReference setSourceData(Map<String,Object> sourceData)
      Set the sourceData property: Dictionary of <any>.
      Overrides:
      setSourceData in class KnowledgeBaseReference
      Parameters:
      sourceData - the sourceData value to set.
      Returns:
      the KnowledgeBaseReference object itself.

    • setRerankerScore

      public KnowledgeBaseSearchIndexReference setRerankerScore(Float rerankerScore)
      Set the rerankerScore property: The reranker score for the document reference.
      Overrides:
      setRerankerScore in class KnowledgeBaseReference
      Parameters:
      rerankerScore - the rerankerScore value to set.
      Returns:
      the KnowledgeBaseReference 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<KnowledgeBaseReference>
      Overrides:
      toJson in class KnowledgeBaseReference
      Throws:
      IOException

    • fromJson

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