software.amazon.awssdk.services.comprehendmedical.model

Interface RxNormEntity.Builder

All Superinterfaces:

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

Enclosing class:

RxNormEntity

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

Method Summary

Modifier and Type	Method and Description
RxNormEntity.Builder	attributes(Collection<RxNormAttribute> attributes) The extracted attributes that relate to the entity.
RxNormEntity.Builder	attributes(Consumer<RxNormAttribute.Builder>... attributes) The extracted attributes that relate to the entity.
RxNormEntity.Builder	attributes(RxNormAttribute... attributes) The extracted attributes that relate to the entity.
RxNormEntity.Builder	beginOffset(Integer beginOffset) The 0-based character offset in the input text that shows where the entity begins.
RxNormEntity.Builder	category(RxNormEntityCategory category) The category of the entity.
RxNormEntity.Builder	category(String category) The category of the entity.
RxNormEntity.Builder	endOffset(Integer endOffset) The 0-based character offset in the input text that shows where the entity ends.
RxNormEntity.Builder	id(Integer id) The numeric identifier for the entity.
RxNormEntity.Builder	rxNormConcepts(Collection<RxNormConcept> rxNormConcepts) The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
RxNormEntity.Builder	rxNormConcepts(Consumer<RxNormConcept.Builder>... rxNormConcepts) The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
RxNormEntity.Builder	rxNormConcepts(RxNormConcept... rxNormConcepts) The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
RxNormEntity.Builder	score(Float score) The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
RxNormEntity.Builder	text(String text) The segment of input text extracted from which the entity was detected.
RxNormEntity.Builder	traits(Collection<RxNormTrait> traits) Contextual information for the entity.
RxNormEntity.Builder	traits(Consumer<RxNormTrait.Builder>... traits) Contextual information for the entity.
RxNormEntity.Builder	traits(RxNormTrait... traits) Contextual information for the entity.
RxNormEntity.Builder	type(RxNormEntityType type) Describes the specific type of entity.
RxNormEntity.Builder	type(String type) Describes the specific type of entity.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

id

RxNormEntity.Builder id(Integer id)

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Parameters:

id - The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

Returns:

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

text

RxNormEntity.Builder text(String text)

The segment of input text extracted from which the entity was detected.

Parameters:

text - The segment of input text extracted from which the entity was detected.

Returns:

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

category

RxNormEntity.Builder category(String category)

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Parameters:

category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Returns:

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

See Also:

RxNormEntityCategory, RxNormEntityCategory

category

RxNormEntity.Builder category(RxNormEntityCategory category)

The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Parameters:

category - The category of the entity. The recognized categories are GENERIC or BRAND_NAME.

Returns:

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

See Also:

RxNormEntityCategory, RxNormEntityCategory

type

RxNormEntity.Builder type(String type)

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION .

Parameters:

type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

Returns:

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

See Also:

RxNormEntityType, RxNormEntityType

type

RxNormEntity.Builder type(RxNormEntityType type)

Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION .

Parameters:

type - Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.

Returns:

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

See Also:

RxNormEntityType, RxNormEntityType

score

RxNormEntity.Builder score(Float score)

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Parameters:

score - The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.

Returns:

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

beginOffset

RxNormEntity.Builder beginOffset(Integer beginOffset)

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Parameters:

beginOffset - The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

Returns:

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

endOffset

RxNormEntity.Builder endOffset(Integer endOffset)

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Parameters:

endOffset - The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

Returns:

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

attributes

RxNormEntity.Builder attributes(Collection<RxNormAttribute> attributes)

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

Parameters:

attributes - The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

Returns:

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

attributes

RxNormEntity.Builder attributes(RxNormAttribute... attributes)

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

Parameters:

attributes - The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

Returns:

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

attributes

RxNormEntity.Builder attributes(Consumer<RxNormAttribute.Builder>... attributes)

The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are DOSAGE, DURATION, FORM, FREQUENCY, RATE, ROUTE_OR_MODE, and STRENGTH.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #attributes(List).

Parameters:

attributes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#attributes(List)

traits

RxNormEntity.Builder traits(Collection<RxNormTrait> traits)

Contextual information for the entity.

Parameters:

traits - Contextual information for the entity.

Returns:

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

traits

RxNormEntity.Builder traits(RxNormTrait... traits)

Contextual information for the entity.

Parameters:

traits - Contextual information for the entity.

Returns:

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

traits

RxNormEntity.Builder traits(Consumer<RxNormTrait.Builder>... traits)

Contextual information for the entity.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #traits(List).

Parameters:

traits - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#traits(List)

rxNormConcepts

RxNormEntity.Builder rxNormConcepts(Collection<RxNormConcept> rxNormConcepts)

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Parameters:

rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Returns:

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

rxNormConcepts

RxNormEntity.Builder rxNormConcepts(RxNormConcept... rxNormConcepts)

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Parameters:

rxNormConcepts - The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

Returns:

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

rxNormConcepts

RxNormEntity.Builder rxNormConcepts(Consumer<RxNormConcept.Builder>... rxNormConcepts)

The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.

This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #rxNormConcepts(List).

Parameters:

rxNormConcepts - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#rxNormConcepts(List)