tri.ai.tool.JsonTool.kt Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * tri.promptfx:promptkt
 * %%
 * Copyright (C) 2023 - 2024 Johns Hopkins University Applied Physics Laboratory
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package tri.ai.tool

import com.aallam.openai.api.core.Parameters
import kotlinx.serialization.SerializationException
import kotlinx.serialization.json.JsonObject

/** A tool that has an explicit JSON schema description. */
abstract class JsonTool(
    val name: String,
    val description: String,
    val jsonSchema: String
) {
    abstract suspend fun run(input: JsonObject): String

    fun jsonSchemaAsParameters() = try {
        Parameters.fromJsonString(jsonSchema)
    } catch (x: SerializationException) {
        throw RuntimeException("Invalid JSON schema: $jsonSchema", x)
    }

}