dev.ai4j.openai4j.shared.StreamOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openai4j Show documentation

Java Client for OpenAI (ChatGPT)

There is a newer version: 0.25.0

package dev.ai4j.openai4j.shared;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.PropertyNamingStrategies;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonNaming;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;

import java.util.Objects;

@JsonDeserialize(builder = StreamOptions.Builder.class)
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
public final class StreamOptions {

    @JsonProperty
    private final Boolean includeUsage;

    public StreamOptions(Builder builder) {
        this.includeUsage = builder.includeUsage;
    }

    public Boolean includeUsage() {
        return includeUsage;
    }

    @Override
    public boolean equals(Object another) {
        if (this == another) return true;
        return another instanceof StreamOptions
                && equalTo((StreamOptions) another);
    }

    private boolean equalTo(StreamOptions another) {
        return Objects.equals(includeUsage, another.includeUsage);
    }

    @Override
    public int hashCode() {
        int h = 5381;
        h += (h << 5) + Objects.hashCode(includeUsage);
        return h;
    }

    @Override
    public String toString() {
        return "StreamOptions{" +
                "includeUsage=" + includeUsage +
                "}";
    }

    public static StreamOptions.Builder builder() {
        return new StreamOptions.Builder();
    }

    @JsonPOJOBuilder(withPrefix = "")
    @JsonIgnoreProperties(ignoreUnknown = true)
    @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
    public static class Builder {

        private Boolean includeUsage;

        public StreamOptions.Builder includeUsage(Boolean includeUsage) {
            this.includeUsage = includeUsage;
            return this;
        }

        public StreamOptions build() {
            return new StreamOptions(this);
        }
    }
}