software.amazon.awssdk.services.bedrockruntime.model.ToolChoice Maven / Gradle / Ivy
Show all versions of bedrockruntime Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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 software.amazon.awssdk.services.bedrockruntime.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Determines which tools the model should request in a call to Converse or ConverseStream.
* ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ToolChoice implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField AUTO_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("auto").getter(getter(ToolChoice::auto)).setter(setter(Builder::auto))
.constructor(AutoToolChoice::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("auto").build()).build();
private static final SdkField ANY_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("any").getter(getter(ToolChoice::any)).setter(setter(Builder::any)).constructor(AnyToolChoice::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("any").build()).build();
private static final SdkField TOOL_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("tool").getter(getter(ToolChoice::tool))
.setter(setter(Builder::tool)).constructor(SpecificToolChoice::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tool").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTO_FIELD, ANY_FIELD,
TOOL_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("auto", AUTO_FIELD);
put("any", ANY_FIELD);
put("tool", TOOL_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final AutoToolChoice auto;
private final AnyToolChoice any;
private final SpecificToolChoice tool;
private final Type type;
private ToolChoice(BuilderImpl builder) {
this.auto = builder.auto;
this.any = builder.any;
this.tool = builder.tool;
this.type = builder.type;
}
/**
*
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*
*
* @return (Default). The Model automatically decides if a tool should be called or whether to generate text
* instead.
*/
public final AutoToolChoice auto() {
return auto;
}
/**
*
* The model must request at least one tool (no text is generated).
*
*
* @return The model must request at least one tool (no text is generated).
*/
public final AnyToolChoice any() {
return any;
}
/**
*
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*
*
* @return The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*/
public final SpecificToolChoice tool() {
return tool;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(auto());
hashCode = 31 * hashCode + Objects.hashCode(any());
hashCode = 31 * hashCode + Objects.hashCode(tool());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ToolChoice)) {
return false;
}
ToolChoice other = (ToolChoice) obj;
return Objects.equals(auto(), other.auto()) && Objects.equals(any(), other.any()) && Objects.equals(tool(), other.tool());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("ToolChoice").add("Auto", auto()).add("Any", any()).add("Tool", tool()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "auto":
return Optional.ofNullable(clazz.cast(auto()));
case "any":
return Optional.ofNullable(clazz.cast(any()));
case "tool":
return Optional.ofNullable(clazz.cast(tool()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #auto()} initialized to the given value.
*
*
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*
*
* @param auto
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*/
public static ToolChoice fromAuto(AutoToolChoice auto) {
return builder().auto(auto).build();
}
/**
* Create an instance of this class with {@link #auto()} initialized to the given value.
*
*
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*
*
* @param auto
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*/
public static ToolChoice fromAuto(Consumer auto) {
AutoToolChoice.Builder builder = AutoToolChoice.builder();
auto.accept(builder);
return fromAuto(builder.build());
}
/**
* Create an instance of this class with {@link #any()} initialized to the given value.
*
*
* The model must request at least one tool (no text is generated).
*
*
* @param any
* The model must request at least one tool (no text is generated).
*/
public static ToolChoice fromAny(AnyToolChoice any) {
return builder().any(any).build();
}
/**
* Create an instance of this class with {@link #any()} initialized to the given value.
*
*
* The model must request at least one tool (no text is generated).
*
*
* @param any
* The model must request at least one tool (no text is generated).
*/
public static ToolChoice fromAny(Consumer any) {
AnyToolChoice.Builder builder = AnyToolChoice.builder();
any.accept(builder);
return fromAny(builder.build());
}
/**
* Create an instance of this class with {@link #tool()} initialized to the given value.
*
*
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*
*
* @param tool
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*/
public static ToolChoice fromTool(SpecificToolChoice tool) {
return builder().tool(tool).build();
}
/**
* Create an instance of this class with {@link #tool()} initialized to the given value.
*
*
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*
*
* @param tool
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*/
public static ToolChoice fromTool(Consumer tool) {
SpecificToolChoice.Builder builder = SpecificToolChoice.builder();
tool.accept(builder);
return fromTool(builder.build());
}
/**
* Retrieve an enum value representing which member of this object is populated.
*
* When this class is returned in a service response, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if the
* service returned a member that is only known to a newer SDK version.
*
* When this class is created directly in your code, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if zero
* members are set, and {@code null} if more than one member is set.
*/
public Type type() {
return type;
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ToolChoice) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*
*
* @param auto
* (Default). The Model automatically decides if a tool should be called or whether to generate text
* instead.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder auto(AutoToolChoice auto);
/**
*
* (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
*
* This is a convenience method that creates an instance of the {@link AutoToolChoice.Builder} avoiding the need
* to create one manually via {@link AutoToolChoice#builder()}.
*
*
* When the {@link Consumer} completes, {@link AutoToolChoice.Builder#build()} is called immediately and its
* result is passed to {@link #auto(AutoToolChoice)}.
*
* @param auto
* a consumer that will call methods on {@link AutoToolChoice.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #auto(AutoToolChoice)
*/
default Builder auto(Consumer auto) {
return auto(AutoToolChoice.builder().applyMutation(auto).build());
}
/**
*
* The model must request at least one tool (no text is generated).
*
*
* @param any
* The model must request at least one tool (no text is generated).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder any(AnyToolChoice any);
/**
*
* The model must request at least one tool (no text is generated).
*
* This is a convenience method that creates an instance of the {@link AnyToolChoice.Builder} avoiding the need
* to create one manually via {@link AnyToolChoice#builder()}.
*
*
* When the {@link Consumer} completes, {@link AnyToolChoice.Builder#build()} is called immediately and its
* result is passed to {@link #any(AnyToolChoice)}.
*
* @param any
* a consumer that will call methods on {@link AnyToolChoice.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #any(AnyToolChoice)
*/
default Builder any(Consumer any) {
return any(AnyToolChoice.builder().applyMutation(any).build());
}
/**
*
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*
*
* @param tool
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tool(SpecificToolChoice tool);
/**
*
* The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
*
* This is a convenience method that creates an instance of the {@link SpecificToolChoice.Builder} avoiding the
* need to create one manually via {@link SpecificToolChoice#builder()}.
*
*
* When the {@link Consumer} completes, {@link SpecificToolChoice.Builder#build()} is called immediately and its
* result is passed to {@link #tool(SpecificToolChoice)}.
*
* @param tool
* a consumer that will call methods on {@link SpecificToolChoice.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tool(SpecificToolChoice)
*/
default Builder tool(Consumer tool) {
return tool(SpecificToolChoice.builder().applyMutation(tool).build());
}
}
static final class BuilderImpl implements Builder {
private AutoToolChoice auto;
private AnyToolChoice any;
private SpecificToolChoice tool;
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(ToolChoice model) {
auto(model.auto);
any(model.any);
tool(model.tool);
}
public final AutoToolChoice.Builder getAuto() {
return auto != null ? auto.toBuilder() : null;
}
public final void setAuto(AutoToolChoice.BuilderImpl auto) {
Object oldValue = this.auto;
this.auto = auto != null ? auto.build() : null;
handleUnionValueChange(Type.AUTO, oldValue, this.auto);
}
@Override
public final Builder auto(AutoToolChoice auto) {
Object oldValue = this.auto;
this.auto = auto;
handleUnionValueChange(Type.AUTO, oldValue, this.auto);
return this;
}
public final AnyToolChoice.Builder getAny() {
return any != null ? any.toBuilder() : null;
}
public final void setAny(AnyToolChoice.BuilderImpl any) {
Object oldValue = this.any;
this.any = any != null ? any.build() : null;
handleUnionValueChange(Type.ANY, oldValue, this.any);
}
@Override
public final Builder any(AnyToolChoice any) {
Object oldValue = this.any;
this.any = any;
handleUnionValueChange(Type.ANY, oldValue, this.any);
return this;
}
public final SpecificToolChoice.Builder getTool() {
return tool != null ? tool.toBuilder() : null;
}
public final void setTool(SpecificToolChoice.BuilderImpl tool) {
Object oldValue = this.tool;
this.tool = tool != null ? tool.build() : null;
handleUnionValueChange(Type.TOOL, oldValue, this.tool);
}
@Override
public final Builder tool(SpecificToolChoice tool) {
Object oldValue = this.tool;
this.tool = tool;
handleUnionValueChange(Type.TOOL, oldValue, this.tool);
return this;
}
@Override
public ToolChoice build() {
return new ToolChoice(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private final void handleUnionValueChange(Type type, Object oldValue, Object newValue) {
if (this.type == type || oldValue == newValue) {
return;
}
if (newValue == null || newValue instanceof SdkAutoConstructList || newValue instanceof SdkAutoConstructMap) {
setTypes.remove(type);
} else if (oldValue == null || oldValue instanceof SdkAutoConstructList || oldValue instanceof SdkAutoConstructMap) {
setTypes.add(type);
}
if (setTypes.size() == 1) {
this.type = setTypes.iterator().next();
} else if (setTypes.isEmpty()) {
this.type = Type.UNKNOWN_TO_SDK_VERSION;
} else {
this.type = null;
}
}
}
/**
* @see ToolChoice#type()
*/
public enum Type {
AUTO,
ANY,
TOOL,
UNKNOWN_TO_SDK_VERSION
}
}