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

Interface DetectPhiResponse.Builder

    • Method Detail

      • entities

        DetectPhiResponse.Builder entities​(Collection<Entity> entities)

        The collection of PHI 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 its detection.

        Parameters:
        entities - The collection of PHI 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 its detection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entities

        DetectPhiResponse.Builder entities​(Entity... entities)

        The collection of PHI 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 its detection.

        Parameters:
        entities - The collection of PHI 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 its detection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • entities

        DetectPhiResponse.Builder entities​(Consumer<Entity.Builder>... entities)

        The collection of PHI 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 its detection.

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

        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:
        #entities(java.util.Collection)

      • paginationToken

        DetectPhiResponse.Builder paginationToken​(String paginationToken)

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

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

      • modelVersion

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