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

Go to download
/*-
 * #%L
 * promptkt-0.1.0-SNAPSHOT
 * %%
 * Copyright (C) 2023 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

/** General purpose functionality that can be leveraged by an LLM agent or prompt. */
abstract class Tool(
    val name: String,
    val description: String,
    val notes: String? = null,
    val requiresLlm: Boolean = false,
    val isTerminal: Boolean = false
) {
    abstract suspend fun run(input: String): String
}

/** The result of running a tool. */
class ToolResult(val historyText: String, val finalResult: String? = null)