Class ContentFilterResult

java.lang.Object
com.azure.ai.openai.models.ContentFilterResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContentFilterResult>

public final class ContentFilterResult extends Object implements com.azure.json.JsonSerializable<ContentFilterResult>
Information about filtered content severity level and if it has been filtered or not.
  • Method Summary

    Modifier and Type
    Method
    Description
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterResult from the JsonReader.
    Get the severity property: Ratings for the intensity and risk level of filtered content.
    boolean
    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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString
  • Method Details

    • getSeverity

      public ContentFilterSeverity getSeverity()
      Get the severity property: Ratings for the intensity and risk level of filtered content.
      Returns:
      the severity value.
    • isFiltered

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

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

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