com.amazonaws.services.bedrockruntime.model.ContentBlock Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 com.amazonaws.services.bedrockruntime.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API
* operations.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ContentBlock implements Serializable, Cloneable, StructuredPojo {
/**
*
* Text to include in the message.
*
*/
private String text;
/**
*
* Image to include in the message.
*
*
*
* This field is only supported by Anthropic Claude 3 models.
*
*
*/
private ImageBlock image;
/**
*
* A document to include in the message.
*
*/
private DocumentBlock document;
/**
*
* The result for a tool request that a model makes.
*
*/
private ToolResultBlock toolResult;
/**
*
* Contains the content to assess with the guardrail. If you don't specify guardContent in a call to
* the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* </p>
*
*/
private GuardrailConverseContentBlock guardContent;
/**
*
* Text to include in the message.
*
*
* @param text
* Text to include in the message.
*/
public void setText(String text) {
this.text = text;
}
/**
*
* Text to include in the message.
*
*
* @return Text to include in the message.
*/
public String getText() {
return this.text;
}
/**
*
* Text to include in the message.
*
*
* @param text
* Text to include in the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContentBlock withText(String text) {
setText(text);
return this;
}
/**
*
* Image to include in the message.
*
*
*
* This field is only supported by Anthropic Claude 3 models.
*
*
*
* @param image
* Image to include in the message.
*
* This field is only supported by Anthropic Claude 3 models.
*
*/
public void setImage(ImageBlock image) {
this.image = image;
}
/**
*
* Image to include in the message.
*
*
*
* This field is only supported by Anthropic Claude 3 models.
*
*
*
* @return Image to include in the message.
*
* This field is only supported by Anthropic Claude 3 models.
*
*/
public ImageBlock getImage() {
return this.image;
}
/**
*
* Image to include in the message.
*
*
*
* This field is only supported by Anthropic Claude 3 models.
*
*
*
* @param image
* Image to include in the message.
*
* This field is only supported by Anthropic Claude 3 models.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContentBlock withImage(ImageBlock image) {
setImage(image);
return this;
}
/**
*
* A document to include in the message.
*
*
* @param document
* A document to include in the message.
*/
public void setDocument(DocumentBlock document) {
this.document = document;
}
/**
*
* A document to include in the message.
*
*
* @return A document to include in the message.
*/
public DocumentBlock getDocument() {
return this.document;
}
/**
*
* A document to include in the message.
*
*
* @param document
* A document to include in the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContentBlock withDocument(DocumentBlock document) {
setDocument(document);
return this;
}
/**
*
* The result for a tool request that a model makes.
*
*
* @param toolResult
* The result for a tool request that a model makes.
*/
public void setToolResult(ToolResultBlock toolResult) {
this.toolResult = toolResult;
}
/**
*
* The result for a tool request that a model makes.
*
*
* @return The result for a tool request that a model makes.
*/
public ToolResultBlock getToolResult() {
return this.toolResult;
}
/**
*
* The result for a tool request that a model makes.
*
*
* @param toolResult
* The result for a tool request that a model makes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContentBlock withToolResult(ToolResultBlock toolResult) {
setToolResult(toolResult);
return this;
}
/**
*
* Contains the content to assess with the guardrail. If you don't specify guardContent in a call to
* the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* </p>
*
*
* @param guardContent
* Contains the content to assess with the guardrail. If you don't specify guardContent in a
* call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*
*
</p>
*/
public void setGuardContent(GuardrailConverseContentBlock guardContent) {
this.guardContent = guardContent;
}
/**
*
* Contains the content to assess with the guardrail. If you don't specify guardContent in a call to
* the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* </p>
*
*
* @return Contains the content to assess with the guardrail. If you don't specify guardContent in a
* call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*
*
</p>
*/
public GuardrailConverseContentBlock getGuardContent() {
return this.guardContent;
}
/**
*
* Contains the content to assess with the guardrail. If you don't specify guardContent in a call to
* the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.
*
*
* </p>
*
*
* @param guardContent
* Contains the content to assess with the guardrail. If you don't specify guardContent in a
* call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
*
*
* For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User
* Guide.
*
*
* </p>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ContentBlock withGuardContent(GuardrailConverseContentBlock guardContent) {
setGuardContent(guardContent);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getText() != null)
sb.append("Text: ").append(getText()).append(",");
if (getImage() != null)
sb.append("Image: ").append(getImage()).append(",");
if (getDocument() != null)
sb.append("Document: ").append(getDocument()).append(",");
if (getToolResult() != null)
sb.append("ToolResult: ").append(getToolResult()).append(",");
if (getGuardContent() != null)
sb.append("GuardContent: ").append(getGuardContent());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ContentBlock == false)
return false;
ContentBlock other = (ContentBlock) obj;
if (other.getText() == null ^ this.getText() == null)
return false;
if (other.getText() != null && other.getText().equals(this.getText()) == false)
return false;
if (other.getImage() == null ^ this.getImage() == null)
return false;
if (other.getImage() != null && other.getImage().equals(this.getImage()) == false)
return false;
if (other.getDocument() == null ^ this.getDocument() == null)
return false;
if (other.getDocument() != null && other.getDocument().equals(this.getDocument()) == false)
return false;
if (other.getToolResult() == null ^ this.getToolResult() == null)
return false;
if (other.getToolResult() != null && other.getToolResult().equals(this.getToolResult()) == false)
return false;
if (other.getGuardContent() == null ^ this.getGuardContent() == null)
return false;
if (other.getGuardContent() != null && other.getGuardContent().equals(this.getGuardContent()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getText() == null) ? 0 : getText().hashCode());
hashCode = prime * hashCode + ((getImage() == null) ? 0 : getImage().hashCode());
hashCode = prime * hashCode + ((getDocument() == null) ? 0 : getDocument().hashCode());
hashCode = prime * hashCode + ((getToolResult() == null) ? 0 : getToolResult().hashCode());
hashCode = prime * hashCode + ((getGuardContent() == null) ? 0 : getGuardContent().hashCode());
return hashCode;
}
@Override
public ContentBlock clone() {
try {
return (ContentBlock) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.bedrockruntime.model.transform.ContentBlockMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}