io.quarkiverse.presidio.runtime.Analyzer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-presidio Show documentation

The newest version!

package io.quarkiverse.presidio.runtime;

import java.util.List;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.Response;

import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import io.quarkiverse.presidio.runtime.model.AnalyzeRequest;
import io.quarkiverse.presidio.runtime.model.RecognizerResultWithAnaysisExplanation;

/**
 * Presidio
 * 
 * Context aware, pluggable and customizable PII anonymization service for text and images.
 * 
 */
@Path("")
@RegisterRestClient(configKey = "presidio-analyzer")
public interface Analyzer {

    /**
     * Analyze Text
     *
     * Recognizes PII entities in a given text and returns their types, locations and score
     *
     * @param analyzeRequest
     */
    @POST
    @Path("/analyze")
    List analyzePost(
            AnalyzeRequest analyzeRequest

    );

    /**
     * Healthcheck
     *
     */
    @GET
    @Path("/health")
    @Produces({ "text/plain" })
    Response healthGet(

    );

    /**
     * Get Recognizers
     *
     * Get the available PII recognizers for a given language
     *
     * @param language Two characters for the desired language in ISO_639-1 format
     */
    @GET
    @Path("/recognizers")

    List recognizersGet(
            @QueryParam("language") String language);

    /**
     * Get supported entities
     *
     * Get the list of PII entities Presidio-Analyzer is capable of detecting
     *
     * @param language Two characters for the desired language in ISO_639-1 format
     */
    @GET
    @Path("/supportedentities")
    List supportedentitiesGet(
            @QueryParam("language") String language);

}