Package software.amazon.awssdk.services.qbusiness.model

Interface TextSegment.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TextSegment.Builder,TextSegment>, SdkBuilder<TextSegment.Builder,TextSegment>, SdkPojo

Enclosing class:

TextSegment

public static interface TextSegment.Builder
extends SdkPojo, CopyableBuilder<TextSegment.Builder,TextSegment>

Method Summary

Modifier and Type	Method	Description
TextSegment.Builder	beginOffset(Integer beginOffset)	The zero-based location in the response string where the source attribution starts.
TextSegment.Builder	endOffset(Integer endOffset)	The zero-based location in the response string where the source attribution ends.
default TextSegment.Builder	snippetExcerpt(Consumer<SnippetExcerpt.Builder> snippetExcerpt)	The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
TextSegment.Builder	snippetExcerpt(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 interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

beginOffset

TextSegment.Builder beginOffset(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.

endOffset

TextSegment.Builder endOffset(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.

snippetExcerpt

TextSegment.Builder snippetExcerpt(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.

snippetExcerpt

default TextSegment.Builder snippetExcerpt(Consumer<SnippetExcerpt.Builder> snippetExcerpt)

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

This is a convenience method that creates an instance of the SnippetExcerpt.Builder avoiding the need to create one manually via SnippetExcerpt.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to snippetExcerpt(SnippetExcerpt).

Parameters:

snippetExcerpt - a consumer that will call methods on SnippetExcerpt.Builder

Returns:

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

See Also:

snippetExcerpt(SnippetExcerpt)