software.amazon.awssdk.services.bedrockagent.model.PromptVariant Maven / Gradle / Ivy
Show all versions of bedrockagent 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.bedrockagent.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about a variant of the prompt.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PromptVariant implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField INFERENCE_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("inferenceConfiguration")
.getter(getter(PromptVariant::inferenceConfiguration)).setter(setter(Builder::inferenceConfiguration))
.constructor(PromptInferenceConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("inferenceConfiguration").build())
.build();
private static final SdkField MODEL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("modelId").getter(getter(PromptVariant::modelId)).setter(setter(Builder::modelId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("modelId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(PromptVariant::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField TEMPLATE_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("templateConfiguration")
.getter(getter(PromptVariant::templateConfiguration)).setter(setter(Builder::templateConfiguration))
.constructor(PromptTemplateConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("templateConfiguration").build())
.build();
private static final SdkField TEMPLATE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("templateType").getter(getter(PromptVariant::templateTypeAsString)).setter(setter(Builder::templateType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("templateType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INFERENCE_CONFIGURATION_FIELD,
MODEL_ID_FIELD, NAME_FIELD, TEMPLATE_CONFIGURATION_FIELD, TEMPLATE_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final PromptInferenceConfiguration inferenceConfiguration;
private final String modelId;
private final String name;
private final PromptTemplateConfiguration templateConfiguration;
private final String templateType;
private PromptVariant(BuilderImpl builder) {
this.inferenceConfiguration = builder.inferenceConfiguration;
this.modelId = builder.modelId;
this.name = builder.name;
this.templateConfiguration = builder.templateConfiguration;
this.templateType = builder.templateType;
}
/**
*
* Contains inference configurations for the prompt variant.
*
*
* @return Contains inference configurations for the prompt variant.
*/
public final PromptInferenceConfiguration inferenceConfiguration() {
return inferenceConfiguration;
}
/**
*
* The unique identifier of the model with which to run inference on the prompt.
*
*
* @return The unique identifier of the model with which to run inference on the prompt.
*/
public final String modelId() {
return modelId;
}
/**
*
* The name of the prompt variant.
*
*
* @return The name of the prompt variant.
*/
public final String name() {
return name;
}
/**
*
* Contains configurations for the prompt template.
*
*
* @return Contains configurations for the prompt template.
*/
public final PromptTemplateConfiguration templateConfiguration() {
return templateConfiguration;
}
/**
*
* The type of prompt template to use.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #templateType} will
* return {@link PromptTemplateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #templateTypeAsString}.
*
*
* @return The type of prompt template to use.
* @see PromptTemplateType
*/
public final PromptTemplateType templateType() {
return PromptTemplateType.fromValue(templateType);
}
/**
*
* The type of prompt template to use.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #templateType} will
* return {@link PromptTemplateType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #templateTypeAsString}.
*
*
* @return The type of prompt template to use.
* @see PromptTemplateType
*/
public final String templateTypeAsString() {
return templateType;
}
@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(inferenceConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(modelId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(templateConfiguration());
hashCode = 31 * hashCode + Objects.hashCode(templateTypeAsString());
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 PromptVariant)) {
return false;
}
PromptVariant other = (PromptVariant) obj;
return Objects.equals(inferenceConfiguration(), other.inferenceConfiguration())
&& Objects.equals(modelId(), other.modelId()) && Objects.equals(name(), other.name())
&& Objects.equals(templateConfiguration(), other.templateConfiguration())
&& Objects.equals(templateTypeAsString(), other.templateTypeAsString());
}
/**
* 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("PromptVariant").add("InferenceConfiguration", inferenceConfiguration())
.add("ModelId", modelId()).add("Name", name()).add("TemplateConfiguration", templateConfiguration())
.add("TemplateType", templateTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "inferenceConfiguration":
return Optional.ofNullable(clazz.cast(inferenceConfiguration()));
case "modelId":
return Optional.ofNullable(clazz.cast(modelId()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "templateConfiguration":
return Optional.ofNullable(clazz.cast(templateConfiguration()));
case "templateType":
return Optional.ofNullable(clazz.cast(templateTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PromptVariant) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Contains inference configurations for the prompt variant.
*
*
* @param inferenceConfiguration
* Contains inference configurations for the prompt variant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration);
/**
*
* Contains inference configurations for the prompt variant.
*
* This is a convenience method that creates an instance of the {@link PromptInferenceConfiguration.Builder}
* avoiding the need to create one manually via {@link PromptInferenceConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link PromptInferenceConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #inferenceConfiguration(PromptInferenceConfiguration)}.
*
* @param inferenceConfiguration
* a consumer that will call methods on {@link PromptInferenceConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #inferenceConfiguration(PromptInferenceConfiguration)
*/
default Builder inferenceConfiguration(Consumer inferenceConfiguration) {
return inferenceConfiguration(PromptInferenceConfiguration.builder().applyMutation(inferenceConfiguration).build());
}
/**
*
* The unique identifier of the model with which to run inference on the prompt.
*
*
* @param modelId
* The unique identifier of the model with which to run inference on the prompt.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder modelId(String modelId);
/**
*
* The name of the prompt variant.
*
*
* @param name
* The name of the prompt variant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* Contains configurations for the prompt template.
*
*
* @param templateConfiguration
* Contains configurations for the prompt template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateConfiguration(PromptTemplateConfiguration templateConfiguration);
/**
*
* Contains configurations for the prompt template.
*
* This is a convenience method that creates an instance of the {@link PromptTemplateConfiguration.Builder}
* avoiding the need to create one manually via {@link PromptTemplateConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link PromptTemplateConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #templateConfiguration(PromptTemplateConfiguration)}.
*
* @param templateConfiguration
* a consumer that will call methods on {@link PromptTemplateConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #templateConfiguration(PromptTemplateConfiguration)
*/
default Builder templateConfiguration(Consumer templateConfiguration) {
return templateConfiguration(PromptTemplateConfiguration.builder().applyMutation(templateConfiguration).build());
}
/**
*
* The type of prompt template to use.
*
*
* @param templateType
* The type of prompt template to use.
* @see PromptTemplateType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PromptTemplateType
*/
Builder templateType(String templateType);
/**
*
* The type of prompt template to use.
*
*
* @param templateType
* The type of prompt template to use.
* @see PromptTemplateType
* @return Returns a reference to this object so that method calls can be chained together.
* @see PromptTemplateType
*/
Builder templateType(PromptTemplateType templateType);
}
static final class BuilderImpl implements Builder {
private PromptInferenceConfiguration inferenceConfiguration;
private String modelId;
private String name;
private PromptTemplateConfiguration templateConfiguration;
private String templateType;
private BuilderImpl() {
}
private BuilderImpl(PromptVariant model) {
inferenceConfiguration(model.inferenceConfiguration);
modelId(model.modelId);
name(model.name);
templateConfiguration(model.templateConfiguration);
templateType(model.templateType);
}
public final PromptInferenceConfiguration.Builder getInferenceConfiguration() {
return inferenceConfiguration != null ? inferenceConfiguration.toBuilder() : null;
}
public final void setInferenceConfiguration(PromptInferenceConfiguration.BuilderImpl inferenceConfiguration) {
this.inferenceConfiguration = inferenceConfiguration != null ? inferenceConfiguration.build() : null;
}
@Override
public final Builder inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration) {
this.inferenceConfiguration = inferenceConfiguration;
return this;
}
public final String getModelId() {
return modelId;
}
public final void setModelId(String modelId) {
this.modelId = modelId;
}
@Override
public final Builder modelId(String modelId) {
this.modelId = modelId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final PromptTemplateConfiguration.Builder getTemplateConfiguration() {
return templateConfiguration != null ? templateConfiguration.toBuilder() : null;
}
public final void setTemplateConfiguration(PromptTemplateConfiguration.BuilderImpl templateConfiguration) {
this.templateConfiguration = templateConfiguration != null ? templateConfiguration.build() : null;
}
@Override
public final Builder templateConfiguration(PromptTemplateConfiguration templateConfiguration) {
this.templateConfiguration = templateConfiguration;
return this;
}
public final String getTemplateType() {
return templateType;
}
public final void setTemplateType(String templateType) {
this.templateType = templateType;
}
@Override
public final Builder templateType(String templateType) {
this.templateType = templateType;
return this;
}
@Override
public final Builder templateType(PromptTemplateType templateType) {
this.templateType(templateType == null ? null : templateType.toString());
return this;
}
@Override
public PromptVariant build() {
return new PromptVariant(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}