software.amazon.awssdk.services.bedrockagent.model.PromptInferenceConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bedrockagent Show documentation
Show all versions of bedrockagent Show documentation
The AWS Java SDK for Bedrock Agent module holds the client classes that are used for
communicating with Bedrock Agent.
/*
* 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.bedrockagent.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;
/**
*
* Contains inference configurations for the prompt.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PromptInferenceConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TEXT_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("text")
.getter(getter(PromptInferenceConfiguration::text)).setter(setter(Builder::text))
.constructor(PromptModelInferenceConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("text").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEXT_FIELD));
private static final long serialVersionUID = 1L;
private final PromptModelInferenceConfiguration text;
private final Type type;
private PromptInferenceConfiguration(BuilderImpl builder) {
this.text = builder.text;
this.type = builder.type;
}
/**
*
* Contains inference configurations for a text prompt.
*
*
* @return Contains inference configurations for a text prompt.
*/
public final PromptModelInferenceConfiguration text() {
return text;
}
@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());
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 PromptInferenceConfiguration)) {
return false;
}
PromptInferenceConfiguration other = (PromptInferenceConfiguration) obj;
return Objects.equals(text(), other.text());
}
/**
* 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("PromptInferenceConfiguration").add("Text", text()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "text":
return Optional.ofNullable(clazz.cast(text()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #text()} initialized to the given value.
*
*
* Contains inference configurations for a text prompt.
*
*
* @param text
* Contains inference configurations for a text prompt.
*/
public static PromptInferenceConfiguration fromText(PromptModelInferenceConfiguration text) {
return builder().text(text).build();
}
/**
* Create an instance of this class with {@link #text()} initialized to the given value.
*
*
* Contains inference configurations for a text prompt.
*
*
* @param text
* Contains inference configurations for a text prompt.
*/
public static PromptInferenceConfiguration fromText(Consumer text) {
PromptModelInferenceConfiguration.Builder builder = PromptModelInferenceConfiguration.builder();
text.accept(builder);
return fromText(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