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

Interface DetectEntitiesResponse.Builder

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

  • Method Details

    • entities

      DetectEntitiesResponse.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 that Amazon Comprehend Medical has 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 that Amazon Comprehend Medical has 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

      DetectEntitiesResponse.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 that Amazon Comprehend Medical has 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 that Amazon Comprehend Medical has 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

      DetectEntitiesResponse.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 that Amazon Comprehend Medical has 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

      DetectEntitiesResponse.Builder unmappedAttributes(Collection<UnmappedAttribute> unmappedAttributes)

      Attributes extracted from the input text that we were unable to relate to an entity.

      Parameters:
      unmappedAttributes - Attributes extracted from the input text that we were unable to relate to an entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unmappedAttributes

      DetectEntitiesResponse.Builder unmappedAttributes(UnmappedAttribute... unmappedAttributes)

      Attributes extracted from the input text that we were unable to relate to an entity.

      Parameters:
      unmappedAttributes - Attributes extracted from the input text that we were unable to relate to an entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • unmappedAttributes

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

      Attributes extracted from the input text that we were unable to relate 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

      DetectEntitiesResponse.Builder paginationToken(String paginationToken)

      If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.

      Parameters:
      paginationToken - If the result of the previous request to DetectEntities 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

      DetectEntitiesResponse.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.