Minor update

namsor · Mar 15, 2021 · 01d3d7f · 01d3d7f
1 parent c382fb6
commit 01d3d7f
Show file tree

Hide file tree

Showing 196 changed files with 987 additions and 284 deletions.
diff --git a/README.md b/README.md
diff --git a/README_v2.0.12.md b/README_v2.0.12.md
diff --git a/docs/JapaneseApi.md b/docs/JapaneseApi.md
@@ -8,7 +8,9 @@ Method | HTTP request | Description
 [**gender_japanese_name_full_batch**](JapaneseApi.md#gender_japanese_name_full_batch) | **POST** /api2/json/genderJapaneseNameFullBatch | Infer the likely gender of up to 100 full names
 [**gender_japanese_name_pinyin**](JapaneseApi.md#gender_japanese_name_pinyin) | **GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName} | Infer the likely gender of a Japanese name in LATIN (Pinyin).
 [**gender_japanese_name_pinyin_batch**](JapaneseApi.md#gender_japanese_name_pinyin_batch) | **POST** /api2/json/genderJapaneseNameBatch | Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).
-[**japanese_name_kanji_candidates**](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
+[**japanese_name_gender_kanji_candidates_batch**](JapaneseApi.md#japanese_name_gender_kanji_candidates_batch) | **POST** /api2/json/japaneseNameGenderKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName &#x3D; japaneseGivenName; lastName&#x3D;japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
+[**japanese_name_kanji_candidates**](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.
+[**japanese_name_kanji_candidates1**](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
 [**japanese_name_kanji_candidates_batch**](JapaneseApi.md#japanese_name_kanji_candidates_batch) | **POST** /api2/json/japaneseNameKanjiCandidatesBatch | Identify japanese name candidates in KANJI, based on the romanized name (firstName &#x3D; japaneseGivenName; lastName&#x3D;japaneseSurname), ex. Yamamoto Sanae
 [**japanese_name_latin_candidates**](JapaneseApi.md#japanese_name_latin_candidates) | **GET** /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji} | Romanize japanese name, based on the name in Kanji.
 [**japanese_name_latin_candidates_batch**](JapaneseApi.md#japanese_name_latin_candidates_batch) | **POST** /api2/json/japaneseNameLatinCandidatesBatch | Romanize japanese names, based on the name in KANJI
@@ -237,8 +239,120 @@ Name | Type | Description  | Notes
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **japanese_name_gender_kanji_candidates_batch**
+> BatchNameMatchCandidatesOut japanese_name_gender_kanji_candidates_batch(batch_first_last_name_in=batch_first_last_name_in)
+
+Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
+
+### Example
+
+* Api Key Authentication (api_key): 
+```python
+from __future__ import print_function
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: api_key
+configuration = openapi_client.Configuration()
+configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.JapaneseApi(openapi_client.ApiClient(configuration))
+batch_first_last_name_in = openapi_client.BatchFirstLastNameIn() # BatchFirstLastNameIn | A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender (optional)
+
+try:
+    # Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
+    api_response = api_instance.japanese_name_gender_kanji_candidates_batch(batch_first_last_name_in=batch_first_last_name_in)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling JapaneseApi->japanese_name_gender_kanji_candidates_batch: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal japanese names in LATIN, firstName &#x3D; japaneseGivenName; lastName&#x3D;japaneseSurname and known gender | [optional] 
+
+### Return type
+
+[**BatchNameMatchCandidatesOut**](BatchNameMatchCandidatesOut.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **japanese_name_kanji_candidates**
-> RomanizedNameOut japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin)
+> RomanizedNameOut japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin, known_gender)
+
+Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
+
+### Example
+
+* Api Key Authentication (api_key): 
+```python
+from __future__ import print_function
+import time
+import openapi_client
+from openapi_client.rest import ApiException
+from pprint import pprint
+
+# Configure API key authorization: api_key
+configuration = openapi_client.Configuration()
+configuration.api_key['X-API-KEY'] = 'YOUR_API_KEY'
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['X-API-KEY'] = 'Bearer'
+
+# create an instance of the API class
+api_instance = openapi_client.JapaneseApi(openapi_client.ApiClient(configuration))
+japanese_surname_latin = 'japanese_surname_latin_example' # str | 
+japanese_given_name_latin = 'japanese_given_name_latin_example' # str | 
+known_gender = 'known_gender_example' # str | 
+
+try:
+    # Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
+    api_response = api_instance.japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin, known_gender)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling JapaneseApi->japanese_name_kanji_candidates: %s\n" % e)
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **japanese_surname_latin** | **str**|  | 
+ **japanese_given_name_latin** | **str**|  | 
+ **known_gender** | **str**|  | 
+
+### Return type
+
+[**RomanizedNameOut**](RomanizedNameOut.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **japanese_name_kanji_candidates1**
+> RomanizedNameOut japanese_name_kanji_candidates1(japanese_surname_latin, japanese_given_name_latin)
 
 Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
 
@@ -265,10 +379,10 @@ japanese_given_name_latin = 'japanese_given_name_latin_example' # str |
 
 try:
     # Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
-    api_response = api_instance.japanese_name_kanji_candidates(japanese_surname_latin, japanese_given_name_latin)
+    api_response = api_instance.japanese_name_kanji_candidates1(japanese_surname_latin, japanese_given_name_latin)
     pprint(api_response)
 except ApiException as e:
-    print("Exception when calling JapaneseApi->japanese_name_kanji_candidates: %s\n" % e)
+    print("Exception when calling JapaneseApi->japanese_name_kanji_candidates1: %s\n" % e)
 ```
 
 ### Parameters

diff --git a/docs/NameMatchCandidateOut.md b/docs/NameMatchCandidateOut.md
@@ -5,6 +5,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **candidate_name** | **str** |  | [optional] 
 **probability** | **float** |  | [optional] 
+**pred_score_given_name** | **float** |  | [optional] 
+**pred_score_family_name** | **float** |  | [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)
 

diff --git a/docs/NameMatchCandidatesOut.md b/docs/NameMatchCandidatesOut.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **id** | **str** |  | [optional] 
 **first_name** | **str** |  | [optional] 
 **last_name** | **str** |  | [optional] 
+**order_option** | **str** |  | [optional] 
 **match_candidates** | [**list[NameMatchCandidateOut]**](NameMatchCandidateOut.md) |  | [optional] 
 **category** | **str** |  | [optional] 
 

diff --git a/openapi_client/__init__.py b/openapi_client/__init__.py
@@ -7,15 +7,15 @@
 
     NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!   # noqa: E501
 
-    OpenAPI spec version: 2.0.12
+    OpenAPI spec version: 2.0.13
     Contact: contact@namsor.com
     Generated by: https://openapi-generator.tech
 """
 
 
 from __future__ import absolute_import
 
-__version__ = "2.0.12"
+__version__ = "2.0.13"
 
 # import apis into sdk package
 from openapi_client.api.admin_api import AdminApi

diff --git a/openapi_client/api/admin_api.py b/openapi_client/api/admin_api.py
@@ -5,7 +5,7 @@
 
     NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!   # noqa: E501
 
-    OpenAPI spec version: 2.0.12
+    OpenAPI spec version: 2.0.13
     Contact: contact@namsor.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/openapi_client/api/chinese_api.py b/openapi_client/api/chinese_api.py
@@ -5,7 +5,7 @@
 
     NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!   # noqa: E501
 
-    OpenAPI spec version: 2.0.12
+    OpenAPI spec version: 2.0.13
     Contact: contact@namsor.com
     Generated by: https://openapi-generator.tech
 """

diff --git a/openapi_client/api/general_api.py b/openapi_client/api/general_api.py
@@ -5,7 +5,7 @@
 
     NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. Use GET methods for small tests, but prefer POST methods for higher throughput (batch processing of up to 100 names at a time). Need something you can't find here? We have many more features coming soon. Let us know, we'll do our best to add it!   # noqa: E501
 
-    OpenAPI spec version: 2.0.12
+    OpenAPI spec version: 2.0.13
     Contact: contact@namsor.com
     Generated by: https://openapi-generator.tech
 """