com.amazonaws.services.qbusiness.model

Class TextSegment

java.lang.Object

com.amazonaws.services.qbusiness.model.TextSegment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides information about a text extract in a chat response that can be attributed to a source document.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextSegment()

Method Summary

Modifier and Type	Method and Description
TextSegment	clone()
boolean	equals(Object obj)
Integer	getBeginOffset() The zero-based location in the response string where the source attribution starts.
Integer	getEndOffset() The zero-based location in the response string where the source attribution ends.
SnippetExcerpt	getSnippetExcerpt() The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBeginOffset(Integer beginOffset) The zero-based location in the response string where the source attribution starts.
void	setEndOffset(Integer endOffset) The zero-based location in the response string where the source attribution ends.
void	setSnippetExcerpt(SnippetExcerpt snippetExcerpt) The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
String	toString() Returns a string representation of this object.
TextSegment	withBeginOffset(Integer beginOffset) The zero-based location in the response string where the source attribution starts.
TextSegment	withEndOffset(Integer endOffset) The zero-based location in the response string where the source attribution ends.
TextSegment	withSnippetExcerpt(SnippetExcerpt snippetExcerpt) The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextSegment

public TextSegment()

Method Detail

setBeginOffset

public void setBeginOffset(Integer beginOffset)

The zero-based location in the response string where the source attribution starts.

Parameters:

beginOffset - The zero-based location in the response string where the source attribution starts.

getBeginOffset

public Integer getBeginOffset()

The zero-based location in the response string where the source attribution starts.

Returns:

The zero-based location in the response string where the source attribution starts.

withBeginOffset

public TextSegment withBeginOffset(Integer beginOffset)

The zero-based location in the response string where the source attribution starts.

Parameters:

beginOffset - The zero-based location in the response string where the source attribution starts.

Returns:

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

setEndOffset

public void setEndOffset(Integer endOffset)

The zero-based location in the response string where the source attribution ends.

Parameters:

endOffset - The zero-based location in the response string where the source attribution ends.

getEndOffset

public Integer getEndOffset()

The zero-based location in the response string where the source attribution ends.

Returns:

The zero-based location in the response string where the source attribution ends.

withEndOffset

public TextSegment withEndOffset(Integer endOffset)

The zero-based location in the response string where the source attribution ends.

Parameters:

endOffset - The zero-based location in the response string where the source attribution ends.

Returns:

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

setSnippetExcerpt

public void setSnippetExcerpt(SnippetExcerpt snippetExcerpt)

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Parameters:

snippetExcerpt - The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

getSnippetExcerpt

public SnippetExcerpt getSnippetExcerpt()

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Returns:

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

withSnippetExcerpt

public TextSegment withSnippetExcerpt(SnippetExcerpt snippetExcerpt)

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Parameters:

snippetExcerpt - The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat 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 TextSegment 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.