Class RecognizePiiEntitiesOptions
- java.lang.Object
-
- com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
-
- com.azure.ai.textanalytics.models.RecognizePiiEntitiesOptions
-
public final class RecognizePiiEntitiesOptions extends TextAnalyticsRequestOptions
TheRecognizePiiEntitiesOptions
model.
-
-
Constructor Summary
Constructors Constructor Description RecognizePiiEntitiesOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterable<PiiEntityCategory>
getCategoriesFilter()
Gets the value of categoriesFilter.PiiEntityDomain
getDomainFilter()
Gets the value of domainFilter.boolean
isServiceLogsDisabled()
Gets the value of service logs disable status.RecognizePiiEntitiesOptions
setCategoriesFilter(PiiEntityCategory... categoriesFilter)
Sets the value of categoriesFilter.RecognizePiiEntitiesOptions
setDomainFilter(PiiEntityDomain domainFilter)
Sets the value of domainFilter.RecognizePiiEntitiesOptions
setIncludeStatistics(boolean includeStatistics)
Sets the value ofincludeStatistics
.RecognizePiiEntitiesOptions
setModelVersion(String modelVersion)
Sets the model version.RecognizePiiEntitiesOptions
setServiceLogsDisabled(boolean disableServiceLogs)
Sets the value of service logs disable status.-
Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
getModelVersion, isIncludeStatistics
-
-
-
-
Method Detail
-
setModelVersion
public RecognizePiiEntitiesOptions setModelVersion(String modelVersion)
Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". If a model-version is not specified, the API will default to the latest, non-preview version.- Overrides:
setModelVersion
in classTextAnalyticsRequestOptions
- Parameters:
modelVersion
- The model version.- Returns:
- The
RecognizePiiEntitiesOptions
object itself.
-
setIncludeStatistics
public RecognizePiiEntitiesOptions setIncludeStatistics(boolean includeStatistics)
Sets the value ofincludeStatistics
. The default value is false by default. If set to true, indicates that the service should return document and document batch statistics with the results of the operation.- Overrides:
setIncludeStatistics
in classTextAnalyticsRequestOptions
- Parameters:
includeStatistics
- If a boolean value was specified in the request this field will contain information about the document payload.- Returns:
- The
RecognizePiiEntitiesOptions
object itself.
-
isServiceLogsDisabled
public boolean isServiceLogsDisabled()
Gets the value of service logs disable status. The default value of this property is 'true'. This means, Text Analytics service won't log your input text. Setting this property to 'false', enables logging your input text for 48 hours, solely to allow for troubleshooting issues.- Overrides:
isServiceLogsDisabled
in classTextAnalyticsRequestOptions
- Returns:
- true if service logging of input text is disabled.
-
setServiceLogsDisabled
public RecognizePiiEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs)
Sets the value of service logs disable status.- Overrides:
setServiceLogsDisabled
in classTextAnalyticsRequestOptions
- Parameters:
disableServiceLogs
- The default value of this property is 'true'. This means, Text Analytics service does not log your input text. Setting this property to 'false', enables the service to log your text input for 48 hours, solely to allow for troubleshooting issues.- Returns:
- The
RecognizePiiEntitiesOptions
object itself.
-
getDomainFilter
public PiiEntityDomain getDomainFilter()
Gets the value of domainFilter. It filters the response entities to ones only included in the specified domain. I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. See https://aka.ms/tanerpii for more information.- Returns:
- The value of domainFilter.
-
setDomainFilter
public RecognizePiiEntitiesOptions setDomainFilter(PiiEntityDomain domainFilter)
Sets the value of domainFilter. It filters the response entities to ones only included in the specified domain. I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. See https://aka.ms/tanerpii for more information.- Parameters:
domainFilter
- It filters the response entities to ones only included in the specified domain.- Returns:
- The
RecognizePiiEntitiesOptions
object itself.
-
getCategoriesFilter
public Iterable<PiiEntityCategory> getCategoriesFilter()
Gets the value of categoriesFilter. It filters the response entities to ones only included in the specified categories.- Returns:
- The value of categoriesFilter.
-
setCategoriesFilter
public RecognizePiiEntitiesOptions setCategoriesFilter(PiiEntityCategory... categoriesFilter)
Sets the value of categoriesFilter. It filters the response entities to ones only included in the specified categories.- Parameters:
categoriesFilter
- It filters the response entities to ones only included in the specified categories.- Returns:
- The
RecognizePiiEntitiesOptions
object itself.
-
-