Skip to content

Commit

Permalink
Minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
NamSor SAS committed Feb 16, 2022
1 parent 2fffac8 commit c1ccc87
Show file tree
Hide file tree
Showing 166 changed files with 2,031 additions and 306 deletions.
22 changes: 16 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ NamSor API v2 : enpoints to process personal names (gender, cultural origin or e

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.15
- Package version: 2.0.15
- API version: 2.0.18
- Package version: 2.0.18
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [http://www.namsor.com/](http://www.namsor.com/)

Expand Down Expand Up @@ -62,10 +62,12 @@ configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
api_instance = openapi_client.AdminApi(openapi_client.ApiClient(configuration))
source = 'source_example' # str |
anonymized = True # bool |
token = 'token_example' # str |

try:
# Activate/deactivate anonymization for a source.
api_instance.anonymize(source, anonymized)
api_response = api_instance.anonymize(source, anonymized, token)
pprint(api_response)
except ApiException as e:
print("Exception when calling AdminApi->anonymize: %s\n" % e)

Expand All @@ -77,14 +79,17 @@ All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source.
*AdminApi* | [**anonymize1**](docs/AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
*AdminApi* | [**api_key_info**](docs/AdminApi.md#api_key_info) | **GET** /api2/json/apiKeyInfo | Read API Key info.
*AdminApi* | [**api_status**](docs/AdminApi.md#api_status) | **GET** /api2/json/apiStatus | Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
*AdminApi* | [**api_usage**](docs/AdminApi.md#api_usage) | **GET** /api2/json/apiUsage | Print current API usage.
*AdminApi* | [**api_usage_history**](docs/AdminApi.md#api_usage_history) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
*AdminApi* | [**api_usage_history_aggregate**](docs/AdminApi.md#api_usage_history_aggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
*AdminApi* | [**available_services**](docs/AdminApi.md#available_services) | **GET** /api2/json/apiServices | List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
*AdminApi* | [**disable**](docs/AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key.
*AdminApi* | [**learnable**](docs/AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source.
*AdminApi* | [**learnable1**](docs/AdminApi.md#learnable1) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
*AdminApi* | [**software_version**](docs/AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version
*AdminApi* | [**taxonomy_classes**](docs/AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
*ChineseApi* | [**chinese_name_candidates**](docs/ChineseApi.md#chinese_name_candidates) | **GET** /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
Expand All @@ -110,8 +115,8 @@ Class | Method | HTTP request | Description
*JapaneseApi* | [**gender_japanese_name_pinyin**](docs/JapaneseApi.md#gender_japanese_name_pinyin) | **GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin).
*JapaneseApi* | [**gender_japanese_name_pinyin_batch**](docs/JapaneseApi.md#gender_japanese_name_pinyin_batch) | **POST** /api2/json/genderJapaneseNameBatch | Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).
*JapaneseApi* | [**japanese_name_gender_kanji_candidates_batch**](docs/JapaneseApi.md#japanese_name_gender_kanji_candidates_batch) | **POST** /api2/json/japaneseNameGenderKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_kanji_candidates**](docs/JapaneseApi.md#japanese_name_kanji_candidates) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
*JapaneseApi* | [**japanese_name_kanji_candidates1**](docs/JapaneseApi.md#japanese_name_kanji_candidates1) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_kanji_candidates**](docs/JapaneseApi.md#japanese_name_kanji_candidates) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_kanji_candidates1**](docs/JapaneseApi.md#japanese_name_kanji_candidates1) | **GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender} | Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
*JapaneseApi* | [**japanese_name_kanji_candidates_batch**](docs/JapaneseApi.md#japanese_name_kanji_candidates_batch) | **POST** /api2/json/japaneseNameKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_latin_candidates**](docs/JapaneseApi.md#japanese_name_latin_candidates) | **GET** /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji} | Romanize japanese name, based on the name in Kanji.
*JapaneseApi* | [**japanese_name_latin_candidates_batch**](docs/JapaneseApi.md#japanese_name_latin_candidates_batch) | **POST** /api2/json/japaneseNameLatinCandidatesBatch | Romanize japanese names, based on the name in KANJI
Expand All @@ -127,6 +132,7 @@ Class | Method | HTTP request | Description
*PersonalApi* | [**diaspora**](docs/PersonalApi.md#diaspora) | **GET** /api2/json/diaspora/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
*PersonalApi* | [**diaspora_batch**](docs/PersonalApi.md#diaspora_batch) | **POST** /api2/json/diasporaBatch | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.)
*PersonalApi* | [**gender**](docs/PersonalApi.md#gender) | **GET** /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name.
*PersonalApi* | [**gender1**](docs/PersonalApi.md#gender1) | **GET** /api2/json/gender/{firstName} | Infer the likely gender of a just a fiven name, assuming default 'US' local context. Please use preferably full names and local geographic context for better accuracy.
*PersonalApi* | [**gender_batch**](docs/PersonalApi.md#gender_batch) | **POST** /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context.
*PersonalApi* | [**gender_full**](docs/PersonalApi.md#gender_full) | **GET** /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith
*PersonalApi* | [**gender_full_batch**](docs/PersonalApi.md#gender_full_batch) | **POST** /api2/json/genderFullBatch | Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
Expand All @@ -140,6 +146,8 @@ Class | Method | HTTP request | Description
*PersonalApi* | [**parse_name_batch**](docs/PersonalApi.md#parse_name_batch) | **POST** /api2/json/parseNameBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
*PersonalApi* | [**parse_name_geo**](docs/PersonalApi.md#parse_name_geo) | **GET** /api2/json/parseName/{nameFull}/{countryIso2} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. For better accuracy, provide a geographic context.
*PersonalApi* | [**parse_name_geo_batch**](docs/PersonalApi.md#parse_name_geo_batch) | **POST** /api2/json/parseNameGeoBatch | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John. Giving a local context improves precision.
*PersonalApi* | [**subclassification**](docs/PersonalApi.md#subclassification) | **GET** /api2/json/subclassification/{countryIso2}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely origin of a name at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**subclassification_batch**](docs/PersonalApi.md#subclassification_batch) | **POST** /api2/json/subclassificationBatch | [USES 10 UNITS PER NAME] Infer the likely origin of a list of up to 100 names at a country subclassification level (state or regeion). Initially, this is only supported for India (ISO2 code 'IN').
*PersonalApi* | [**us_race_ethnicity**](docs/PersonalApi.md#us_race_ethnicity) | **GET** /api2/json/usRaceEthnicity/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
*PersonalApi* | [**us_race_ethnicity_batch**](docs/PersonalApi.md#us_race_ethnicity_batch) | **POST** /api2/json/usRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
*PersonalApi* | [**us_race_ethnicity_zip5**](docs/PersonalApi.md#us_race_ethnicity_zip5) | **GET** /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code} | [USES 10 UNITS PER NAME] Infer a US resident's likely race/ethnicity according to US Census taxonomy, using (optional) ZIP5 code info. Output is W_NL (white, non latino), HL (hispano latino), A (asian, non latino), B_NL (black, non latino). Optionally add header X-OPTION-USRACEETHNICITY-TAXONOMY: USRACEETHNICITY-6CLASSES for two additional classes, AI_AN (American Indian or Alaskan Native) and PI (Pacific Islander).
Expand Down Expand Up @@ -171,6 +179,7 @@ Class | Method | HTTP request | Description
- [BatchFirstLastNameGenderIn](docs/BatchFirstLastNameGenderIn.md)
- [BatchFirstLastNameGenderedOut](docs/BatchFirstLastNameGenderedOut.md)
- [BatchFirstLastNameGeoIn](docs/BatchFirstLastNameGeoIn.md)
- [BatchFirstLastNameGeoSubclassificationOut](docs/BatchFirstLastNameGeoSubclassificationOut.md)
- [BatchFirstLastNameGeoZippedIn](docs/BatchFirstLastNameGeoZippedIn.md)
- [BatchFirstLastNameIn](docs/BatchFirstLastNameIn.md)
- [BatchFirstLastNameOriginedOut](docs/BatchFirstLastNameOriginedOut.md)
Expand All @@ -196,6 +205,7 @@ Class | Method | HTTP request | Description
- [FirstLastNameGenderIn](docs/FirstLastNameGenderIn.md)
- [FirstLastNameGenderedOut](docs/FirstLastNameGenderedOut.md)
- [FirstLastNameGeoIn](docs/FirstLastNameGeoIn.md)
- [FirstLastNameGeoSubclassificationOut](docs/FirstLastNameGeoSubclassificationOut.md)
- [FirstLastNameGeoZippedIn](docs/FirstLastNameGeoZippedIn.md)
- [FirstLastNameIn](docs/FirstLastNameIn.md)
- [FirstLastNameOriginedOut](docs/FirstLastNameOriginedOut.md)
Expand Down
1 change: 1 addition & 0 deletions docs/APIClassifierTaxonomyOut.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifier_name** | **str** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) | [optional]
**taxonomy_classes** | **list[str]** | The taxonomy classes this classifier classifies to | [optional]
**classifying_scripts** | **list[str]** | The scripts / alphabets this classifiers classifies to | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
Loading

0 comments on commit c1ccc87

Please sign in to comment.