io.github.sashirestela.openai.common.tool.Tool Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of simple-openai Show documentation

A Java library to use the OpenAI API in the simplest possible way.

There is a newer version: 3.9.2

package io.github.sashirestela.openai.common.tool;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.JsonNode;
import io.github.sashirestela.openai.common.function.FunctionDef;
import io.github.sashirestela.slimvalidator.constraints.Required;
import io.github.sashirestela.slimvalidator.constraints.Size;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.ToString;

@AllArgsConstructor
@NoArgsConstructor
@Getter
@ToString
@JsonInclude(JsonInclude.Include.NON_NULL)
public class Tool {

    protected ToolType type;
    protected ToolFunctionDef function;

    public static Tool function(FunctionDef function) {
        return new Tool(ToolType.FUNCTION,
                new ToolFunctionDef(
                        function.getName(),
                        function.getDescription(),
                        function.getSchemaConverter().convert(function.getFunctionalClass()),
                        function.getStrict()));
    }

    @AllArgsConstructor
    @NoArgsConstructor
    @Getter
    @ToString
    @JsonInclude(JsonInclude.Include.NON_NULL)
    public static class ToolFunctionDef {

        @Required
        @Size(max = 64)
        private String name;

        private String description;

        @Required
        private JsonNode parameters;

        private Boolean strict;

    }

}