com.amazonaws.services.bedrockagentruntime.model

Class TextResponsePart

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.TextResponsePart

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TextResponsePart
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains the part of the generated text that contains a citation, alongside where it begins and ends.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the textResponsePart field

• InvokeAgent response – in the textResponsePart field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextResponsePart()

Method Summary

Modifier and Type	Method and Description
TextResponsePart	clone()
boolean	equals(Object obj)
Span	getSpan() Contains information about where the text with a citation begins and ends in the generated output.
String	getText() The part of the generated text that contains a citation.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setSpan(Span span) Contains information about where the text with a citation begins and ends in the generated output.
void	setText(String text) The part of the generated text that contains a citation.
String	toString() Returns a string representation of this object.
TextResponsePart	withSpan(Span span) Contains information about where the text with a citation begins and ends in the generated output.
TextResponsePart	withText(String text) The part of the generated text that contains a citation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextResponsePart

public TextResponsePart()

Method Detail

setSpan

public void setSpan(Span span)

Contains information about where the text with a citation begins and ends in the generated output.

Parameters:

span - Contains information about where the text with a citation begins and ends in the generated output.

getSpan

public Span getSpan()

Contains information about where the text with a citation begins and ends in the generated output.

Returns:

Contains information about where the text with a citation begins and ends in the generated output.

withSpan

public TextResponsePart withSpan(Span span)

Contains information about where the text with a citation begins and ends in the generated output.

Parameters:

span - Contains information about where the text with a citation begins and ends in the generated output.

Returns:

Returns a reference to this object so that method calls can be chained together.

setText

public void setText(String text)

The part of the generated text that contains a citation.

Parameters:

text - The part of the generated text that contains a citation.

getText

public String getText()

The part of the generated text that contains a citation.

Returns:

The part of the generated text that contains a citation.

withText

public TextResponsePart withText(String text)

The part of the generated text that contains a citation.

Parameters:

text - The part of the generated text that contains a citation.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public TextResponsePart clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.