bedrockruntime/aws.sdk.kotlin.services.bedrockruntime.model/ConverseRequest/Builder

Builder

Properties

var additionalModelRequestFields: Document?

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse and ConverseStream support in the inferenceConfig field. For more information, see Model parameters.

additionalModelResponseFieldPaths

var additionalModelResponseFieldPaths: List<String>?

Additional model parameters field paths to return in the response. Converse and ConverseStream return the requested fields as a JSON Pointer object in the additionalModelResponseFields field. The following is example JSON for additionalModelResponseFieldPaths.

guardrailConfig

var guardrailConfig: GuardrailConfiguration?

Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

inferenceConfig

var inferenceConfig: InferenceConfiguration?

Inference parameters to pass to the model. Converse and ConverseStream support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

messages

var messages: List<Message>?

The messages that you want to send to the model.

modelId

var modelId: String?

Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource that you use:

performanceConfig

var performanceConfig: PerformanceConfiguration?

Model performance settings for the request.

promptVariables

var 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