Package software.amazon.awssdk.services.comprehendmedical.model

Interface DetectEntitiesV2Response.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, ComprehendMedicalResponse.Builder, CopyableBuilder<DetectEntitiesV2Response.Builder,DetectEntitiesV2Response>, SdkBuilder<DetectEntitiesV2Response.Builder,DetectEntitiesV2Response>, SdkPojo, SdkResponse.Builder
Enclosing class:
DetectEntitiesV2Response
public static interface DetectEntitiesV2Response.Builder extends ComprehendMedicalResponse.Builder, SdkPojo, CopyableBuilder<DetectEntitiesV2Response.Builder,DetectEntitiesV2Response>

  • Method Details

    • entities

      DetectEntitiesV2Response.Builder entities(Collection<Entity> entities)

      The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

      Parameters:
      entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      DetectEntitiesV2Response.Builder entities(Entity... entities)

      The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

      Parameters:
      entities - The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      DetectEntitiesV2Response.Builder entities(Consumer<Entity.Builder>... entities)

      The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entities(List<Entity>).

      Parameters:
      entities - a consumer that will call methods on Entity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unmappedAttributes

      DetectEntitiesV2Response.Builder unmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)

      Attributes extracted from the input text that couldn't be related to an entity.

      Parameters:
      unmappedAttributes - Attributes extracted from the input text that couldn't be related to an entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unmappedAttributes

      DetectEntitiesV2Response.Builder unmappedAttributes(UnmappedAttribute... unmappedAttributes)

      Attributes extracted from the input text that couldn't be related to an entity.

      Parameters:
      unmappedAttributes - Attributes extracted from the input text that couldn't be related to an entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unmappedAttributes

      DetectEntitiesV2Response.Builder unmappedAttributes(Consumer<UnmappedAttribute.Builder>... unmappedAttributes)

      Attributes extracted from the input text that couldn't be related to an entity.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to unmappedAttributes(List<UnmappedAttribute>).

      Parameters:
      unmappedAttributes - a consumer that will call methods on UnmappedAttribute.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • paginationToken

      DetectEntitiesV2Response.Builder paginationToken(String paginationToken)

      If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

      Parameters:
      paginationToken - If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modelVersion

      DetectEntitiesV2Response.Builder modelVersion(String modelVersion)

      The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

      Parameters:
      modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.