diff --git a/CHANGELOG.md b/CHANGELOG.md index 5365bd6..68a7682 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,147 +1,146 @@ -[Unreleased] +## [Unreleased] -Added +### Added -Changed +### Changed +* Updated formatting of CHANGELOG.md -Fixed +### Fixed +* Updated links in CONTRIBUTING.md -[3.6.2] - 2024-01-15 +## [3.6.2] - 2024-01-15 -Added +### Added * Created CONTRIBUTING.md to help developers with making modifications to this repo -Changed +### Changed -Fixed +### Fixed * Typo for standard_high_multilingual model selection * Code format -[3.6.1] - 2024-01-11 +## [3.6.1] - 2024-01-11 -Added +### Added * Added changelog to increase visibility of changes -Changed +### Changed -Fixed +### Fixed * Removed empty attributes from the request as some pydantic model changes will no longer accept them as valid request objects -[3.6.0] - 2023-12-22 +## [3.6.0] - 2023-12-22 -Added +### Added * Added proper dependencies for installing the client. -Changed +### Changed * Updated the accuracys of EntityDetection to include high_automatic and standard_high_automatic. The default accuracy is now high_automatic -Fixed +### Fixed -[3.5.0] - 2023-11-14 -NOTE: the versions of the client have been altered to match the version of Private AI's deidentification it should be used with. This change will only reflect the first 2 points of the release (in this case 3.5) while the third point will indicate changes to the client. +## [3.5.0] - 2023-11-14 +> NOTE: the versions of the client have been altered to match the version of Private AI's deidentification it should be used with. This change will only reflect the first 2 points of the release (in this case 3.5) while the third point will indicate changes to the client. -Added +### Added * Added warning indicator if the version of the container doesn't match the version of the client -Changed +### Changed -Fixed +### Fixed * Fixed bug with reidentify_text where the incorrect object could be returned -[1.3.3] - 2023-11-14 +## [1.3.3] - 2023-11-14 -Added +### Added * Added reidentify_sensitive_labels attribute to the ReidentifyTextRequest object with the default set to True. If set to False, sensitive information (like credit card info) will not get reidentified in a reidentify request. * Added best_labels to a processed text response object that returns an aggregation of all best_labels found in a process text operation. * Added enable_non_max_suppression to the EntityDetection request object -Changed -*ProcessText objects will no longer contain entity_detection or processed_text by default. To maintain the previous behaviour, they can be added explicitly - (eg. req = process_text_obj(text=[], entity_detection=entity_detection_obj, processed_text=processed_text_obj)) +### Changed +* ProcessText objects will no longer contain entity_detection or processed_text by default. To maintain the previous behaviour, they can be added explicitly (eg. req = process_text_obj(text=[], entity_detection=entity_detection_obj, processed_text=processed_text_obj)) -Fixed +### Fixed * bug fix with the reidentify_text function where passing in a dictionary instead of a request object would call the wrong function -[1.3.2] - 2023-09-11 +## [1.3.2] - 2023-09-11 -Added +### Added * Added new "max_resolution" PDF parameter, introduced in 3.3.3 -Changed -* expanded the File request object list of file types to match what is supported in the deid service +### Changed +* Expanded the File request object list of file types to match what is supported in the deid service * Changed audio start and end paddings to floats & default values to 0.5, the new default from releases 3.4 and on -Fixed +### Fixed -[1.3.1] 2023-08-08 +## [1.3.1] 2023-08-08 -Added +### Added -Changed +### Changed * Updated get_reidentify_entities to work with file responses. -Fixed +### Fixed -[1.3.0] - 2023-08-02 +## [1.3.0] - 2023-08-02 - -Added +### Added * The client accepts url as an argument. the original initialization arguments (scheme, host, port) are still accepted. * Added get_diagnostic() to client to access the diagnostics endpoint * Response objects that include processed text have 2 new functions: get_reidentify_entities() which returns a list of Entity objects containing entities used and their original text, and get_reidentify_request which will return a reidentify request object, ready to use with the reidentify endpoint. -Changed -* requests made with the client that return a Non-200 response now raise an HTTP Error. +### Changed +* Requests made with the client that return a Non-200 response now raise an HTTP Error. -Fixed +### Fixed * Fixed issue where retreiving the properties of the response body (eg. processed_text) would not return a list if there was only one entry in the response * Bug fix with block filter objects where entity_type couldn't be set -[1.2.0] +## [1.2.0] - 2023-06-01 -Added +### Added * Added request objects and functions to for the reidentify endpoint -Changed - +### Changed -Fixed +### Fixed * Bug fix for processed_text objects. Object can now be set to the appropriate type (MARKER, MASK or SYNTHETIC) -[1.1.0] - 2023-05-16 +## [1.1.0] - 2023-05-16 -Added +### Added * Added the capability to add authorization to the header of all requests for the client. -Changed +### Changed -Fixed +### Fixed * Fixed a bug with the metrics endpoint -[1.0.5] - 2023-04-19 +## [1.0.5] - 2023-04-19 -Added +### Added -Changed +### Changed * README updated with more detailed examples -Fixed +### Fixed -[1.0.4] - 2023-04-19 +## [1.0.4] - 2023-04-19 -Added +### Added -Changed +### Changed * README updated with examples -Fixed +### Fixed -[1.0.3] - 2023-04-19 +## [1.0.3] - 2023-04-19 -Added +### Added * Initial client release -Changed +### Changed -Fixed +### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a7e5b0..44d26f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents - [Suggesting Enhancements](#suggesting-enhancements) - [Your First Code Contribution](#your-first-code-contribution) - [Improving The Documentation](#improving-the-documentation) -- [Styleguides](#styleguides) - [Commit Messages](#commit-messages) -- [Join The Project Team](#join-the-project-team) @@ -22,11 +20,11 @@ All types of contributions are encouraged and valued. See the [Table of Contents > If you want to ask a question, we assume that you have read the available [Documentation](https://docs.private-ai.com). -Before you ask a question, it is best to search for existing [Issues](/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. +Before you ask a question, it is best to search for existing [Issues](https://github.com/privateai/pai-thin-client/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. If you then still feel the need to ask a question and need clarification, we recommend the following: -- Open an [Issue](/issues/new). +- Open an [Issue](https://github.com/privateai/pai-thin-client/issues/new). - Provide as much context as you can about what you're running into. - Provide the version of the thin client, container or API endpoint, and python you are using. - Provide any relevant sample code, sample request, and response logs. @@ -48,8 +46,8 @@ We will then take care of the issue as soon as possible. A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. - Make sure that you are using the latest version. -- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)). -- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](issues?q=label%3Abug). +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://docs.private-ai.com). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/privateai/pai-thin-client/issues?q=label%3Abug). - Collect information about the bug: - Stack trace and/or error log - Thin client version @@ -61,11 +59,11 @@ A good bug report shouldn't leave others needing to chase you up for more inform #### How Do I Submit a Good Bug Report? -> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to . +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [support@private-ai.com](mailto:support@private-ai.com). We use GitHub issues to track bugs and errors. If you run into an issue with the project: -- Open an [Issue](/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) +- Open an [Issue](https://github.com/privateai/pai-thin-client/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) - Explain the behavior you would expect and the actual behavior. - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. - Provide the information you collected in the previous section. @@ -87,13 +85,13 @@ This section guides you through submitting an enhancement suggestion for CONTRIB - Make sure that you are using the latest version. - Read the [documentation](https://docs.private-ai.com) carefully and find out if the functionality is already covered, maybe by an individual configuration. -- Perform a [search](/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Perform a [search](https://github.com/privateai/pai-thin-client/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. #### How Do I Submit a Good Enhancement Suggestion? -Enhancement suggestions are tracked as [GitHub issues](/issues). +Enhancement suggestions are tracked as [GitHub issues](https://github.com/privateai/pai-thin-client/issues). - Use a **clear and descriptive title** for the issue to identify the suggestion. - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. @@ -129,7 +127,7 @@ Follow the steps below to setup you development environment Follow the steps below to release a new version (maintainers only) -- Update the [__about__.py](./src/privateai_client/__about__.py) with the latest version of the container. +- Update the `__about__.py` [file](./src/privateai_client/__about__.py) with the latest version of the container. - Check that [CHANGELOG.md](./CHANGELOG.md) has all the commits since the previous release. - Update [CHANGELOG.md](./CHANGELOG.md) with a new section for the release version.