Package com.azure.search.documents.models

Class DocumentDebugInfo

java.lang.Object
com.azure.search.documents.models.DocumentDebugInfo
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentDebugInfo>
public final class DocumentDebugInfo extends Object implements com.azure.json.JsonSerializable<DocumentDebugInfo>
Contains debugging information that can be used to further explore your search results.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DocumentDebugInfo()
    Creates an instance of DocumentDebugInfo class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentDebugInfo
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentDebugInfo from the JsonReader.
    SemanticDebugInfo
    getSemantic()
    Get the semantic property: Contains debugging information specific to semantic ranking requests.
    VectorsDebugInfo
    getVectors()
    Get the vectors property: Contains debugging information specific to vector and hybrid search.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • DocumentDebugInfo

      public DocumentDebugInfo()
      Creates an instance of DocumentDebugInfo class.

  • Method Details

    • getSemantic

      public SemanticDebugInfo getSemantic()
      Get the semantic property: Contains debugging information specific to semantic ranking requests.
      Returns:
      the semantic value.

    • getVectors

      public VectorsDebugInfo getVectors()
      Get the vectors property: Contains debugging information specific to vector and hybrid search.
      Returns:
      the vectors value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentDebugInfo>
      Throws:
      IOException

    • fromJson

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