commonMain.dev.shreyaspatil.ai.client.generativeai.common.Response.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common Show documentation

Google's Generative AI Multiplatform SDK

The newest version!

/*
 * Copyright 2024 Shreyas Patil
 *
 * 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 dev.shreyaspatil.ai.client.generativeai.common

import dev.shreyaspatil.ai.client.generativeai.common.server.Candidate
import dev.shreyaspatil.ai.client.generativeai.common.server.GRpcError
import dev.shreyaspatil.ai.client.generativeai.common.server.PromptFeedback
import kotlinx.serialization.Serializable

sealed interface Response

@Serializable
data class GenerateContentResponse(
    val candidates: List? = null,
    val promptFeedback: PromptFeedback? = null,
    val usageMetadata: UsageMetadata? = null,
) : Response

@Serializable
data class CountTokensResponse(val totalTokens: Int, val totalBillableCharacters: Int? = null) :
    Response

@Serializable data class GRpcErrorResponse(val error: GRpcError) : Response

@Serializable
data class UsageMetadata(
    val promptTokenCount: Int? = null,
    val candidatesTokenCount: Int? = null,
    val totalTokenCount: Int? = null,
)