commonMain.aws.sdk.kotlin.services.bedrockagent.model.ToolInputSchema.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bedrockagent-jvm Show documentation

The AWS SDK for Kotlin client for Bedrock Agent

There is a newer version: 1.3.77

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.bedrockagent.model

import aws.smithy.kotlin.runtime.content.Document

/**
 * The input schema for the tool. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
 */
public sealed class ToolInputSchema {
    /**
     * A JSON object defining the input schema for the tool.
     */
    public data class Json(val value: aws.smithy.kotlin.runtime.content.Document) : aws.sdk.kotlin.services.bedrockagent.model.ToolInputSchema() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.bedrockagent.model.ToolInputSchema() {
    }

    /**
     * Casts this [ToolInputSchema] as a [Json] and retrieves its [aws.smithy.kotlin.runtime.content.Document] value. Throws an exception if the [ToolInputSchema] is not a
     * [Json].
     */
    public fun asJson(): aws.smithy.kotlin.runtime.content.Document = (this as ToolInputSchema.Json).value

    /**
     * Casts this [ToolInputSchema] as a [Json] and retrieves its [aws.smithy.kotlin.runtime.content.Document] value. Returns null if the [ToolInputSchema] is not a [Json].
     */
    public fun asJsonOrNull(): aws.smithy.kotlin.runtime.content.Document? = (this as? ToolInputSchema.Json)?.value
}