commonMain.tool.Tools.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of anthropic-sdk-kotlin-jvm Show documentation
Kotlin multiplatform client for accessing Ahtropic APIs
The newest version!
/*
 * Copyright 2024 Kazimierz Pogoda / Xemantic
 *
 * 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.
 */

package com.xemantic.ai.anthropic.tool

import com.xemantic.ai.tool.schema.JsonSchema
import com.xemantic.ai.tool.schema.generator.jsonSchemaOf
import com.xemantic.ai.tool.schema.meta.Description
import com.xemantic.ai.anthropic.anthropicJson
import com.xemantic.ai.anthropic.cache.CacheControl
import com.xemantic.ai.anthropic.content.Content
import com.xemantic.ai.anthropic.content.ToolResult
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.InternalSerializationApi
import kotlinx.serialization.KSerializer
import kotlinx.serialization.MetaSerializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.SerializationException
import kotlinx.serialization.Transient
import kotlinx.serialization.json.JsonClassDiscriminator
import kotlinx.serialization.serializer
import kotlinx.serialization.serializerOrNull

@Serializable
@JsonClassDiscriminator("name")
@OptIn(ExperimentalSerializationApi::class)
abstract class Tool {

  abstract val name: String
  abstract val description: String?
  abstract val inputSchema: JsonSchema?
  abstract val cacheControl: CacheControl?

  @Transient
  @PublishedApi
  internal lateinit var inputSerializer: KSerializer

  @Transient
  @PublishedApi
  internal lateinit var inputInitializer: ToolInput.() -> Unit

}

@Serializable
@PublishedApi
internal data class DefaultTool(
  override val name: String,
  override val description: String? = null,
  @SerialName("input_schema")
  override val inputSchema: JsonSchema? = null,
  @SerialName("cache_control")
  override val cacheControl: CacheControl? = null
) : Tool()

@Serializable
abstract class BuiltInTool(
  override val name: String,
  val type: String,
  override val description: String? = null,
  @SerialName("input_schema")
  override val inputSchema: JsonSchema? = null,
  @SerialName("cache_control")
  override val cacheControl: CacheControl? = null
) : Tool()

/**
 * Interface for tools that can be used in the context of the Anthropic API.
 *
 * Classes implementing this interface represent tools that can be executed
 * with a given tool use ID. The implementation of the [use] method should
 * contain the logic for executing the tool and returning the [ToolResult].
 */
@Serializable
abstract class ToolInput {

  @Transient
  private var block: suspend ToolResult.Builder.() -> Any? = {}

  fun use(block: suspend ToolResult.Builder.() -> Any?) {
    this.block = block
  }

  /**
   * Executes the tool and returns the result.
   *
   * @param toolUseId A unique identifier for this particular use of the tool.
   * @return A [ToolResult] containing the outcome of executing the tool.
   */
  // TODO this needs a big test coverage
  suspend fun use(toolUseId: String): ToolResult {
    return ToolResult {
      this.toolUseId = toolUseId
      val result = block(this)
      if ((result != null) && (result !is Unit)) {
        if (result is Content) {
          +result
        } else {
          @OptIn(InternalSerializationApi::class)
          val serializer = result::class.serializerOrNull() as KSerializer?
          val value = if (serializer != null) {
            anthropicJson.encodeToString(serializer, result)
          } else {
            result.toString()
          }
          +value
        }
      }
    }
  }

}

inline fun  toolName(): String = serializer().name()

@OptIn(ExperimentalSerializationApi::class)
@PublishedApi
internal inline fun  KSerializer.name() = (
    descriptor
      .annotations
      .filterIsInstance()
      .firstOrNull() ?: throw SerializationException(
        "The ${T::class} must be annotated with @AnthropicTool"
      )
).name

/**
 * Annotation used to mark a class extending the [ToolInput].
 *
 * This annotation provides metadata for tools that can be serialized and used in the context
 * of the Anthropic API. It includes a name and description for the tool.
 *
 * @property name The name of the tool. This name is used during serialization and should be a unique identifier for the tool.
 */
@OptIn(ExperimentalSerializationApi::class)
@MetaSerializable
@Target(AnnotationTarget.CLASS)
annotation class AnthropicTool(
  val name: String
)

@OptIn(ExperimentalSerializationApi::class)
inline fun  Tool(
  cacheControl: CacheControl? = null,
  noinline initializer: T.() -> Unit = {}
): Tool {

  val serializer = try {
    serializer()
  } catch (e: SerializationException) {
    throw SerializationException(
      "Cannot find serializer for ${T::class}, " +
          "make sure that it is annotated with @AnthropicTool and " +
          "kotlin.serialization plugin is enabled for the project",
      e
    )
  }

  val toolName = toolName()
  val description = serializer
    .descriptor
    .annotations
    .filterIsInstance()
    .firstOrNull()
    ?.value

  return DefaultTool(
    name = toolName,
    description = description,
    inputSchema = jsonSchemaOf(suppressDescription = true),
    cacheControl = cacheControl
  ).apply {
    @Suppress("UNCHECKED_CAST")
    inputSerializer = serializer as KSerializer
    @Suppress("UNCHECKED_CAST")
    inputInitializer = initializer as ToolInput.() -> Unit
  }

}

@Serializable
@JsonClassDiscriminator("type")
@OptIn(ExperimentalSerializationApi::class)
sealed class ToolChoice {

  abstract val disableParallelToolUse: Boolean?

  @Serializable
  @SerialName("auto")
  class Auto(
    @SerialName("disable_parallel_tool_use")
    override val disableParallelToolUse: Boolean? = null
  ) : ToolChoice()

  @Serializable
  @SerialName("any")
  class Any(
    @SerialName("disable_parallel_tool_use")
    override val disableParallelToolUse: Boolean? = null
  ) : ToolChoice()

  @Serializable
  @SerialName("tool")
  class Tool(
    val name: String,
    @SerialName("disable_parallel_tool_use")
    override val disableParallelToolUse: Boolean? = null
  ) : ToolChoice()

}