Package com.azure.ai.openai.models

Class ContentFilterResultsForChoice

java.lang.Object
com.azure.ai.openai.models.ContentFilterResultsForChoice
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContentFilterResultsForChoice>
public final class ContentFilterResultsForChoice extends Object implements com.azure.json.JsonSerializable<ContentFilterResultsForChoice>
Information about content filtering evaluated against generated model output.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContentFilterResultsForChoice
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterResultsForChoice from the JsonReader.
    ContentFilterDetailedResults
    getCustomBlocklists()
    Get the customBlocklists property: Describes detection results against configured custom blocklists.
    com.azure.core.models.ResponseError
    getError()
    Get the error property: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.
    ContentFilterResult
    getHate()
    Get the hate property: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.
    ContentFilterDetectionResult
    getProfanity()
    Get the profanity property: Describes whether profanity was detected.
    ContentFilterCitedDetectionResult
    getProtectedMaterialCode()
    Get the protectedMaterialCode property: Information about detection of protected code material.
    ContentFilterDetectionResult
    getProtectedMaterialText()
    Get the protectedMaterialText property: Information about detection of protected text material.
    ContentFilterResult
    getSelfHarm()
    Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
    ContentFilterResult
    getSexual()
    Get the sexual property: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse.
    ContentFilterCompletionTextSpanResult
    getUngroundedMaterial()
    Get the ungroundedMaterial property: Information about detection of ungrounded material.
    ContentFilterResult
    getViolence()
    Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
    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

    • getSexual

      public ContentFilterResult getSexual()
      Get the sexual property: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse.
      Returns:
      the sexual value.

    • getViolence

      public ContentFilterResult getViolence()
      Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
      Returns:
      the violence value.

    • getHate

      public ContentFilterResult getHate()
      Get the hate property: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.
      Returns:
      the hate value.

    • getSelfHarm

      public ContentFilterResult getSelfHarm()
      Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
      Returns:
      the selfHarm value.

    • getProfanity

      public ContentFilterDetectionResult getProfanity()
      Get the profanity property: Describes whether profanity was detected.
      Returns:
      the profanity value.

    • getCustomBlocklists

      public ContentFilterDetailedResults getCustomBlocklists()
      Get the customBlocklists property: Describes detection results against configured custom blocklists.
      Returns:
      the customBlocklists value.

    • getError

      public com.azure.core.models.ResponseError getError()
      Get the error property: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.
      Returns:
      the error value.

    • getProtectedMaterialText

      public ContentFilterDetectionResult getProtectedMaterialText()
      Get the protectedMaterialText property: Information about detection of protected text material.
      Returns:
      the protectedMaterialText value.

    • getProtectedMaterialCode

      public ContentFilterCitedDetectionResult getProtectedMaterialCode()
      Get the protectedMaterialCode property: Information about detection of protected code material.
      Returns:
      the protectedMaterialCode value.

    • toJson

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

    • fromJson

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

    • getUngroundedMaterial

      public ContentFilterCompletionTextSpanResult getUngroundedMaterial()
      Get the ungroundedMaterial property: Information about detection of ungrounded material.
      Returns:
      the ungroundedMaterial value.