Package com.azure.ai.openai.models

Class ContentFilterCitedDetectionResult

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContentFilterCitedDetectionResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterCitedDetectionResult from the JsonReader.
    String
    getLicense()
    Get the license property: The license description associated with the detection.
    String
    getUrl()
    Get the url property: The internet location associated with the detection.
    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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • 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.

    • getUrl

      public String getUrl()
      Get the url property: The internet location associated with the detection.
      Returns:
      the url value.

    • getLicense

      public String getLicense()
      Get the license property: The license description associated with the detection.
      Returns:
      the license value.

    • toJson

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

    • fromJson

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