Skip to content

Commit

Permalink
#11 Updating documentation links.
Browse files Browse the repository at this point in the history
  • Loading branch information
jzonthemtn committed Oct 24, 2024
1 parent a5ffaf3 commit 3e4e6a5
Show file tree
Hide file tree
Showing 38 changed files with 92 additions and 93 deletions.
6 changes: 3 additions & 3 deletions docs/docs/api_and_sdks/api/alerts_api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Alerts API

The Alerts API provides endpoints for retrieving and deleting alerts. Alerts can optionally be generated when a filter strategy's condition is met. See [Alerts](alerts.md) for more information on Philter alerts.
The Alerts API provides endpoints for retrieving and deleting alerts. Alerts can optionally be generated when a filter strategy's condition is met. See [Alerts](../../other_features/alerts.md) for more information on Philter alerts.

> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](../../settings.md) settings for more information.
> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](settings.md#ssl-tls) settings for more information.
{style="note"}

## Get Alerts

Expand Down
5 changes: 2 additions & 3 deletions docs/docs/api_and_sdks/api/filtering_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@

Philter’s filtering API provides access to Philter’s ability to filter sensitive information from text and to retrieve the health status of Philter.

> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](settings.md#ssl-tls) settings for more information.
{style="note"}
> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](../../settings.md) settings for more information.
Each filter request can optionally have a `context`. When not provided, the context defaults to `none`. Contexts provide a means for logically grouping your documents during filtering. For example, documents pertaining to one health care provider may be submitted under the context `hospital1`, and documents pertaining to another health care provider may be submitted under the context `hospital2`.

The context for each filter request impacts how sensitive information is replaced when found in the text. [Consistent anonymization](anonymization.md) can be enabled at either the context or document level. When enabled at the context level, all instances of a given piece of sensitive information will be replaced consistently by the same value. This allows for maintaining meaning across all documents in the context.
The context for each filter request impacts how sensitive information is replaced when found in the text. [Consistent anonymization](../../other_features/consistent_anonymization.md) can be enabled at either the context or document level. When enabled at the context level, all instances of a given piece of sensitive information will be replaced consistently by the same value. This allows for maintaining meaning across all documents in the context.

Each filter request submitted to Philter is automatically assigned a document identifier. The document identifier is an alphanumeric value unique to that request. No two documents should be assigned the same document identifier. The document identifier is returned in the `x-document-id` header with each `filter` or `explain` API response.

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/api_and_sdks/api/policies_api.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Policies API

The Policies API provides endpoints for retrieving, uploading, and deleting [policies](policies_README.md).
The Policies API provides endpoints for retrieving, uploading, and deleting [policies](../../policies/filter_policies.md).

> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL, and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](../../settings.md) settings for more information.
> The `curl` example commands shown on this page are written assuming Philter has been enabled for SSL and it is using a self-signed certificate. If launched from a cloud marketplace, SSL will be enabled automatically with a self-signed SSL certificate. See the [SSL/TLS ](settings.md#ssl-tls) settings for more information.
{style="note"}

## Get Policy Names

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/howtos/evaluate_performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If your data is not exactly like another customer's data then the metrics will n
We have created this guide to help guide you in evaluating Philter's performance on your data. The guide involves determining the types of sensitive information you want to redact, configuring those filters, optimizing the configuration, and then capturing the performance metrics.

> We will gladly perform these steps for you and provide you a detailed Philter performance report generated from your data. Please contact us to start the process.
{style="note"}

#### What You Need

Expand Down
24 changes: 12 additions & 12 deletions docs/docs/policies/filter_policies.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Filter Policies

The types of sensitive information identified by Phileas and how that information is de-identified are controlled through policies. A policy is a file stored under Phileas’s `policies` directory, which by default is located at `/opt/Phileas/policies/`. You can have an unlimited number of policies.
The types of sensitive information identified by Philter and how that information is de-identified are controlled through policies. A policy is a file stored under Philter’s `policies` directory, which by default is located at `/opt/Philter/policies/`. You can have an unlimited number of policies.

Each policy has a `name` that is used by Phileas to apply the appropriate de-identification methods. The `name` is passed to Phileas’s [API](filtering-api.md) along with the text to be filtered when submitting text to Phileas. This provides flexibility and allows you to de-identify different types of documents in differing manners with a single instance of Phileas. For example, you may have a policy for bankruptcy documents and a separate policy for financial documents.
Each policy has a `name` that is used by Philter to apply the appropriate de-identification methods. The `name` is passed to Philter’s [API](../api_and_sdks/api/filtering_api.md) along with the text to be filtered when submitting text to Philter. This provides flexibility and allows you to de-identify different types of documents in differing manners with a single instance of Philter. For example, you may have a policy for bankruptcy documents and a separate policy for financial documents.

> There are [sample policies](sample_policies) available for immediate use or customization to fit your use-cases.
> There are [sample policies](sample_policies.md) available for immediate use or customization to fit your use-cases.

### The Structure of a Policy
Expand All @@ -13,13 +13,13 @@ A policy:

* Must have a `name` that uniquely identifies it.
* Must have a list of `identifiers` that are filters for sensitive information.
* Each `identifier` , or filter, can have zero or more [filter strategies](filter-strategies.md). A filter strategy tells Phileas how to manipulate that type of sensitive information when it is identified.
* Can have an optional list of [terms](ignore-lists.md) or [patterns](ignoring-patterns.md).
* Can have encryption keys to support [encryption](filter-strategies.md#fpe) of sensitive information.
* Each `identifier` , or filter, can have zero or more [filter strategies](filter_strategies.md). A filter strategy tells Philter how to manipulate that type of sensitive information when it is identified.
* Can have an optional list of terms or patterns of information to [ignore](ignoring_specific_information.md).
* Can have encryption keys to support [encryption](filter_strategies.md#the-fpe_encrypt_replace-filter-strategy) of sensitive information.

### An Example Policy

The following is an example policy. In the example below you can see the [types of sensitive information](filters_README.md) that are enabled and the strategy for manipulating each type when found. This policy identifies email addresses and phone numbers and redacts each with the format given.
The following is an example policy. In the example below you can see the [types of sensitive information](filters.md) that are enabled and the strategy for manipulating each type when found. This policy identifies email addresses and phone numbers and redacts each with the format given.

```
{
Expand All @@ -45,21 +45,21 @@ The following is an example policy. In the example below you can see the [types
}
```

When an email address is identified by this policy, the email address is replaced with the text `{{{REDACTED-email-address}}}`. The `%t` gets replaced by the type of the filter. Likewise, when a phone number is found it is replaced with the text `{{{REDACTED-phone-number}}}`. You are free to change the redaction formats to whatever fits your use-case. See [Filter Strategies](filter-strategies.md) for all replacement options.
When an email address is identified by this policy, the email address is replaced with the text `{{{REDACTED-email-address}}}`. The `%t` gets replaced by the type of the filter. Likewise, when a phone number is found it is replaced with the text `{{{REDACTED-phone-number}}}`. You are free to change the redaction formats to whatever fits your use-case. See [Filter Strategies](filter_strategies.md) for all replacement options.

The name of the policy is `email-and-phone-numbers`. Policies can be named anything you like but their names must be unique from all other policies. As a best practice, the policy should be saved as `[name].json`, e.g. `email-and-phone-numbers.json`.

### Applying a Policy to Text

To use this policy we will save it as `/opt/Phileas/profiles/email-and-phone-numbers.json`. We must restart Phileas for the new profile to be available for use. To apply the policy we will pass the policy's name to Phileas when making a filter request, as shown in the example request below.
To use this policy we will save it as `/opt/Philter/profiles/email-and-phone-numbers.json`. We must restart Philter for the new profile to be available for use. To apply the policy we will pass the policy's name to Philter when making a filter request, as shown in the example request below.

```
curl -k -X POST "https://localhost:8080/api/filter?c=context&p=email-and-phone-numbers" \
-d @file.txt -H Content-Type "text/plain"
```

In this command, we have provided the parameter `p` along with a value that is the name of the policy we want to use for this request. If we had multiple policies in Phileas we could choose a different policy for this request simply by changing the name given to the parameter `p`. For more details see Phileas’s [API](filtering-api.md).
In this command, we have provided the parameter `p` along with a value that is the name of the policy we want to use for this request. If we had multiple policies in Philter we could choose a different policy for this request simply by changing the name given to the parameter `p`. For more details see Philter’s [API](../api_and_sdks/api.md).

Phileas will process the contents of `file.txt` by applying the policy named `email-and-phone-numbers`. As we saw in the policy above, this policy redacts email addresses and phone numbers. Phileas will return the redacted text in response to the API call.
Philter will process the contents of `file.txt` by applying the policy named `email-and-phone-numbers`. As we saw in the policy above, this policy redacts email addresses and phone numbers. Philter will return the redacted text in response to the API call.

To manipulate the sensitive information by methods other than redaction, see the [Filter Strategies](filter-strategies.md).
To manipulate the sensitive information by methods other than redaction, see the [Filter Strategies](filter_strategies.md).
16 changes: 8 additions & 8 deletions docs/docs/policies/filter_strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ A sample policy containing a filter strategy is shown below. In this example, em

The filter strategies are described below. Each filter type can specify zero or more filter strategies. When no filter strategies are given, Philter will default to `REDACT` for that filter type. When multiple filter strategies are given for a single filter type, the filter strategies will be applied in order as they are listed in the policy, top to bottom.

* REDACT
* CRYPTO_REPLACE
* HASH_SHA256_REPLACE
* FPE_ENCRYPT_REPLACE
* RANDOM_REPLACE
* STATIC_REPLACE
* TRUNCATE
* ZERO_LEADING
* [REDACT](#the-redact-filter-strategy)
* [CRYPTO_REPLACE](#the-crypto_replace-filter-strategy)
* [HASH_SHA256_REPLACE](#the-hash_sha256_replace-filter-strategy)
* [FPE_ENCRYPT_REPLACE](#the-fpe_encrypt_replace-filter-strategy)
* [RANDOM_REPLACE](#the-random_replace-filter-strategy)
* [STATIC_REPLACE](#the-static_replace-filter-strategy)
* [TRUNCATE](#the-truncate-filter-strategy)
* [ZERO_LEADING](#the-zero_leading-filter-strategy)

### The `REDACT` Filter Strategy

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/policies/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Each filter is capable of identifying and redacting a specific type of sensitive

This section of the documentation describes the filters available in Phileas. The configuration options for each filter can vary due to the type of the sensitive information. For instance, only the zip code filter has a configuration to truncate the zip code.

A selection of filters and their configurations is called a [policy](policies_README.md). A policy describes how to de-identify a document.
A selection of filters and their configurations is called a [policy](filter_policies.md). A policy describes how to de-identify a document.

## Predefined Filters

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/policies/filters/common_filters/ages.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This filter has no required parameters.

### Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](#filter-strategies) for details.
The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](../../filter_strategies.md) for details.

| Strategy | Description |
| --------------------- | -------------------------------------------------------- |
Expand All @@ -30,7 +30,7 @@ The filter may have zero or more filter strategies. When no filter strategy is g

### Conditions

Each filter strategy may have one condition. The filter will only be applied when the condition is satisfied. See [Conditions](#conditions) for details.
Each filter strategy may have one condition. The filter will only be applied when the condition is satisfied. See [Conditions](../../filter_strategies.md#filter-strategy-conditions) for details.

| Conditional | Description | Operators |
| ------------ | ------------------------------------------------------------------------ | ---------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This filter has no required parameters.

### Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](#filter-strategies) for details.
The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](../../filter_strategies.md) for details.

| Strategy | Description |
| --------------------- |---------------------------------------------------------------------------------------------------------------------|
Expand All @@ -31,7 +31,7 @@ The filter may have zero or more filter strategies. When no filter strategy is g

### Conditions

Each filter strategy may have one condition. The filter will only be applied when the condition is satisfied. See [Conditions](#conditions) for details.
Each filter strategy may have one condition. The filter will only be applied when the condition is satisfied. See [Conditions](../../filter_strategies.md#filter-strategy-conditions) for details.

| Conditional | Description | Operators |
| ------------ | ------------------------------------------------------------------------ | ---------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This filter has no required parameters.

### Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](#filter-strategies) for details.
The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](../../filter_strategies.md) for details.

| Strategy | Description |
| --------------------- |---------------------------------------------------------------------------------------------------------------------|
Expand All @@ -31,7 +31,7 @@ The filter may have zero or more filter strategies. When no filter strategy is g

### Conditions

Each filter strategy may have one condition. See [Conditions](#conditions) for details.
Each filter strategy may have one condition. See [Conditions](../../filter_strategies.md#filter-strategy-conditions) for details.

| Conditional | Description | Operators |
| ------------ | ------------------------------------------------------------------------ | ---------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/policies/filters/common_filters/creditcards.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This filter has no required parameters.

### Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](#filter-strategies) for details.
The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of `REDACT` is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See [Filter Strategies](../../filter_strategies.md) for details.

| Strategy | Description |
| --------------------- |--------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -34,7 +34,7 @@ The filter may have zero or more filter strategies. When no filter strategy is g

### Conditions

Each filter strategy may have one condition. See [Conditions](#conditions) for details.
Each filter strategy may have one condition. See [Conditions](../../filter_strategies.md#filter-strategy-conditions) for details.

| Conditional | Description | Operators |
| ------------ | ------------------------------------------------------------------------ | ---------------------------------- |
Expand Down
Loading

0 comments on commit 3e4e6a5

Please sign in to comment.