software.amazon.awssdk.services.bedrockruntime.model.SystemContentBlock 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.List;
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;
/**
*
* A system content block.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SystemContentBlock implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TEXT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("text")
.getter(getter(SystemContentBlock::text)).setter(setter(Builder::text))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("text").build()).build();
private static final SdkField GUARD_CONTENT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("guardContent")
.getter(getter(SystemContentBlock::guardContent)).setter(setter(Builder::guardContent))
.constructor(GuardrailConverseContentBlock::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("guardContent").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEXT_FIELD,
GUARD_CONTENT_FIELD));
private static final long serialVersionUID = 1L;
private final String text;
private final GuardrailConverseContentBlock guardContent;
private final Type type;
private SystemContentBlock(BuilderImpl builder) {
this.text = builder.text;
this.guardContent = builder.guardContent;
this.type = builder.type;
}
/**
*
* A system prompt for the model.
*
*
* @return A system prompt for the model.
*/
public final String text() {
return text;
}
/**
*
* A content block to assess with the guardrail. Use with the Converse or ConverseStream
* API operations.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* @return A content block to assess with the guardrail. Use with the Converse or
*
* ConverseStream API operations.
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*/
public final GuardrailConverseContentBlock guardContent() {
return guardContent;
}
@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(text());
hashCode = 31 * hashCode + Objects.hashCode(guardContent());
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 SystemContentBlock)) {
return false;
}
SystemContentBlock other = (SystemContentBlock) obj;
return Objects.equals(text(), other.text()) && Objects.equals(guardContent(), other.guardContent());
}
/**
* 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("SystemContentBlock").add("Text", text()).add("GuardContent", guardContent()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "text":
return Optional.ofNullable(clazz.cast(text()));
case "guardContent":
return Optional.ofNullable(clazz.cast(guardContent()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #text()} initialized to the given value.
*
*
* A system prompt for the model.
*
*
* @param text
* A system prompt for the model.
*/
public static SystemContentBlock fromText(String text) {
return builder().text(text).build();
}
/**
* Create an instance of this class with {@link #guardContent()} initialized to the given value.
*
*
* A content block to assess with the guardrail. Use with the Converse or ConverseStream
* API operations.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* @param guardContent
* A content block to assess with the guardrail. Use with the Converse or
*
* ConverseStream API operations.
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*/
public static SystemContentBlock fromGuardContent(GuardrailConverseContentBlock guardContent) {
return builder().guardContent(guardContent).build();
}
/**
* Create an instance of this class with {@link #guardContent()} initialized to the given value.
*
*
* A content block to assess with the guardrail. Use with the Converse or ConverseStream
* API operations.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* @param guardContent
* A content block to assess with the guardrail. Use with the Converse or
*
* ConverseStream API operations.
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*/
public static SystemContentBlock fromGuardContent(Consumer guardContent) {
GuardrailConverseContentBlock.Builder builder = GuardrailConverseContentBlock.builder();
guardContent.accept(builder);
return fromGuardContent(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;
}
private static Function getter(Function g) {
return obj -> g.apply((SystemContentBlock) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A system prompt for the model.
*
*
* @param text
* A system prompt for the model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder text(String text);
/**
*
* A content block to assess with the guardrail. Use with the Converse or ConverseStream
* API operations.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*
*
* @param guardContent
* A content block to assess with the guardrail. Use with the Converse
* or
* ConverseStream API operations.
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder guardContent(GuardrailConverseContentBlock guardContent);
/**
*
* A content block to assess with the guardrail. Use with the Converse or ConverseStream
* API operations.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*
* This is a convenience method that creates an instance of the {@link GuardrailConverseContentBlock.Builder}
* avoiding the need to create one manually via {@link GuardrailConverseContentBlock#builder()}.
*
*
* When the {@link Consumer} completes, {@link GuardrailConverseContentBlock.Builder#build()} is called
* immediately and its result is passed to {@link #guardContent(GuardrailConverseContentBlock)}.
*
* @param guardContent
* a consumer that will call methods on {@link GuardrailConverseContentBlock.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #guardContent(GuardrailConverseContentBlock)
*/
default Builder guardContent(Consumer guardContent) {
return guardContent(GuardrailConverseContentBlock.builder().applyMutation(guardContent).build());
}
}
static final class BuilderImpl implements Builder {
private String text;
private GuardrailConverseContentBlock guardContent;
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(SystemContentBlock model) {
text(model.text);
guardContent(model.guardContent);
}
public final String getText() {
return text;
}
public final void setText(String text) {
Object oldValue = this.text;
this.text = text;
handleUnionValueChange(Type.TEXT, oldValue, this.text);
}
@Override
public final Builder text(String text) {
Object oldValue = this.text;
this.text = text;
handleUnionValueChange(Type.TEXT, oldValue, this.text);
return this;
}
public final GuardrailConverseContentBlock.Builder getGuardContent() {
return guardContent != null ? guardContent.toBuilder() : null;
}
public final void setGuardContent(GuardrailConverseContentBlock.BuilderImpl guardContent) {
Object oldValue = this.guardContent;
this.guardContent = guardContent != null ? guardContent.build() : null;
handleUnionValueChange(Type.GUARD_CONTENT, oldValue, this.guardContent);
}
@Override
public final Builder guardContent(GuardrailConverseContentBlock guardContent) {
Object oldValue = this.guardContent;
this.guardContent = guardContent;
handleUnionValueChange(Type.GUARD_CONTENT, oldValue, this.guardContent);
return this;
}
@Override
public SystemContentBlock build() {
return new SystemContentBlock(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
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 SystemContentBlock#type()
*/
public enum Type {
TEXT,
GUARD_CONTENT,
UNKNOWN_TO_SDK_VERSION
}
}