Package software.amazon.awssdk.services.bedrockruntime.model

Interface OutputFormat.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OutputFormat.Builder,OutputFormat>, SdkBuilder<OutputFormat.Builder,OutputFormat>, SdkPojo

Enclosing class:

OutputFormat

@Mutable
@NotThreadSafe
public static interface OutputFormat.Builder
extends SdkPojo, CopyableBuilder<OutputFormat.Builder,OutputFormat>

Method Summary

Modifier and Type	Method	Description
default OutputFormat.Builder	structure(Consumer<OutputFormatStructure.Builder> structure)	The structure that the model's output must adhere to.
OutputFormat.Builder	structure(OutputFormatStructure structure)	The structure that the model's output must adhere to.
OutputFormat.Builder	type(String type)	The type of structured output format.
OutputFormat.Builder	type(OutputFormatType type)	The type of structured output format.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

type

OutputFormat.Builder type(String type)

The type of structured output format.

Parameters:

type - The type of structured output format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OutputFormatType
• OutputFormatType

type

OutputFormat.Builder type(OutputFormatType type)

The type of structured output format.

Parameters:

type - The type of structured output format.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• OutputFormatType
• OutputFormatType

structure

OutputFormat.Builder structure(OutputFormatStructure structure)

The structure that the model's output must adhere to.

Parameters:

structure - The structure that the model's output must adhere to.

Returns:

Returns a reference to this object so that method calls can be chained together.

structure

default OutputFormat.Builder structure(Consumer<OutputFormatStructure.Builder> structure)

The structure that the model's output must adhere to.

This is a convenience method that creates an instance of the OutputFormatStructure.Builder avoiding the need to create one manually via OutputFormatStructure.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to structure(OutputFormatStructure).

Parameters:

structure - a consumer that will call methods on OutputFormatStructure.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• structure(OutputFormatStructure)