prompt-executor-bedrock-client/ai.koog.prompt.executor.clients.bedrock.converse/BedrockConverseParams

BedrockConverseParams

class BedrockConverseParams(temperature: Double? = null, maxTokens: Int? = null, numberOfChoices: Int? = null, speculation: String? = null, schema: LLMParams.Schema? = null, toolChoice: LLMParams.ToolChoice? = null, user: String? = null, additionalProperties: Map<String, JsonElement>? = null, val topP: Double? = null, val stopSequences: List<String>? = null, val performanceConfig: PerformanceConfiguration? = null, val promptVariables: Map<String, PromptVariableValues>? = null, val requestMetadata: Map<String, String>? = null) : LLMParams(source)

Bedrock Converse API parameters layered on top of LLMParams.

AWS docs

Constructors

constructor(temperature: Double? = null, maxTokens: Int? = null, numberOfChoices: Int? = null, speculation: String? = null, schema: LLMParams.Schema? = null, toolChoice: LLMParams.ToolChoice? = null, user: String? = null, additionalProperties: Map<String, JsonElement>? = null, topP: Double? = null, stopSequences: List<String>? = null, performanceConfig: PerformanceConfiguration? = null, promptVariables: Map<String, PromptVariableValues>? = null, requestMetadata: Map<String, String>? = null)

Properties

additionalProperties

val additionalProperties: Map<String, JsonElement>?

maxTokens

val maxTokens: Int?

numberOfChoices

val numberOfChoices: Int?

performanceConfig

val performanceConfig: PerformanceConfiguration?

Model performance settings for the request, such as latency.

promptVariables

val promptVariables: Map<String, PromptVariableValues>?

Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the modelId field.

requestMetadata

val requestMetadata: Map<String, String>?

Key-value pairs that you can use to filter invocation logs. See Converse API docs for limitations.

schema

val schema: LLMParams.Schema?

speculation

val speculation: String?

stopSequences

val stopSequences: List<String>?

Custom text sequences that cause the model to stop generating. If matched, response will have stop_reason of "stop_sequence".

temperature

val temperature: Double?

toolChoice

val toolChoice: LLMParams.ToolChoice?

topP

val topP: Double?

Nucleus sampling in (0.0, 1.0]; use instead of temperature. Cuts off token sampling at a cumulative probability threshold.

user

val user: String?

Functions

component1

operator fun component1(): Double?

component10

operator fun component10(): Map<String, JsonElement>?

component2

operator fun component2(): Int?

component3

operator fun component3(): Int?

component4

operator fun component4(): String?

component5

operator fun component5(): LLMParams.Schema?

component6

operator fun component6(): LLMParams.ToolChoice?

component7

operator fun component7(): String?

copy

fun copy(temperature: Double? = this.temperature, maxTokens: Int? = this.maxTokens, numberOfChoices: Int? = this.numberOfChoices, speculation: String? = this.speculation, schema: LLMParams.Schema? = this.schema, toolChoice: LLMParams.ToolChoice? = this.toolChoice, user: String? = this.user, additionalProperties: Map<String, JsonElement>? = this.additionalProperties, topP: Double? = this.topP, stopSequences: List<String>? = this.stopSequences): BedrockConverseParams

Creates a copy of this instance with the ability to modify any of its properties.

open fun copy(temperature: Double?, maxTokens: Int?, numberOfChoices: Int?, speculation: String?, schema: LLMParams.Schema?, toolChoice: LLMParams.ToolChoice?, user: String?, additionalProperties: Map<String, JsonElement>?): LLMParams

default

fun default(default: LLMParams): LLMParams

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

write$Self

@JvmStatic

fun write$Self(self: LLMParams, output: CompositeEncoder, serialDesc: SerialDescriptor)