com.amazonaws.services.bedrockagentruntime.model

Class Citation

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.Citation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.

This data type is used in the following API operations:

• InvokeAgent response – in the citations field

• RetrieveAndGenerate response – in the citations field

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Citation()

Method Summary

Modifier and Type	Method and Description
Citation	clone()
boolean	equals(Object obj)
GeneratedResponsePart	getGeneratedResponsePart() Contains the generated response and metadata
List<RetrievedReference>	getRetrievedReferences() Contains metadata about the sources cited for the generated response.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setGeneratedResponsePart(GeneratedResponsePart generatedResponsePart) Contains the generated response and metadata
void	setRetrievedReferences(Collection<RetrievedReference> retrievedReferences) Contains metadata about the sources cited for the generated response.
String	toString() Returns a string representation of this object.
Citation	withGeneratedResponsePart(GeneratedResponsePart generatedResponsePart) Contains the generated response and metadata
Citation	withRetrievedReferences(Collection<RetrievedReference> retrievedReferences) Contains metadata about the sources cited for the generated response.
Citation	withRetrievedReferences(RetrievedReference... retrievedReferences) Contains metadata about the sources cited for the generated response.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Citation

public Citation()

Method Detail

setGeneratedResponsePart

public void setGeneratedResponsePart(GeneratedResponsePart generatedResponsePart)

Contains the generated response and metadata

Parameters:

generatedResponsePart - Contains the generated response and metadata

getGeneratedResponsePart

public GeneratedResponsePart getGeneratedResponsePart()

Contains the generated response and metadata

Returns:

Contains the generated response and metadata

withGeneratedResponsePart

public Citation withGeneratedResponsePart(GeneratedResponsePart generatedResponsePart)

Contains the generated response and metadata

Parameters:

generatedResponsePart - Contains the generated response and metadata

Returns:

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

getRetrievedReferences

public List<RetrievedReference> getRetrievedReferences()

Contains metadata about the sources cited for the generated response.

Returns:

Contains metadata about the sources cited for the generated response.

setRetrievedReferences

public void setRetrievedReferences(Collection<RetrievedReference> retrievedReferences)

Contains metadata about the sources cited for the generated response.

Parameters:

retrievedReferences - Contains metadata about the sources cited for the generated response.

withRetrievedReferences

public Citation withRetrievedReferences(RetrievedReference... retrievedReferences)

Contains metadata about the sources cited for the generated response.

NOTE: This method appends the values to the existing list (if any). Use setRetrievedReferences(java.util.Collection) or withRetrievedReferences(java.util.Collection) if you want to override the existing values.

Parameters:

retrievedReferences - Contains metadata about the sources cited for the generated response.

Returns:

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

withRetrievedReferences

public Citation withRetrievedReferences(Collection<RetrievedReference> retrievedReferences)

Contains metadata about the sources cited for the generated response.

Parameters:

retrievedReferences - Contains metadata about the sources cited for the generated response.

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 Citation 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.