com.amazonaws.services.bedrockagentruntime.model

Class KnowledgeBaseRetrievalResult

java.lang.Object

com.amazonaws.services.bedrockagentruntime.model.KnowledgeBaseRetrievalResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Result item returned from a knowledge base retrieval.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
KnowledgeBaseRetrievalResult()

Method Summary

Modifier and Type	Method and Description
KnowledgeBaseRetrievalResult	clone()
boolean	equals(Object obj)
RetrievalResultContent	getContent()
RetrievalResultLocation	getLocation()
Double	getScore() The relevance score of a result.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContent(RetrievalResultContent content)
void	setLocation(RetrievalResultLocation location)
void	setScore(Double score) The relevance score of a result.
String	toString() Returns a string representation of this object.
KnowledgeBaseRetrievalResult	withContent(RetrievalResultContent content)
KnowledgeBaseRetrievalResult	withLocation(RetrievalResultLocation location)
KnowledgeBaseRetrievalResult	withScore(Double score) The relevance score of a result.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KnowledgeBaseRetrievalResult

public KnowledgeBaseRetrievalResult()

Method Detail

setContent

public void setContent(RetrievalResultContent content)

Parameters:

content -

getContent

public RetrievalResultContent getContent()

Returns:

withContent

public KnowledgeBaseRetrievalResult withContent(RetrievalResultContent content)

Parameters:

content -

Returns:

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

setLocation

public void setLocation(RetrievalResultLocation location)

Parameters:

location -

getLocation

public RetrievalResultLocation getLocation()

Returns:

withLocation

public KnowledgeBaseRetrievalResult withLocation(RetrievalResultLocation location)

Parameters:

location -

Returns:

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

setScore

public void setScore(Double score)

The relevance score of a result.

Parameters:

score - The relevance score of a result.

getScore

public Double getScore()

The relevance score of a result.

Returns:

The relevance score of a result.

withScore

public KnowledgeBaseRetrievalResult withScore(Double score)

The relevance score of a result.

Parameters:

score - The relevance score of a result.

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