Package com.azure.ai.openai.models

Class ContentFilterBlocklistIdResult

java.lang.Object
com.azure.ai.openai.models.ContentFilterBlocklistIdResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContentFilterBlocklistIdResult>
public final class ContentFilterBlocklistIdResult extends Object implements com.azure.json.JsonSerializable<ContentFilterBlocklistIdResult>
Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContentFilterBlocklistIdResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterBlocklistIdResult from the JsonReader.
    String
    getId()
    Get the id property: The ID of the custom blocklist evaluated.
    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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getId

      public String getId()
      Get the id property: The ID of the custom blocklist evaluated.
      Returns:
      the id 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<ContentFilterBlocklistIdResult>
      Throws:
      IOException

    • fromJson

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