Interface Attribute.Builder

    • Method Detail

      • score

        Attribute.Builder score​(Float score)

        The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

        Parameters:
        score - The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • relationshipScore

        Attribute.Builder relationshipScore​(Float relationshipScore)

        The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

        Parameters:
        relationshipScore - The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • relationshipType

        Attribute.Builder relationshipType​(String relationshipType)

        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

        Parameters:
        relationshipType - The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RelationshipType, RelationshipType
      • relationshipType

        Attribute.Builder relationshipType​(RelationshipType relationshipType)

        The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.

        Parameters:
        relationshipType - The type of relationship between the entity and attribute. Type for the relationship is OVERLAP, indicating that the entity occurred at the same time as the Date_Expression.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        RelationshipType, RelationshipType
      • id

        Attribute.Builder id​(Integer id)

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

        Parameters:
        id - The numeric identifier for this attribute. 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.
      • beginOffset

        Attribute.Builder beginOffset​(Integer beginOffset)

        The 0-based character offset in the input text that shows where the attribute 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 attribute 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

        Attribute.Builder endOffset​(Integer endOffset)

        The 0-based character offset in the input text that shows where the attribute 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 attribute 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.
      • text

        Attribute.Builder text​(String text)

        The segment of input text extracted as this attribute.

        Parameters:
        text - The segment of input text extracted as this attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • category

        Attribute.Builder category​(String category)

        The category of attribute.

        Parameters:
        category - The category of attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EntityType, EntityType
      • category

        Attribute.Builder category​(EntityType category)

        The category of attribute.

        Parameters:
        category - The category of attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EntityType, EntityType
      • traits

        Attribute.Builder traits​(Collection<Trait> traits)

        Contextual information for this attribute.

        Parameters:
        traits - Contextual information for this attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traits

        Attribute.Builder traits​(Trait... traits)

        Contextual information for this attribute.

        Parameters:
        traits - Contextual information for this attribute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • traits

        Attribute.Builder traits​(Consumer<Trait.Builder>... traits)

        Contextual information for this attribute.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #traits(List).

        Parameters:
        traits - a consumer that will call methods on Trait.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #traits(java.util.Collection)