commonMain.event.Events.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
There is a newer version: 0.13
Show 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.event

import com.xemantic.ai.anthropic.message.MessageResponse
import com.xemantic.ai.anthropic.message.StopReason
import kotlinx.serialization.ExperimentalSerializationApi
import kotlinx.serialization.SerialName
import kotlinx.serialization.Serializable
import kotlinx.serialization.json.JsonClassDiscriminator

// reference https://docs.spring.io/spring-ai/reference/_images/anthropic-claude3-events-model.jpg

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

  @Serializable
  @SerialName("message_start")
  data class MessageStart(
    val message: MessageResponse
  ) : Event()

  @Serializable
  @SerialName("message_delta")
  data class MessageDelta(
    val delta: Delta,
    val usage: Usage
  ) : Event() {

    @Serializable
    data class Delta(
      @SerialName("stop_reason")
      val stopReason: StopReason,
      @SerialName("stop_sequence")
      val stopSequence: String? // TODO is that correct?
    )

    @Serializable
    data class Usage(
      @SerialName("output_tokens")
      val outputTokens: Int
    )

  }

  @Serializable
  @SerialName("message_stop")
  class MessageStop : Event() {
    override fun toString(): String = "MessageStop"
  }

  @Serializable
  @SerialName("content_block_start")
  data class ContentBlockStart(
    val index: Int,
    @SerialName("content_block")
    val contentBlock: ContentBlock
  ) : Event()

  @Serializable
  @SerialName("content_block_stop")
  data class ContentBlockStop(
    val index: Int
  ) : Event()

  @Serializable
  @SerialName("ping")
  class Ping: Event() {
    override fun toString(): String = "Ping"
  }

  @Serializable
  @SerialName("content_block_delta")
  data class ContentBlockDelta(
    val index: Int,
    val delta: Delta
  ) : Event()

}





// TODO error event is missing, should we rename all of these to events?



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

  @Serializable
  @SerialName("text")
  class Text(
    val text: String
  ) : ContentBlock()

  @Serializable
  @SerialName("tool_use")
  class ToolUse(
    val text: String // TODO tool_id
  ) : ContentBlock()

}



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

  @Serializable
  @SerialName("text_delta")
  data class TextDelta(
    val text: String
  ) : Delta()

}