Package com.azure.ai.openai.models

Class ContentFilterDetectionResult

java.lang.Object
com.azure.ai.openai.models.ContentFilterDetectionResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContentFilterDetectionResult>
public final class ContentFilterDetectionResult extends Object implements com.azure.json.JsonSerializable<ContentFilterDetectionResult>
Represents the outcome of a detection operation performed by content filtering.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContentFilterDetectionResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterDetectionResult from the JsonReader.
    boolean
    isDetected()
    Get the detected property: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered.
    boolean
    isFiltered()
    Get the filtered property: A value indicating whether or not the content has been filtered.
    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

  • Method Details

    • isFiltered

      public boolean isFiltered()
      Get the filtered property: A value indicating whether or not the content has been filtered.
      Returns:
      the filtered value.

    • isDetected

      public boolean isDetected()
      Get the detected property: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered.
      Returns:
      the detected value.

    • toJson

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

    • fromJson

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