Constructor Detail

Method Detail

• fileCitation

   final Optional<ResponseOutputText.Annotation.FileCitation> fileCitation()

  A citation to a file.

• urlCitation

   final Optional<ResponseOutputText.Annotation.UrlCitation> urlCitation()

  A citation for a web resource used to generate a model response.

• containerFileCitation

   final Optional<ResponseOutputText.Annotation.ContainerFileCitation> containerFileCitation()

  A citation for a container file used to generate a model response.

• filePath

   final Optional<ResponseOutputText.Annotation.FilePath> filePath()

  A path to a file.

• isFileCitation

   final Boolean isFileCitation()

• isUrlCitation

   final Boolean isUrlCitation()

• isContainerFileCitation

   final Boolean isContainerFileCitation()

• isFilePath

   final Boolean isFilePath()

• asFileCitation

   final ResponseOutputText.Annotation.FileCitation asFileCitation()

  A citation to a file.

• asUrlCitation

   final ResponseOutputText.Annotation.UrlCitation asUrlCitation()

  A citation for a web resource used to generate a model response.

• asContainerFileCitation

   final ResponseOutputText.Annotation.ContainerFileCitation asContainerFileCitation()

  A citation for a container file used to generate a model response.

• asFilePath

   final ResponseOutputText.Annotation.FilePath asFilePath()

  A path to a file.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ResponseOutputText.Annotation.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import com.openai.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = annotation.accept(new Annotation.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitFileCitation(FileCitation fileCitation) {
          return Optional.of(fileCitation.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final ResponseOutputText.Annotation validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofFileCitation

   final static ResponseOutputText.Annotation ofFileCitation(ResponseOutputText.Annotation.FileCitation fileCitation)

  A citation to a file.

• ofUrlCitation

   final static ResponseOutputText.Annotation ofUrlCitation(ResponseOutputText.Annotation.UrlCitation urlCitation)

  A citation for a web resource used to generate a model response.

• ofContainerFileCitation

   final static ResponseOutputText.Annotation ofContainerFileCitation(ResponseOutputText.Annotation.ContainerFileCitation containerFileCitation)

  A citation for a container file used to generate a model response.

• ofFilePath

   final static ResponseOutputText.Annotation ofFilePath(ResponseOutputText.Annotation.FilePath filePath)

  A path to a file.