Package com.azure.ai.openai.models

Class ContentFilterCompletionTextSpanResult

java.lang.Object
com.azure.ai.openai.models.ContentFilterCompletionTextSpanResult
All Implemented Interfaces:
com.azure.json.JsonSerializable<ContentFilterCompletionTextSpanResult>
public final class ContentFilterCompletionTextSpanResult extends Object implements com.azure.json.JsonSerializable<ContentFilterCompletionTextSpanResult>
Describes a span within generated completion text.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ContentFilterCompletionTextSpanResult
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ContentFilterCompletionTextSpanResult from the JsonReader.
    List<ContentFilterCompletionTextSpan>
    getDetails()
    Get the details property: The collection of completion text spans.
    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.

    • getDetails

      public List<ContentFilterCompletionTextSpan> getDetails()
      Get the details property: The collection of completion text spans.
      Returns:
      the details value.

    • toJson

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

    • fromJson

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