licenses
sequencelengths 1
3
| version
stringclasses 677
values | tree_hash
stringlengths 40
40
| path
stringclasses 1
value | type
stringclasses 2
values | size
stringlengths 2
8
| text
stringlengths 25
67.1M
| package_name
stringlengths 2
41
| repo
stringlengths 33
86
|
|---|---|---|---|---|---|---|---|---|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | code | 1467 | # This file was generated by the Julia OpenAPI Code Generator
# Do not modify this file directly. Modify the OpenAPI specification instead.
@doc raw"""SoftwareVersionOut
The software version.
SoftwareVersionOut(;
softwareNameAndVersion=nothing,
softwareVersion=nothing,
)
- softwareNameAndVersion::String : The software version
- softwareVersion::Vector{Int64} : The software version major minor build
"""
Base.@kwdef mutable struct SoftwareVersionOut <: OpenAPI.APIModel
softwareNameAndVersion::Union{Nothing, String} = nothing
softwareVersion::Union{Nothing, Vector{Int64}} = nothing
function SoftwareVersionOut(softwareNameAndVersion, softwareVersion, )
OpenAPI.validate_property(SoftwareVersionOut, Symbol("softwareNameAndVersion"), softwareNameAndVersion)
OpenAPI.validate_property(SoftwareVersionOut, Symbol("softwareVersion"), softwareVersion)
return new(softwareNameAndVersion, softwareVersion, )
end
end # type SoftwareVersionOut
const _property_types_SoftwareVersionOut = Dict{Symbol,String}(Symbol("softwareNameAndVersion")=>"String", Symbol("softwareVersion")=>"Vector{Int64}", )
OpenAPI.property_type(::Type{ SoftwareVersionOut }, name::Symbol) = Union{Nothing,eval(Base.Meta.parse(_property_types_SoftwareVersionOut[name]))}
function check_required(o::SoftwareVersionOut)
true
end
function OpenAPI.validate_property(::Type{ SoftwareVersionOut }, name::Symbol, val)
end
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | code | 175 | using Test
using NamSor
@testset "KEY" begin
personal_api = init_api(APIClient.PersonalApi)
@test !isnothing(first(origin(personal_api,"Julia","Fox")).countryOrigin)
end | NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 40521 | # NamSor.jl
Julia client for [NamSor](https://namsor.app/) API v2.
## API key
Please apply for your [NamSor API key](https://namsor.app/api-documentation/) first. Then paste your api key at `$HOME/.config/NAMSOR_KEY.txt`. Or save api key to `NAMSOR_KEY` environment variable.
## Initialization
Before calling the NamSor interface, you need to initialize the corresponding NamSor API through `init_api()`.
There are 7 API implementations. You need to initialize them to call the corresponding interfaces.
- AdminApi
- ChineseApi
- GeneralApi
- IndianApi
- JapaneseApi
- PersonalApi
- SocialApi
To confirm the API implementation corresponding to specific API Endpoints, please check [API Endpoints](#api-endpoints).
For example, analyzes name "Julia Fox" to identify its country of origin.
``` julia-repl
julia> using NamSor
julia> personal_api = init_api(APIClient.PersonalApi)
julia> first(origin(personal_api,"Julia","Fox"))
{
"script": "LATIN",
"id": "0893c8d7-4f9e-4718-8946-d2fcdd7929a2",
"firstName": "Julia",
"lastName": "Fox",
"countryOrigin": "IE",
"countryOriginAlt": "GB",
"countriesOriginTop": [
"IE",
"GB",
"ES",
"IL",
"NA",
"PT",
"SK",
"DE",
"BE",
"FR"
],
"score": 2.994869283184946,
"regionOrigin": "Europe",
"topRegionOrigin": "Europe",
"subRegionOrigin": "Northern Europe",
"probabilityCalibrated": 0.5070530505259684,
"probabilityAltCalibrated": 0.8538791383744339
}
```
## Julia API client for APIClient
NamSor API v2 : enpoints to process personal names (gender, cultural origin or ethnicity) in all alphabets or languages. By default, enpoints use 1 unit per name (ex. Gender), but Ethnicity classification uses 10 to 20 units per name depending on taxonomy. 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!
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
- API version: 2.0.29
- Generator version: 7.5.0
- Build package: org.openapitools.codegen.languages.JuliaClientCodegen
For more information, please visit [http://www.namsor.com/](http://www.namsor.com/)
## Installation
Place the Julia files generated under the `src` folder in your Julia project. Include APIClient.jl in the project code.
It would include the module named APIClient.
Documentation is generated as markdown files under the `docs` folder. You can include them in your project documentation.
Documentation is also embedded in Julia which can be used with a Julia specific documentation generator.
## API Endpoints
Class | Method
------------ | -------------
*AdminApi* | [**anonymize**](docs/AdminApi.md#anonymize)<br/>**GET** /api2/json/anonymize/{source}/{anonymized}<br/>Activate/deactivate anonymization for a source.
*AdminApi* | [**anonymize1**](docs/AdminApi.md#anonymize1)<br/>**GET** /api2/json/anonymize/{source}/{anonymized}/{token}<br/>Activate/deactivate anonymization for a source.
*AdminApi* | [**api_key_info**](docs/AdminApi.md#api_key_info)<br/>**GET** /api2/json/apiKeyInfo<br/>Read API Key info.
*AdminApi* | [**api_status**](docs/AdminApi.md#api_status)<br/>**GET** /api2/json/apiStatus<br/>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)<br/>**GET** /api2/json/apiUsage<br/>Print current API usage.
*AdminApi* | [**api_usage_history**](docs/AdminApi.md#api_usage_history)<br/>**GET** /api2/json/apiUsageHistory<br/>Print historical API usage.
*AdminApi* | [**api_usage_history_aggregate**](docs/AdminApi.md#api_usage_history_aggregate)<br/>**GET** /api2/json/apiUsageHistoryAggregate<br/>Print historical API usage (in an aggregated view, by service, by day/hour/min).
*AdminApi* | [**available_services**](docs/AdminApi.md#available_services)<br/>**GET** /api2/json/apiServices<br/>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)<br/>**GET** /api2/json/disable/{source}/{disabled}<br/>Activate/deactivate an API Key.
*AdminApi* | [**learnable**](docs/AdminApi.md#learnable)<br/>**GET** /api2/json/learnable/{source}/{learnable}/{token}<br/>Activate/deactivate learning from a source.
*AdminApi* | [**learnable1**](docs/AdminApi.md#learnable1)<br/>**GET** /api2/json/learnable/{source}/{learnable}<br/>Activate/deactivate learning from a source.
*AdminApi* | [**regions**](docs/AdminApi.md#regions)<br/>**GET** /api2/json/regions<br/>Print basic source statistics.
*AdminApi* | [**software_version**](docs/AdminApi.md#software_version)<br/>**GET** /api2/json/softwareVersion<br/>Get the current software version
*AdminApi* | [**taxonomy_classes**](docs/AdminApi.md#taxonomy_classes)<br/>**GET** /api2/json/taxonomyClasses/{classifierName}<br/>Print the taxonomy classes valid for the given classifier.
*ChineseApi* | [**chinese_name_candidates**](docs/ChineseApi.md#chinese_name_candidates)<br/>**GET** /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}<br/>Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
*ChineseApi* | [**chinese_name_candidates_batch**](docs/ChineseApi.md#chinese_name_candidates_batch)<br/>**POST** /api2/json/chineseNameCandidatesBatch<br/>Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
*ChineseApi* | [**chinese_name_candidates_gender_batch**](docs/ChineseApi.md#chinese_name_candidates_gender_batch)<br/>**POST** /api2/json/chineseNameCandidatesGenderBatch<br/>Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.
*ChineseApi* | [**chinese_name_gender_candidates**](docs/ChineseApi.md#chinese_name_gender_candidates)<br/>**GET** /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender}<br/>Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')
*ChineseApi* | [**chinese_name_match**](docs/ChineseApi.md#chinese_name_match)<br/>**GET** /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName}<br/>Return a score for matching Chinese name ex. ηζζ with a romanized name ex. Wang Xiaoming
*ChineseApi* | [**chinese_name_match_batch**](docs/ChineseApi.md#chinese_name_match_batch)<br/>**POST** /api2/json/chineseNameMatchBatch<br/>Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
*ChineseApi* | [**gender_chinese_name**](docs/ChineseApi.md#gender_chinese_name)<br/>**GET** /api2/json/genderChineseName/{chineseName}<br/>Infer the likely gender of a Chinese full name ex. ηζζ
*ChineseApi* | [**gender_chinese_name_batch**](docs/ChineseApi.md#gender_chinese_name_batch)<br/>**POST** /api2/json/genderChineseNameBatch<br/>Infer the likely gender of up to 100 full names ex. ηζζ
*ChineseApi* | [**gender_chinese_name_pinyin**](docs/ChineseApi.md#gender_chinese_name_pinyin)<br/>**GET** /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin}<br/>Infer the likely gender of a Chinese name in LATIN (Pinyin).
*ChineseApi* | [**gender_chinese_name_pinyin_batch**](docs/ChineseApi.md#gender_chinese_name_pinyin_batch)<br/>**POST** /api2/json/genderChineseNamePinyinBatch<br/>Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).
*ChineseApi* | [**parse_chinese_name**](docs/ChineseApi.md#parse_chinese_name)<br/>**GET** /api2/json/parseChineseName/{chineseName}<br/>Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name)
*ChineseApi* | [**parse_chinese_name_batch**](docs/ChineseApi.md#parse_chinese_name_batch)<br/>**POST** /api2/json/parseChineseNameBatch<br/>Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name).
*ChineseApi* | [**pinyin_chinese_name**](docs/ChineseApi.md#pinyin_chinese_name)<br/>**GET** /api2/json/pinyinChineseName/{chineseName}<br/>Romanize the Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name)
*ChineseApi* | [**pinyin_chinese_name_batch**](docs/ChineseApi.md#pinyin_chinese_name_batch)<br/>**POST** /api2/json/pinyinChineseNameBatch<br/>Romanize a list of Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name).
*GeneralApi* | [**name_type**](docs/GeneralApi.md#name_type)<br/>**GET** /api2/json/nameType/{properNoun}<br/>Infer the likely type of a proper noun (personal name, brand name, place name etc.)
*GeneralApi* | [**name_type_batch**](docs/GeneralApi.md#name_type_batch)<br/>**POST** /api2/json/nameTypeBatch<br/>Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
*GeneralApi* | [**name_type_geo**](docs/GeneralApi.md#name_type_geo)<br/>**GET** /api2/json/nameTypeGeo/{properNoun}/{countryIso2}<br/>Infer the likely type of a proper noun (personal name, brand name, place name etc.)
*GeneralApi* | [**name_type_geo_batch**](docs/GeneralApi.md#name_type_geo_batch)<br/>**POST** /api2/json/nameTypeGeoBatch<br/>Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
*IndianApi* | [**caste_indian_batch**](docs/IndianApi.md#caste_indian_batch)<br/>**POST** /api2/json/casteIndianBatch<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names.
*IndianApi* | [**castegroup_indian**](docs/IndianApi.md#castegroup_indian)<br/>**GET** /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name.
*IndianApi* | [**castegroup_indian_batch**](docs/IndianApi.md#castegroup_indian_batch)<br/>**POST** /api2/json/castegroupIndianBatch<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names.
*IndianApi* | [**castegroup_indian_full**](docs/IndianApi.md#castegroup_indian_full)<br/>**GET** /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull}<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.
*IndianApi* | [**castegroup_indian_full_batch**](docs/IndianApi.md#castegroup_indian_full_batch)<br/>**POST** /api2/json/castegroupIndianFullBatch<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.
*IndianApi* | [**castegroup_indian_hindu**](docs/IndianApi.md#castegroup_indian_hindu)<br/>**GET** /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name.
*IndianApi* | [**religion**](docs/IndianApi.md#religion)<br/>**GET** /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull}<br/>[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian full name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
*IndianApi* | [**religion1**](docs/IndianApi.md#religion1)<br/>**GET** /api2/json/religionIndian/{subDivisionIso31662}/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian first/last name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
*IndianApi* | [**religion_indian_batch**](docs/IndianApi.md#religion_indian_batch)<br/>**POST** /api2/json/religionIndianBatch<br/>[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
*IndianApi* | [**religion_indian_full_batch**](docs/IndianApi.md#religion_indian_full_batch)<br/>**POST** /api2/json/religionIndianFullBatch<br/>[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
*IndianApi* | [**subclassification_indian**](docs/IndianApi.md#subclassification_indian)<br/>**GET** /api2/json/subclassificationIndian/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
*IndianApi* | [**subclassification_indian_batch**](docs/IndianApi.md#subclassification_indian_batch)<br/>**POST** /api2/json/subclassificationIndianBatch<br/>[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
*IndianApi* | [**subclassification_indian_full**](docs/IndianApi.md#subclassification_indian_full)<br/>**GET** /api2/json/subclassificationIndianFull/{fullName}<br/>[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
*IndianApi* | [**subclassification_indian_full_batch**](docs/IndianApi.md#subclassification_indian_full_batch)<br/>**POST** /api2/json/subclassificationIndianFullBatch<br/>[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
*JapaneseApi* | [**gender_japanese_name_full**](docs/JapaneseApi.md#gender_japanese_name_full)<br/>**GET** /api2/json/genderJapaneseNameFull/{japaneseName}<br/>Infer the likely gender of a Japanese full name ex. ηζζ
*JapaneseApi* | [**gender_japanese_name_full_batch**](docs/JapaneseApi.md#gender_japanese_name_full_batch)<br/>**POST** /api2/json/genderJapaneseNameFullBatch<br/>Infer the likely gender of up to 100 full names
*JapaneseApi* | [**gender_japanese_name_pinyin**](docs/JapaneseApi.md#gender_japanese_name_pinyin)<br/>**GET** /api2/json/genderJapaneseName/{japaneseSurname}/{japaneseGivenName}<br/>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)<br/>**POST** /api2/json/genderJapaneseNameBatch<br/>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)<br/>**POST** /api2/json/japaneseNameGenderKanjiCandidatesBatch<br/>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)<br/>**GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{knownGender}<br/>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)<br/>**GET** /api2/json/japaneseNameKanjiCandidates/{japaneseSurnameLatin}/{japaneseGivenNameLatin}<br/>Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_kanji_candidates_batch**](docs/JapaneseApi.md#japanese_name_kanji_candidates_batch)<br/>**POST** /api2/json/japaneseNameKanjiCandidatesBatch<br/>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)<br/>**GET** /api2/json/japaneseNameLatinCandidates/{japaneseSurnameKanji}/{japaneseGivenNameKanji}<br/>Romanize japanese name, based on the name in Kanji.
*JapaneseApi* | [**japanese_name_latin_candidates_batch**](docs/JapaneseApi.md#japanese_name_latin_candidates_batch)<br/>**POST** /api2/json/japaneseNameLatinCandidatesBatch<br/>Romanize japanese names, based on the name in KANJI
*JapaneseApi* | [**japanese_name_match**](docs/JapaneseApi.md#japanese_name_match)<br/>**GET** /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}<br/>Return a score for matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_match_batch**](docs/JapaneseApi.md#japanese_name_match_batch)<br/>**POST** /api2/json/japaneseNameMatchBatch<br/>Return a score for matching a list of Japanese names in KANJI ex. ε±±ζ¬ ζ©θ with romanized names ex. Yamamoto Sanae
*JapaneseApi* | [**japanese_name_match_feedback_loop**](docs/JapaneseApi.md#japanese_name_match_feedback_loop)<br/>**GET** /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName}<br/>[CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
*JapaneseApi* | [**parse_japanese_name**](docs/JapaneseApi.md#parse_japanese_name)<br/>**GET** /api2/json/parseJapaneseName/{japaneseName}<br/>Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
*JapaneseApi* | [**parse_japanese_name_batch**](docs/JapaneseApi.md#parse_japanese_name_batch)<br/>**POST** /api2/json/parseJapaneseNameBatch<br/>Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
*PersonalApi* | [**community_engage**](docs/PersonalApi.md#community_engage)<br/>**GET** /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName}<br/>[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
*PersonalApi* | [**community_engage_batch**](docs/PersonalApi.md#community_engage_batch)<br/>**POST** /api2/json/communityEngageBatch<br/>Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
*PersonalApi* | [**community_engage_full**](docs/PersonalApi.md#community_engage_full)<br/>**GET** /api2/json/communityEngageFull/{countryIso2}/{personalNameFull}<br/>[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
*PersonalApi* | [**community_engage_full_batch**](docs/PersonalApi.md#community_engage_full_batch)<br/>**POST** /api2/json/communityEngageFullBatch<br/>Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
*PersonalApi* | [**corridor**](docs/PersonalApi.md#corridor)<br/>**GET** /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo}<br/>[USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)
*PersonalApi* | [**corridor_batch**](docs/PersonalApi.md#corridor_batch)<br/>**POST** /api2/json/corridorBatch<br/>[USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)
*PersonalApi* | [**country**](docs/PersonalApi.md#country)<br/>**GET** /api2/json/country/{personalNameFull}<br/>[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
*PersonalApi* | [**country_batch**](docs/PersonalApi.md#country_batch)<br/>**POST** /api2/json/countryBatch<br/>[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
*PersonalApi* | [**country_fn_ln**](docs/PersonalApi.md#country_fn_ln)<br/>**GET** /api2/json/countryFnLn/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
*PersonalApi* | [**country_fn_ln_batch**](docs/PersonalApi.md#country_fn_ln_batch)<br/>**POST** /api2/json/countryFnLnBatch<br/>[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
*PersonalApi* | [**diaspora**](docs/PersonalApi.md#diaspora)<br/>**GET** /api2/json/diaspora/{countryIso2}/{firstName}/{lastName}<br/>[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)<br/>**POST** /api2/json/diasporaBatch<br/>[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* | [**diaspora_full**](docs/PersonalApi.md#diaspora_full)<br/>**GET** /api2/json/diasporaFull/{countryIso2}/{personalNameFull}<br/>[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_full_batch**](docs/PersonalApi.md#diaspora_full_batch)<br/>**POST** /api2/json/diasporaFullBatch<br/>[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)<br/>**GET** /api2/json/gender/{firstName}<br/>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* | [**gender1**](docs/PersonalApi.md#gender1)<br/>**GET** /api2/json/gender/{firstName}/{lastName}<br/>Infer the likely gender of a name.
*PersonalApi* | [**gender_batch**](docs/PersonalApi.md#gender_batch)<br/>**POST** /api2/json/genderBatch<br/>Infer the likely gender of up to 100 names, detecting automatically the cultural context.
*PersonalApi* | [**gender_full**](docs/PersonalApi.md#gender_full)<br/>**GET** /api2/json/genderFull/{fullName}<br/>Infer the likely gender of a full name, ex. John H. Smith
*PersonalApi* | [**gender_full_batch**](docs/PersonalApi.md#gender_full_batch)<br/>**POST** /api2/json/genderFullBatch<br/>Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
*PersonalApi* | [**gender_full_geo**](docs/PersonalApi.md#gender_full_geo)<br/>**GET** /api2/json/genderFullGeo/{fullName}/{countryIso2}<br/>Infer the likely gender of a full name, given a local context (ISO2 country code).
*PersonalApi* | [**gender_full_geo_batch**](docs/PersonalApi.md#gender_full_geo_batch)<br/>**POST** /api2/json/genderFullGeoBatch<br/>Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
*PersonalApi* | [**gender_geo**](docs/PersonalApi.md#gender_geo)<br/>**GET** /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2}<br/>Infer the likely gender of a name, given a local context (ISO2 country code).
*PersonalApi* | [**gender_geo_batch**](docs/PersonalApi.md#gender_geo_batch)<br/>**POST** /api2/json/genderGeoBatch<br/>Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
*PersonalApi* | [**origin**](docs/PersonalApi.md#origin)<br/>**GET** /api2/json/origin/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
*PersonalApi* | [**origin_batch**](docs/PersonalApi.md#origin_batch)<br/>**POST** /api2/json/originBatch<br/>[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
*PersonalApi* | [**origin_full**](docs/PersonalApi.md#origin_full)<br/>**GET** /api2/json/originFull/{personalNameFull}<br/>[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
*PersonalApi* | [**origin_full_batch**](docs/PersonalApi.md#origin_full_batch)<br/>**POST** /api2/json/originFullBatch<br/>[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
*PersonalApi* | [**parse_name**](docs/PersonalApi.md#parse_name)<br/>**GET** /api2/json/parseName/{nameFull}<br/>Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
*PersonalApi* | [**parse_name_batch**](docs/PersonalApi.md#parse_name_batch)<br/>**POST** /api2/json/parseNameBatch<br/>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)<br/>**GET** /api2/json/parseName/{nameFull}/{countryIso2}<br/>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)<br/>**POST** /api2/json/parseNameGeoBatch<br/>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* | [**religion2**](docs/PersonalApi.md#religion2)<br/>**GET** /api2/json/religion/{countryIso2}/{subDivisionIso31662}/{firstName}/{lastName}<br/>[USES 10 UNITS PER NAME] Infer the likely religion of a personal first/last name. NB: only for INDIA (as of current version).
*PersonalApi* | [**religion_batch**](docs/PersonalApi.md#religion_batch)<br/>**POST** /api2/json/religionBatch<br/>[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.
*PersonalApi* | [**religion_full**](docs/PersonalApi.md#religion_full)<br/>**GET** /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull}<br/>[USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).
*PersonalApi* | [**religion_full_batch**](docs/PersonalApi.md#religion_full_batch)<br/>**POST** /api2/json/religionFullBatch<br/>[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.
*PersonalApi* | [**subclassification**](docs/PersonalApi.md#subclassification)<br/>**GET** /api2/json/subclassification/{countryIso2}/{firstName}/{lastName}<br/>[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)<br/>**POST** /api2/json/subclassificationBatch<br/>[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* | [**subclassification_full**](docs/PersonalApi.md#subclassification_full)<br/>**GET** /api2/json/subclassificationFull/{countryIso2}/{fullName}<br/>[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_full_batch**](docs/PersonalApi.md#subclassification_full_batch)<br/>**POST** /api2/json/subclassificationFullBatch<br/>[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)<br/>**GET** /api2/json/usRaceEthnicity/{firstName}/{lastName}<br/>[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)<br/>**POST** /api2/json/usRaceEthnicityBatch<br/>[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_full**](docs/PersonalApi.md#us_race_ethnicity_full)<br/>**GET** /api2/json/usRaceEthnicityFull/{personalNameFull}<br/>[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_full_batch**](docs/PersonalApi.md#us_race_ethnicity_full_batch)<br/>**POST** /api2/json/usRaceEthnicityFullBatch<br/>[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_z_i_p5**](docs/PersonalApi.md#us_race_ethnicity_z_i_p5)<br/>**GET** /api2/json/usRaceEthnicityZIP5/{firstName}/{lastName}/{zip5Code}<br/>[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).
*PersonalApi* | [**us_zip_race_ethnicity_batch**](docs/PersonalApi.md#us_zip_race_ethnicity_batch)<br/>**POST** /api2/json/usZipRaceEthnicityBatch<br/>[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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).
*SocialApi* | [**phone_code**](docs/SocialApi.md#phone_code)<br/>**GET** /api2/json/phoneCode/{firstName}/{lastName}/{phoneNumber}<br/>[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, given a personal name and formatted / unformatted phone number.
*SocialApi* | [**phone_code_batch**](docs/SocialApi.md#phone_code_batch)<br/>**POST** /api2/json/phoneCodeBatch<br/>[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, detecting automatically the local context given a name and formatted / unformatted phone number.
*SocialApi* | [**phone_code_geo**](docs/SocialApi.md#phone_code_geo)<br/>**GET** /api2/json/phoneCodeGeo/{firstName}/{lastName}/{phoneNumber}/{countryIso2}<br/>[USES 11 UNITS PER NAME] Infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
*SocialApi* | [**phone_code_geo_batch**](docs/SocialApi.md#phone_code_geo_batch)<br/>**POST** /api2/json/phoneCodeGeoBatch<br/>[USES 11 UNITS PER NAME] Infer the likely country and phone prefix, of up to 100 personal names, with a local context (ISO2 country of residence).
*SocialApi* | [**phone_code_geo_feedback_loop**](docs/SocialApi.md#phone_code_geo_feedback_loop)<br/>**GET** /api2/json/phoneCodeGeoFeedbackLoop/{firstName}/{lastName}/{phoneNumber}/{phoneNumberE164}/{countryIso2}<br/>[CREDITS 1 UNIT] Feedback loop to better infer the likely phone prefix, given a personal name and formatted / unformatted phone number, with a local context (ISO2 country of residence).
## Models
- [APIBillingPeriodUsageOut](docs/APIBillingPeriodUsageOut.md)
- [APIClassifierOut](docs/APIClassifierOut.md)
- [APIClassifierTaxonomyOut](docs/APIClassifierTaxonomyOut.md)
- [APIClassifiersStatusOut](docs/APIClassifiersStatusOut.md)
- [APICounterV2Out](docs/APICounterV2Out.md)
- [APIKeyOut](docs/APIKeyOut.md)
- [APIPeriodUsageOut](docs/APIPeriodUsageOut.md)
- [APIPlanSubscriptionOut](docs/APIPlanSubscriptionOut.md)
- [APIServiceOut](docs/APIServiceOut.md)
- [APIServicesOut](docs/APIServicesOut.md)
- [APIUsageAggregatedOut](docs/APIUsageAggregatedOut.md)
- [APIUsageHistoryOut](docs/APIUsageHistoryOut.md)
- [BatchCommunityEngageFullOut](docs/BatchCommunityEngageFullOut.md)
- [BatchCommunityEngageOut](docs/BatchCommunityEngageOut.md)
- [BatchCorridorIn](docs/BatchCorridorIn.md)
- [BatchCorridorOut](docs/BatchCorridorOut.md)
- [BatchFirstLastNameCasteOut](docs/BatchFirstLastNameCasteOut.md)
- [BatchFirstLastNameCastegroupOut](docs/BatchFirstLastNameCastegroupOut.md)
- [BatchFirstLastNameDiasporaedOut](docs/BatchFirstLastNameDiasporaedOut.md)
- [BatchFirstLastNameGenderIn](docs/BatchFirstLastNameGenderIn.md)
- [BatchFirstLastNameGenderedOut](docs/BatchFirstLastNameGenderedOut.md)
- [BatchFirstLastNameGeoIn](docs/BatchFirstLastNameGeoIn.md)
- [BatchFirstLastNameGeoOut](docs/BatchFirstLastNameGeoOut.md)
- [BatchFirstLastNameGeoSubclassificationOut](docs/BatchFirstLastNameGeoSubclassificationOut.md)
- [BatchFirstLastNameGeoSubdivisionIn](docs/BatchFirstLastNameGeoSubdivisionIn.md)
- [BatchFirstLastNameGeoZippedIn](docs/BatchFirstLastNameGeoZippedIn.md)
- [BatchFirstLastNameIn](docs/BatchFirstLastNameIn.md)
- [BatchFirstLastNameOriginedOut](docs/BatchFirstLastNameOriginedOut.md)
- [BatchFirstLastNamePhoneCodedOut](docs/BatchFirstLastNamePhoneCodedOut.md)
- [BatchFirstLastNamePhoneNumberGeoIn](docs/BatchFirstLastNamePhoneNumberGeoIn.md)
- [BatchFirstLastNamePhoneNumberIn](docs/BatchFirstLastNamePhoneNumberIn.md)
- [BatchFirstLastNameReligionedOut](docs/BatchFirstLastNameReligionedOut.md)
- [BatchFirstLastNameSubdivisionIn](docs/BatchFirstLastNameSubdivisionIn.md)
- [BatchFirstLastNameUSRaceEthnicityOut](docs/BatchFirstLastNameUSRaceEthnicityOut.md)
- [BatchMatchPersonalFirstLastNameIn](docs/BatchMatchPersonalFirstLastNameIn.md)
- [BatchNameGeoIn](docs/BatchNameGeoIn.md)
- [BatchNameIn](docs/BatchNameIn.md)
- [BatchNameMatchCandidatesOut](docs/BatchNameMatchCandidatesOut.md)
- [BatchNameMatchedOut](docs/BatchNameMatchedOut.md)
- [BatchPersonalNameCastegroupOut](docs/BatchPersonalNameCastegroupOut.md)
- [BatchPersonalNameDiasporaedOut](docs/BatchPersonalNameDiasporaedOut.md)
- [BatchPersonalNameGenderedOut](docs/BatchPersonalNameGenderedOut.md)
- [BatchPersonalNameGeoIn](docs/BatchPersonalNameGeoIn.md)
- [BatchPersonalNameGeoOut](docs/BatchPersonalNameGeoOut.md)
- [BatchPersonalNameGeoSubclassificationOut](docs/BatchPersonalNameGeoSubclassificationOut.md)
- [BatchPersonalNameGeoSubdivisionIn](docs/BatchPersonalNameGeoSubdivisionIn.md)
- [BatchPersonalNameIn](docs/BatchPersonalNameIn.md)
- [BatchPersonalNameOriginedOut](docs/BatchPersonalNameOriginedOut.md)
- [BatchPersonalNameParsedOut](docs/BatchPersonalNameParsedOut.md)
- [BatchPersonalNameReligionedOut](docs/BatchPersonalNameReligionedOut.md)
- [BatchPersonalNameSubdivisionIn](docs/BatchPersonalNameSubdivisionIn.md)
- [BatchPersonalNameUSRaceEthnicityOut](docs/BatchPersonalNameUSRaceEthnicityOut.md)
- [BatchProperNounCategorizedOut](docs/BatchProperNounCategorizedOut.md)
- [CommunityEngageOptionOut](docs/CommunityEngageOptionOut.md)
- [CommunityEngageOut](docs/CommunityEngageOut.md)
- [CorridorIn](docs/CorridorIn.md)
- [CorridorOut](docs/CorridorOut.md)
- [FeedbackLoopOut](docs/FeedbackLoopOut.md)
- [FirstLastNameCasteOut](docs/FirstLastNameCasteOut.md)
- [FirstLastNameCastegroupOut](docs/FirstLastNameCastegroupOut.md)
- [FirstLastNameDiasporaedOut](docs/FirstLastNameDiasporaedOut.md)
- [FirstLastNameGenderIn](docs/FirstLastNameGenderIn.md)
- [FirstLastNameGenderedOut](docs/FirstLastNameGenderedOut.md)
- [FirstLastNameGeoIn](docs/FirstLastNameGeoIn.md)
- [FirstLastNameGeoOut](docs/FirstLastNameGeoOut.md)
- [FirstLastNameGeoSubclassificationOut](docs/FirstLastNameGeoSubclassificationOut.md)
- [FirstLastNameGeoSubdivisionIn](docs/FirstLastNameGeoSubdivisionIn.md)
- [FirstLastNameGeoZippedIn](docs/FirstLastNameGeoZippedIn.md)
- [FirstLastNameIn](docs/FirstLastNameIn.md)
- [FirstLastNameOriginedOut](docs/FirstLastNameOriginedOut.md)
- [FirstLastNameOut](docs/FirstLastNameOut.md)
- [FirstLastNamePhoneCodedOut](docs/FirstLastNamePhoneCodedOut.md)
- [FirstLastNamePhoneNumberGeoIn](docs/FirstLastNamePhoneNumberGeoIn.md)
- [FirstLastNamePhoneNumberIn](docs/FirstLastNamePhoneNumberIn.md)
- [FirstLastNameReligionedOut](docs/FirstLastNameReligionedOut.md)
- [FirstLastNameSubdivisionIn](docs/FirstLastNameSubdivisionIn.md)
- [FirstLastNameUSRaceEthnicityOut](docs/FirstLastNameUSRaceEthnicityOut.md)
- [MatchPersonalFirstLastNameIn](docs/MatchPersonalFirstLastNameIn.md)
- [NameGeoIn](docs/NameGeoIn.md)
- [NameIn](docs/NameIn.md)
- [NameMatchCandidateOut](docs/NameMatchCandidateOut.md)
- [NameMatchCandidatesOut](docs/NameMatchCandidatesOut.md)
- [NameMatchedOut](docs/NameMatchedOut.md)
- [PersonalNameCastegroupOut](docs/PersonalNameCastegroupOut.md)
- [PersonalNameDiasporaedOut](docs/PersonalNameDiasporaedOut.md)
- [PersonalNameGenderedOut](docs/PersonalNameGenderedOut.md)
- [PersonalNameGeoIn](docs/PersonalNameGeoIn.md)
- [PersonalNameGeoOut](docs/PersonalNameGeoOut.md)
- [PersonalNameGeoSubclassificationOut](docs/PersonalNameGeoSubclassificationOut.md)
- [PersonalNameGeoSubdivisionIn](docs/PersonalNameGeoSubdivisionIn.md)
- [PersonalNameIn](docs/PersonalNameIn.md)
- [PersonalNameOriginedOut](docs/PersonalNameOriginedOut.md)
- [PersonalNameParsedOut](docs/PersonalNameParsedOut.md)
- [PersonalNameReligionedOut](docs/PersonalNameReligionedOut.md)
- [PersonalNameSubdivisionIn](docs/PersonalNameSubdivisionIn.md)
- [PersonalNameUSRaceEthnicityOut](docs/PersonalNameUSRaceEthnicityOut.md)
- [ProperNounCategorizedOut](docs/ProperNounCategorizedOut.md)
- [RegionISO](docs/RegionISO.md)
- [RegionOut](docs/RegionOut.md)
- [ReligionStatOut](docs/ReligionStatOut.md)
- [SoftwareVersionOut](docs/SoftwareVersionOut.md)
<a id="authorization"></a>
## Authorization
Authentication schemes defined for the API:
<a id="api_key"></a>
### api_key
- **Type**: API key
Example
```
using OpenAPI
using OpenAPI.Clients
import OpenAPI.Clients: Client
client = Client(server_uri)
api = MyApi(client)
result = callApi(api, args...; api_key)
```
## Author
[email protected]
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1634 | # APIBillingPeriodUsageOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apiKey** | **String** | User API Key. | [optional] [default to nothing]
**subscriptionStarted** | **Int64** | Datetime when the user subscribed to the plan. | [optional] [default to nothing]
**periodStarted** | **Int64** | Datetime when the the plan's current period started. | [optional] [default to nothing]
**periodEnded** | **Int64** | Datetime when the the plan's current period endend. | [optional] [default to nothing]
**stripeCurrentPeriodEnd** | **Int64** | Datetime when the the plan's current period endend (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional] [default to nothing]
**stripeCurrentPeriodStart** | **Int64** | Datetime when the the plan's current period started (in Stripe). Internal and Stripe periodicity should ~coincide. | [optional] [default to nothing]
**billingStatus** | **String** | Current period billing status ex OPEN. | [optional] [default to nothing]
**usage** | **Int64** | Current period usage in units (NB some API endpoints use more than one unit). | [optional] [default to nothing]
**softLimit** | **Int64** | Current period soft limit (reaching the limit sends an email notification). | [optional] [default to nothing]
**hardLimit** | **Int64** | Current period hard limit (reaching the limit sends an email notification and blocks the API Key). | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 933 | # APIClassifierOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifierName** | **String** | The classifier name | [optional] [default to nothing]
**serving** | **Bool** | True if the classifier is serving requests (has reached minimal learning, is not shutting down) | [optional] [default to nothing]
**learning** | **Bool** | True if the classifier is learning | [optional] [default to nothing]
**shuttingDown** | **Bool** | True if the classifier is shutting down | [optional] [default to nothing]
**probabilityCalibrated** | **Bool** | True if the classifier has finished the initial learning and calibrated probabilities (meanwhile, during initial learning, probabilities will be equal to -1) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 700 | # APIClassifierTaxonomyOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**classifierName** | **String** | Name of the classifier as per apiStatus (corresponds also to the name of the service in apiServices) | [optional] [default to nothing]
**taxonomyClasses** | **Vector{String}** | The taxonomy classes this classifier classifies to | [optional] [default to nothing]
**classifyingScripts** | **Vector{String}** | The scripts / alphabets this classifiers classifies to | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 519 | # APIClassifiersStatusOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**softwareVersion** | [***SoftwareVersionOut**](SoftwareVersionOut.md) | | [optional] [default to nothing]
**classifiers** | [**Vector{APIClassifierOut}**](APIClassifierOut.md) | The list of classifiers and versions. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1098 | # APICounterV2Out
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apiKey** | [***APIKeyOut**](APIKeyOut.md) | | [optional] [default to nothing]
**apiService** | **String** | The apiService corresponds to the classifier name. | [optional] [default to nothing]
**hostAddress** | **String** | The processing hostAddress. | [optional] [default to nothing]
**createdDateTime** | **Int64** | The create datetime of the counter. | [optional] [default to nothing]
**totalUsage** | **Int64** | The usage of the counter. | [optional] [default to nothing]
**lastFlushedDateTime** | **Int64** | The flush datetime of the counter. | [optional] [default to nothing]
**lastUsedDateTime** | **Int64** | The last usage datetime of the counter. | [optional] [default to nothing]
**serviceFeaturesUsage** | **Dict{String, Int64}** | Usage of special features, such as Chinese, Japanese. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1900 | # APIKeyOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apiKey** | **String** | The user API Key. | [optional] [default to nothing]
**userId** | **String** | The user identifier. | [optional] [default to nothing]
**admin** | **Bool** | The API Key has admin role. | [optional] [default to nothing]
**vetted** | **Bool** | The API Key is vetted (assumed truthful) for machine learning. | [optional] [default to nothing]
**learnable** | **Bool** | The API Key is learnable (without assuming truthfulness) for machine learning. Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional] [default to nothing]
**anonymized** | **Bool** | The API Key is anonymized (using SHA-252 digest for logging). Set learnable=false and anonymized=true for highest privacy (ie. to forget data as it's processed). | [optional] [default to nothing]
**partner** | **Bool** | The API Key has partner role. | [optional] [default to nothing]
**striped** | **Bool** | The API Key is associated to a valid Stripe account. | [optional] [default to nothing]
**corporate** | **Bool** | The API Key has role corporate (ex SWIFT payments instead of Stripe payments). | [optional] [default to nothing]
**disabled** | **Bool** | The API Key is temporarily or permanently disabled. | [optional] [default to nothing]
**explainable** | **Bool** | The API Key supports the AI explainability option (may require a specific license). | [optional] [default to nothing]
**ipAddress** | **String** | | [optional] [default to nothing]
**communityEngageOption** | [***CommunityEngageOptionOut**](CommunityEngageOptionOut.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 947 | # APIPeriodUsageOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**subscription** | [***APIPlanSubscriptionOut**](APIPlanSubscriptionOut.md) | | [optional] [default to nothing]
**billingPeriod** | [***APIBillingPeriodUsageOut**](APIBillingPeriodUsageOut.md) | | [optional] [default to nothing]
**overageExclTax** | **Float64** | Overage amount including any tax. | [optional] [default to nothing]
**overageInclTax** | **Float64** | Overage amount including tax (if applicable). | [optional] [default to nothing]
**overageCurrency** | **String** | Currency of the overage amount. | [optional] [default to nothing]
**overageQuantity** | **Int64** | Quantity above monthly quota of the current subscritpion, in units. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2393 | # APIPlanSubscriptionOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apiKey** | **String** | User API Key. | [optional] [default to nothing]
**planStarted** | **Int64** | Datetime when the user subscribed to the current plan. | [optional] [default to nothing]
**priorPlanStarted** | **Int64** | Datetime when the user subscribed to the prior plan. | [optional] [default to nothing]
**planEnded** | **Int64** | Datetime when the user ended the plan. | [optional] [default to nothing]
**taxRate** | **Float64** | Applicable tax rate for the plan. | [optional] [default to nothing]
**planName** | **String** | Current plan name. | [optional] [default to nothing]
**planBaseFeesKey** | **String** | Current plan key (as in Stripe product). | [optional] [default to nothing]
**planStatus** | **String** | Plan status. | [optional] [default to nothing]
**planQuota** | **Int64** | Current plan quota in quantity of units (NB: some API use several units per name). | [optional] [default to nothing]
**priceUSD** | **Float64** | Current plan monthly price expressed in USD (includes a free quota). | [optional] [default to nothing]
**priceOverageUSD** | **Float64** | Current plan price for overages expressed in USD (extra price per unit above the free quota). | [optional] [default to nothing]
**price** | **Float64** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional] [default to nothing]
**priceOverage** | **Float64** | Current plan price for overages expressed in Currency (extra price per unit above the free quota). | [optional] [default to nothing]
**currency** | **String** | Current plan Currency for prices. | [optional] [default to nothing]
**currencyFactor** | **Float64** | For USD, GBP, EUR - the factor is 1. | [optional] [default to nothing]
**stripeCustomerId** | **String** | Stripe customer identifier. | [optional] [default to nothing]
**stripeStatus** | **String** | Stripe status ex active. | [optional] [default to nothing]
**stripeSubscription** | **String** | Stripe subscription identifier. | [optional] [default to nothing]
**userId** | **String** | Internal user identifier. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 776 | # APIServiceOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**serviceName** | **String** | A service name corresponds to classifier name in apiStatus (ex. personalname_gender or personalfullname_gender) | [optional] [default to nothing]
**serviceGroup** | **String** | Groups together classifiers providing a similar service (ex. gender groups personalname_gender and personalfullname_gender) | [optional] [default to nothing]
**costInUnits** | **Int64** | Indicates how many units per call this service costs (ex. the number of units per name) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 379 | # APIServicesOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**apiServices** | [**Vector{APIServiceOut}**](APIServiceOut.md) | List of API Services | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1130 | # APIUsageAggregatedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**timeUnit** | **String** | Time unit is DAY, WEEK or MONTH depending on prior usage | [optional] [default to nothing]
**periodStart** | **Int64** | Start datetime of the reporting period | [optional] [default to nothing]
**periodEnd** | **Int64** | End datetime of the reporting period | [optional] [default to nothing]
**totalUsage** | **Int64** | Total usage in the current period | [optional] [default to nothing]
**historyTruncated** | **Bool** | If the history was truncaded due to data limit | [optional] [default to nothing]
**data** | **Vector{Vector{Int64}}** | Data points : usage per DAY, WEEK or MONTH and per apiService | [optional] [default to nothing]
**colHeaders** | **Vector{String}** | apiServices as column headers | [optional] [default to nothing]
**rowHeaders** | **Vector{String}** | dates as row headers | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 429 | # APIUsageHistoryOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**detailedUsage** | [**Vector{APICounterV2Out}**](APICounterV2Out.md) | Detailed usage as reported by the deduplicating API counter. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 14230 | # AdminApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**anonymize**](AdminApi.md#anonymize) | **GET** /api2/json/anonymize/{source}/{anonymized} | Activate/deactivate anonymization for a source.
[**anonymize1**](AdminApi.md#anonymize1) | **GET** /api2/json/anonymize/{source}/{anonymized}/{token} | Activate/deactivate anonymization for a source.
[**api_key_info**](AdminApi.md#api_key_info) | **GET** /api2/json/apiKeyInfo | Read API Key info.
[**api_status**](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.
[**api_usage**](AdminApi.md#api_usage) | **GET** /api2/json/apiUsage | Print current API usage.
[**api_usage_history**](AdminApi.md#api_usage_history) | **GET** /api2/json/apiUsageHistory | Print historical API usage.
[**api_usage_history_aggregate**](AdminApi.md#api_usage_history_aggregate) | **GET** /api2/json/apiUsageHistoryAggregate | Print historical API usage (in an aggregated view, by service, by day/hour/min).
[**available_services**](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.
[**disable**](AdminApi.md#disable) | **GET** /api2/json/disable/{source}/{disabled} | Activate/deactivate an API Key.
[**learnable**](AdminApi.md#learnable) | **GET** /api2/json/learnable/{source}/{learnable}/{token} | Activate/deactivate learning from a source.
[**learnable1**](AdminApi.md#learnable1) | **GET** /api2/json/learnable/{source}/{learnable} | Activate/deactivate learning from a source.
[**regions**](AdminApi.md#regions) | **GET** /api2/json/regions | Print basic source statistics.
[**software_version**](AdminApi.md#software_version) | **GET** /api2/json/softwareVersion | Get the current software version
[**taxonomy_classes**](AdminApi.md#taxonomy_classes) | **GET** /api2/json/taxonomyClasses/{classifierName} | Print the taxonomy classes valid for the given classifier.
# **anonymize**
> anonymize(_api::AdminApi, source::String, anonymized::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
> anonymize(_api::AdminApi, response_stream::Channel, source::String, anonymized::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
Activate/deactivate anonymization for a source.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**source** | **String**| | [default to nothing]
**anonymized** | **Bool**| | [default to nothing]
### Return type
Nothing
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **anonymize1**
> anonymize1(_api::AdminApi, source::String, anonymized::Bool, token::String; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse <br/>
> anonymize1(_api::AdminApi, response_stream::Channel, source::String, anonymized::Bool, token::String; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse
Activate/deactivate anonymization for a source.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**source** | **String**| | [default to nothing]
**anonymized** | **Bool**| | [default to nothing]
**token** | **String**| | [default to nothing]
### Return type
[**APIKeyOut**](APIKeyOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **api_key_info**
> api_key_info(_api::AdminApi; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse <br/>
> api_key_info(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse
Read API Key info.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIKeyOut**](APIKeyOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **api_status**
> api_status(_api::AdminApi; _mediaType=nothing) -> APIClassifiersStatusOut, OpenAPI.Clients.ApiResponse <br/>
> api_status(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIClassifiersStatusOut }, OpenAPI.Clients.ApiResponse
Prints the current status of the classifiers. A classifier name in apiStatus corresponds to a service name in apiServices.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIClassifiersStatusOut**](APIClassifiersStatusOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **api_usage**
> api_usage(_api::AdminApi; _mediaType=nothing) -> APIPeriodUsageOut, OpenAPI.Clients.ApiResponse <br/>
> api_usage(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIPeriodUsageOut }, OpenAPI.Clients.ApiResponse
Print current API usage.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIPeriodUsageOut**](APIPeriodUsageOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **api_usage_history**
> api_usage_history(_api::AdminApi; _mediaType=nothing) -> APIUsageHistoryOut, OpenAPI.Clients.ApiResponse <br/>
> api_usage_history(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIUsageHistoryOut }, OpenAPI.Clients.ApiResponse
Print historical API usage.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIUsageHistoryOut**](APIUsageHistoryOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **api_usage_history_aggregate**
> api_usage_history_aggregate(_api::AdminApi; _mediaType=nothing) -> APIUsageAggregatedOut, OpenAPI.Clients.ApiResponse <br/>
> api_usage_history_aggregate(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIUsageAggregatedOut }, OpenAPI.Clients.ApiResponse
Print historical API usage (in an aggregated view, by service, by day/hour/min).
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIUsageAggregatedOut**](APIUsageAggregatedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **available_services**
> available_services(_api::AdminApi; _mediaType=nothing) -> APIServicesOut, OpenAPI.Clients.ApiResponse <br/>
> available_services(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ APIServicesOut }, OpenAPI.Clients.ApiResponse
List of classification services and usage cost in Units per classification (default is 1=ONE Unit). Some API endpoints (ex. Corridor) combine multiple classifiers.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**APIServicesOut**](APIServicesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **disable**
> disable(_api::AdminApi, source::String, disabled::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
> disable(_api::AdminApi, response_stream::Channel, source::String, disabled::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
Activate/deactivate an API Key.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**source** | **String**| The API Key to set as enabled/disabled. | [default to nothing]
**disabled** | **Bool**| | [default to nothing]
### Return type
Nothing
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **learnable**
> learnable(_api::AdminApi, source::String, learnable_param::Bool, token::String; _mediaType=nothing) -> APIKeyOut, OpenAPI.Clients.ApiResponse <br/>
> learnable(_api::AdminApi, response_stream::Channel, source::String, learnable_param::Bool, token::String; _mediaType=nothing) -> Channel{ APIKeyOut }, OpenAPI.Clients.ApiResponse
Activate/deactivate learning from a source.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**source** | **String**| The API Key to set as learnable/non learnable. | [default to nothing]
**learnable_param** | **Bool**| | [default to nothing]
**token** | **String**| | [default to nothing]
### Return type
[**APIKeyOut**](APIKeyOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **learnable1**
> learnable1(_api::AdminApi, source::String, learnable::Bool; _mediaType=nothing) -> Nothing, OpenAPI.Clients.ApiResponse <br/>
> learnable1(_api::AdminApi, response_stream::Channel, source::String, learnable::Bool; _mediaType=nothing) -> Channel{ Nothing }, OpenAPI.Clients.ApiResponse
Activate/deactivate learning from a source.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**source** | **String**| The API Key to set as learnable/non learnable. | [default to nothing]
**learnable** | **Bool**| | [default to nothing]
### Return type
Nothing
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **regions**
> regions(_api::AdminApi; _mediaType=nothing) -> RegionOut, OpenAPI.Clients.ApiResponse <br/>
> regions(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ RegionOut }, OpenAPI.Clients.ApiResponse
Print basic source statistics.
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**RegionOut**](RegionOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **software_version**
> software_version(_api::AdminApi; _mediaType=nothing) -> SoftwareVersionOut, OpenAPI.Clients.ApiResponse <br/>
> software_version(_api::AdminApi, response_stream::Channel; _mediaType=nothing) -> Channel{ SoftwareVersionOut }, OpenAPI.Clients.ApiResponse
Get the current software version
### Required Parameters
This endpoint does not need any parameter.
### Return type
[**SoftwareVersionOut**](SoftwareVersionOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **taxonomy_classes**
> taxonomy_classes(_api::AdminApi, classifier_name::String; _mediaType=nothing) -> APIClassifierTaxonomyOut, OpenAPI.Clients.ApiResponse <br/>
> taxonomy_classes(_api::AdminApi, response_stream::Channel, classifier_name::String; _mediaType=nothing) -> Channel{ APIClassifierTaxonomyOut }, OpenAPI.Clients.ApiResponse
Print the taxonomy classes valid for the given classifier.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **AdminApi** | API context |
**classifier_name** | **String**| | [default to nothing]
### Return type
[**APIClassifierTaxonomyOut**](APIClassifierTaxonomyOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 433 | # BatchCommunityEngageFullOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**engagementCandidates** | [**Vector{CommunityEngageOut}**](CommunityEngageOut.md) | Classified community engagement candidates | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 429 | # BatchCommunityEngageOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**engagementCandidates** | [**Vector{CommunityEngageOut}**](CommunityEngageOut.md) | Classified community engagement candidates | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 357 | # BatchCorridorIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**corridorFromTo** | [**Vector{CorridorIn}**](CorridorIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 380 | # BatchCorridorOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**corridorFromTo** | [**Vector{CorridorOut}**](CorridorOut.md) | Classified corridors | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 414 | # BatchFirstLastNameCasteOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameCasteOut}**](FirstLastNameCasteOut.md) | Classified origined names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 429 | # BatchFirstLastNameCastegroupOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameCastegroupOut}**](FirstLastNameCastegroupOut.md) | Classified origined names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 429 | # BatchFirstLastNameDiasporaedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameDiasporaedOut}**](FirstLastNameDiasporaedOut.md) | Classified diaspora names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 389 | # BatchFirstLastNameGenderIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGenderIn}**](FirstLastNameGenderIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 425 | # BatchFirstLastNameGenderedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGenderedOut}**](FirstLastNameGenderedOut.md) | Classified genderized names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 380 | # BatchFirstLastNameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGeoIn}**](FirstLastNameGeoIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 399 | # BatchFirstLastNameGeoOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGeoOut}**](FirstLastNameGeoOut.md) | Classified names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 489 | # BatchFirstLastNameGeoSubclassificationOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGeoSubclassificationOut}**](FirstLastNameGeoSubclassificationOut.md) | Classified names at sub country level (region or state) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 413 | # BatchFirstLastNameGeoSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGeoSubdivisionIn}**](FirstLastNameGeoSubdivisionIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 398 | # BatchFirstLastNameGeoZippedIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameGeoZippedIn}**](FirstLastNameGeoZippedIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 371 | # BatchFirstLastNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameIn}**](FirstLastNameIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 423 | # BatchFirstLastNameOriginedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameOriginedOut}**](FirstLastNameOriginedOut.md) | Classified origined names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 448 | # BatchFirstLastNamePhoneCodedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNamesWithPhoneNumbers** | [**Vector{FirstLastNamePhoneCodedOut}**](FirstLastNamePhoneCodedOut.md) | Classified phone-coded names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 429 | # BatchFirstLastNamePhoneNumberGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNamesWithPhoneNumbers** | [**Vector{FirstLastNamePhoneNumberGeoIn}**](FirstLastNamePhoneNumberGeoIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 420 | # BatchFirstLastNamePhoneNumberIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNamesWithPhoneNumbers** | [**Vector{FirstLastNamePhoneNumberIn}**](FirstLastNamePhoneNumberIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 420 | # BatchFirstLastNameReligionedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameReligionedOut}**](FirstLastNameReligionedOut.md) | Classified names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 404 | # BatchFirstLastNameSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameSubdivisionIn}**](FirstLastNameSubdivisionIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 464 | # BatchFirstLastNameUSRaceEthnicityOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{FirstLastNameUSRaceEthnicityOut}**](FirstLastNameUSRaceEthnicityOut.md) | Classified US 'race'/ethnicized names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 410 | # BatchMatchPersonalFirstLastNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{MatchPersonalFirstLastNameIn}**](MatchPersonalFirstLastNameIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 351 | # BatchNameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**properNouns** | [**Vector{NameGeoIn}**](NameGeoIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 342 | # BatchNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**properNouns** | [**Vector{NameIn}**](NameIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 426 | # BatchNameMatchCandidatesOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**namesAndMatchCandidates** | [**Vector{NameMatchCandidatesOut}**](NameMatchCandidatesOut.md) | Classified matched names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 391 | # BatchNameMatchedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**matchedNames** | [**Vector{NameMatchedOut}**](NameMatchedOut.md) | Classified matched names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 424 | # BatchPersonalNameCastegroupOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameCastegroupOut}**](PersonalNameCastegroupOut.md) | Caste group-coded names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 426 | # BatchPersonalNameDiasporaedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameDiasporaedOut}**](PersonalNameDiasporaedOut.md) | Classified diaspora names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 422 | # BatchPersonalNameGenderedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameGenderedOut}**](PersonalNameGenderedOut.md) | Classified genderized names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 377 | # BatchPersonalNameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameGeoIn}**](PersonalNameGeoIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 400 | # BatchPersonalNameGeoOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameGeoOut}**](PersonalNameGeoOut.md) | Classified geo names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 486 | # BatchPersonalNameGeoSubclassificationOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameGeoSubclassificationOut}**](PersonalNameGeoSubclassificationOut.md) | Classified names at sub country level (region or state) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 410 | # BatchPersonalNameGeoSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameGeoSubdivisionIn}**](PersonalNameGeoSubdivisionIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 368 | # BatchPersonalNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameIn}**](PersonalNameIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 420 | # BatchPersonalNameOriginedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameOriginedOut}**](PersonalNameOriginedOut.md) | Classified origined names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 412 | # BatchPersonalNameParsedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameParsedOut}**](PersonalNameParsedOut.md) | Classified parsed names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 422 | # BatchPersonalNameReligionedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameReligionedOut}**](PersonalNameReligionedOut.md) | religious-coded names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 401 | # BatchPersonalNameSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameSubdivisionIn}**](PersonalNameSubdivisionIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 441 | # BatchPersonalNameUSRaceEthnicityOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**personalNames** | [**Vector{PersonalNameUSRaceEthnicityOut}**](PersonalNameUSRaceEthnicityOut.md) | Classified origined names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 425 | # BatchProperNounCategorizedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**properNouns** | [**Vector{ProperNounCategorizedOut}**](ProperNounCategorizedOut.md) | Classified typed proper names | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 20798 | # ChineseApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**chinese_name_candidates**](ChineseApi.md#chinese_name_candidates) | **GET** /api2/json/chineseNameCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
[**chinese_name_candidates_batch**](ChineseApi.md#chinese_name_candidates_batch) | **POST** /api2/json/chineseNameCandidatesBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
[**chinese_name_candidates_gender_batch**](ChineseApi.md#chinese_name_candidates_gender_batch) | **POST** /api2/json/chineseNameCandidatesGenderBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.
[**chinese_name_gender_candidates**](ChineseApi.md#chinese_name_gender_candidates) | **GET** /api2/json/chineseNameGenderCandidates/{chineseSurnameLatin}/{chineseGivenNameLatin}/{knownGender} | Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')
[**chinese_name_match**](ChineseApi.md#chinese_name_match) | **GET** /api2/json/chineseNameMatch/{chineseSurnameLatin}/{chineseGivenNameLatin}/{chineseName} | Return a score for matching Chinese name ex. ηζζ with a romanized name ex. Wang Xiaoming
[**chinese_name_match_batch**](ChineseApi.md#chinese_name_match_batch) | **POST** /api2/json/chineseNameMatchBatch | Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
[**gender_chinese_name**](ChineseApi.md#gender_chinese_name) | **GET** /api2/json/genderChineseName/{chineseName} | Infer the likely gender of a Chinese full name ex. ηζζ
[**gender_chinese_name_batch**](ChineseApi.md#gender_chinese_name_batch) | **POST** /api2/json/genderChineseNameBatch | Infer the likely gender of up to 100 full names ex. ηζζ
[**gender_chinese_name_pinyin**](ChineseApi.md#gender_chinese_name_pinyin) | **GET** /api2/json/genderChineseNamePinyin/{chineseSurnameLatin}/{chineseGivenNameLatin} | Infer the likely gender of a Chinese name in LATIN (Pinyin).
[**gender_chinese_name_pinyin_batch**](ChineseApi.md#gender_chinese_name_pinyin_batch) | **POST** /api2/json/genderChineseNamePinyinBatch | Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).
[**parse_chinese_name**](ChineseApi.md#parse_chinese_name) | **GET** /api2/json/parseChineseName/{chineseName} | Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name)
[**parse_chinese_name_batch**](ChineseApi.md#parse_chinese_name_batch) | **POST** /api2/json/parseChineseNameBatch | Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name).
[**pinyin_chinese_name**](ChineseApi.md#pinyin_chinese_name) | **GET** /api2/json/pinyinChineseName/{chineseName} | Romanize the Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name)
[**pinyin_chinese_name_batch**](ChineseApi.md#pinyin_chinese_name_batch) | **POST** /api2/json/pinyinChineseNameBatch | Romanize a list of Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name).
# **chinese_name_candidates**
> chinese_name_candidates(_api::ChineseApi, chinese_surname_latin::String, chinese_given_name_latin::String; _mediaType=nothing) -> NameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_candidates(_api::ChineseApi, response_stream::Channel, chinese_surname_latin::String, chinese_given_name_latin::String; _mediaType=nothing) -> Channel{ NameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_surname_latin** | **String**| | [default to nothing]
**chinese_given_name_latin** | **String**| | [default to nothing]
### Return type
[**NameMatchCandidatesOut**](NameMatchCandidatesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **chinese_name_candidates_batch**
> chinese_name_candidates_batch(_api::ChineseApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchNameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_candidates_batch(_api::ChineseApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname |
### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **chinese_name_candidates_gender_batch**
> chinese_name_candidates_gender_batch(_api::ChineseApi; batch_first_last_name_gender_in=nothing, _mediaType=nothing) -> BatchNameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_candidates_gender_batch(_api::ChineseApi, response_stream::Channel; batch_first_last_name_gender_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname) ex. Wang Xiaoming.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_gender_in** | [**BatchFirstLastNameGenderIn**](BatchFirstLastNameGenderIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname |
### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **chinese_name_gender_candidates**
> chinese_name_gender_candidates(_api::ChineseApi, chinese_surname_latin::String, chinese_given_name_latin::String, known_gender::String; _mediaType=nothing) -> NameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_gender_candidates(_api::ChineseApi, response_stream::Channel, chinese_surname_latin::String, chinese_given_name_latin::String, known_gender::String; _mediaType=nothing) -> Channel{ NameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify Chinese name candidates, based on the romanized name ex. Wang Xiaoming - having a known gender ('male' or 'female')
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_surname_latin** | **String**| | [default to nothing]
**chinese_given_name_latin** | **String**| | [default to nothing]
**known_gender** | **String**| | [default to nothing]
### Return type
[**NameMatchCandidatesOut**](NameMatchCandidatesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **chinese_name_match**
> chinese_name_match(_api::ChineseApi, chinese_surname_latin::String, chinese_given_name_latin::String, chinese_name::String; _mediaType=nothing) -> NameMatchedOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_match(_api::ChineseApi, response_stream::Channel, chinese_surname_latin::String, chinese_given_name_latin::String, chinese_name::String; _mediaType=nothing) -> Channel{ NameMatchedOut }, OpenAPI.Clients.ApiResponse
Return a score for matching Chinese name ex. ηζζ with a romanized name ex. Wang Xiaoming
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_surname_latin** | **String**| | [default to nothing]
**chinese_given_name_latin** | **String**| | [default to nothing]
**chinese_name** | **String**| | [default to nothing]
### Return type
[**NameMatchedOut**](NameMatchedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **chinese_name_match_batch**
> chinese_name_match_batch(_api::ChineseApi; batch_match_personal_first_last_name_in=nothing, _mediaType=nothing) -> BatchNameMatchedOut, OpenAPI.Clients.ApiResponse <br/>
> chinese_name_match_batch(_api::ChineseApi, response_stream::Channel; batch_match_personal_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchedOut }, OpenAPI.Clients.ApiResponse
Identify Chinese name candidates, based on the romanized name (firstName = chineseGivenName; lastName=chineseSurname), ex. Wang Xiaoming
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_match_personal_first_last_name_in** | [**BatchMatchPersonalFirstLastNameIn**](BatchMatchPersonalFirstLastNameIn.md)| A list of personal Chinese names in LATIN, firstName = chineseGivenName; lastName=chineseSurname |
### Return type
[**BatchNameMatchedOut**](BatchNameMatchedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_chinese_name**
> gender_chinese_name(_api::ChineseApi, chinese_name::String; _mediaType=nothing) -> PersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_chinese_name(_api::ChineseApi, response_stream::Channel, chinese_name::String; _mediaType=nothing) -> Channel{ PersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a Chinese full name ex. ηζζ
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameGenderedOut**](PersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_chinese_name_batch**
> gender_chinese_name_batch(_api::ChineseApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_chinese_name_batch(_api::ChineseApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 full names ex. ηζζ
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names, with a country ISO2 code |
### Return type
[**BatchPersonalNameGenderedOut**](BatchPersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_chinese_name_pinyin**
> gender_chinese_name_pinyin(_api::ChineseApi, chinese_surname_latin::String, chinese_given_name_latin::String; _mediaType=nothing) -> FirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_chinese_name_pinyin(_api::ChineseApi, response_stream::Channel, chinese_surname_latin::String, chinese_given_name_latin::String; _mediaType=nothing) -> Channel{ FirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a Chinese name in LATIN (Pinyin).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_surname_latin** | **String**| | [default to nothing]
**chinese_given_name_latin** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_chinese_name_pinyin_batch**
> gender_chinese_name_pinyin_batch(_api::ChineseApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_chinese_name_pinyin_batch(_api::ChineseApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 Chinese names in LATIN (Pinyin).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of names, with country code. |
### Return type
[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_chinese_name**
> parse_chinese_name(_api::ChineseApi, chinese_name::String; _mediaType=nothing) -> PersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_chinese_name(_api::ChineseApi, response_stream::Channel, chinese_name::String; _mediaType=nothing) -> Channel{ PersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameParsedOut**](PersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_chinese_name_batch**
> parse_chinese_name_batch(_api::ChineseApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_chinese_name_batch(_api::ChineseApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. ηζζ -> η(surname) ζζ(given name).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameParsedOut**](BatchPersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **pinyin_chinese_name**
> pinyin_chinese_name(_api::ChineseApi, chinese_name::String; _mediaType=nothing) -> PersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> pinyin_chinese_name(_api::ChineseApi, response_stream::Channel, chinese_name::String; _mediaType=nothing) -> Channel{ PersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Romanize the Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
**chinese_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameParsedOut**](PersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **pinyin_chinese_name_batch**
> pinyin_chinese_name_batch(_api::ChineseApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> pinyin_chinese_name_batch(_api::ChineseApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Romanize a list of Chinese name to Pinyin, ex. ηζζ -> Wang (surname) Xiaoming (given name).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **ChineseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of Chinese names |
### Return type
[**BatchPersonalNameParsedOut**](BatchPersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 761 | # CommunityEngageOptionOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**genderFilter** | **Vector{String}** | The gender filter (null to allow all) | [optional] [default to nothing]
**ethnicityFilter** | **Vector{String}** | The ethnicity filter (null to allow all) | [optional] [default to nothing]
**countryOutFilter** | **Vector{String}** | The output country filter (null to allow all) | [optional] [default to nothing]
**usRaceEthnicityFilter** | **Vector{String}** | The output US race/ethnicity filter (null to allow all) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1111 | # CommunityEngageOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**PersonalNameDiasporaedOut** | [***PersonalNameDiasporaedOut**](PersonalNameDiasporaedOut.md) | | [optional] [default to nothing]
**PersonalNameOriginedOut** | [***PersonalNameOriginedOut**](PersonalNameOriginedOut.md) | | [optional] [default to nothing]
**country** | [***PersonalNameGeoOut**](PersonalNameGeoOut.md) | | [optional] [default to nothing]
**gender** | [***PersonalNameGenderedOut**](PersonalNameGenderedOut.md) | | [optional] [default to nothing]
**PersonalNameUSRaceEthnicityOut** | [***PersonalNameUSRaceEthnicityOut**](PersonalNameUSRaceEthnicityOut.md) | | [optional] [default to nothing]
**prime** | **Bool** | | [optional] [default to nothing]
**scoped** | **Bool** | | [optional] [default to nothing]
**script** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 535 | # CorridorIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstLastNameGeoFrom** | [***FirstLastNameGeoIn**](FirstLastNameGeoIn.md) | | [optional] [default to nothing]
**firstLastNameGeoTo** | [***FirstLastNameGeoIn**](FirstLastNameGeoIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 766 | # CorridorOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**FirstLastNameGenderedOut** | [***FirstLastNameGenderedOut**](FirstLastNameGenderedOut.md) | | [optional] [default to nothing]
**FirstLastNameOriginedOut** | [***FirstLastNameOriginedOut**](FirstLastNameOriginedOut.md) | | [optional] [default to nothing]
**FirstLastNameDiasporaedOut** | [***FirstLastNameDiasporaedOut**](FirstLastNameDiasporaedOut.md) | | [optional] [default to nothing]
**script** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 401 | # FeedbackLoopOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**feedbackCredits** | **Int64** | Number of units recredited as per feedback loop successful classification | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1496 | # FirstLastNameCasteOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**caste** | **String** | Most likely caste | [optional] [default to nothing]
**casteAlt** | **String** | Second best alternative : caste | [optional] [default to nothing]
**casteTop** | **Vector{String}** | List caste(top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for caste to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for caste OR casteAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1536 | # FirstLastNameCastegroupOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**castegroup** | **String** | Most likely caste group | [optional] [default to nothing]
**castegroupAlt** | **String** | Second best alternative : caste group | [optional] [default to nothing]
**castegroupTop** | **Vector{String}** | List caste group (top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for caste to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for caste OR casteAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2329 | # FirstLastNameDiasporaedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**ethnicityAlt** | **String** | The second best alternative ethnicity | [optional] [default to nothing]
**ethnicity** | **String** | The most likely ethnicity | [optional] [default to nothing]
**lifted** | **Bool** | Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. | [optional] [default to nothing]
**countryIso2** | **String** | From input data, the countryIso2 of geographic context (US,CA etc.) | [optional] [default to nothing]
**ethnicitiesTop** | **Vector{String}** | List most likely ethnicities (top 10) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**religionStats** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, assuming ethnicity is correctly predicted. | [optional] [default to nothing]
**religionStatsAlt** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 538 | # FirstLastNameGenderIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**gender** | **String** | The known gender of the name | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1271 | # FirstLastNameGenderedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**likelyGender** | **String** | Most likely gender | [optional] [default to nothing]
**genderScale** | **Float64** | Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value. | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for inferred gender to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 512 | # FirstLastNameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2162 | # FirstLastNameGeoOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**score** | **Float64** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**country** | **String** | Most likely country | [optional] [default to nothing]
**countryAlt** | **String** | Second best alternative : country | [optional] [default to nothing]
**region** | **String** | Most likely region (based on country ISO2 code) | [optional] [default to nothing]
**topRegion** | **String** | Most likely top region (based on country ISO2 code) | [optional] [default to nothing]
**subRegion** | **String** | Most likely sub region (based on country ISO2 code) | [optional] [default to nothing]
**countriesTop** | **Vector{String}** | List countries (top 10) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for country to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for country OR countryAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**religionStats** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, assuming country is correctly predicted. | [optional] [default to nothing]
**religionStatsAlt** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1762 | # FirstLastNameGeoSubclassificationOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**countryIso2** | **String** | The input country ISO2 code | [optional] [default to nothing]
**subClassification** | **String** | Most likely subclassification ISO_3166-2 code | [optional] [default to nothing]
**subClassificationAlt** | **String** | Second best alternative : subclassification ISO_3166-2 code | [optional] [default to nothing]
**subclassificationTop** | **Vector{String}** | List subclassification ISO_3166-2 codes (top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for subclassification to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for subclassification OR subclassificationAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 592 | # FirstLastNameGeoSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
**subdivisionIso** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 580 | # FirstLastNameGeoZippedIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
**zipCode** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 443 | # FirstLastNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2353 | # FirstLastNameOriginedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**countryOrigin** | **String** | Most likely country of Origin | [optional] [default to nothing]
**countryOriginAlt** | **String** | Second best alternative : country of Origin | [optional] [default to nothing]
**countriesOriginTop** | **Vector{String}** | List countries of Origin (top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**regionOrigin** | **String** | Most likely region of Origin (based on countryOrigin ISO2 code) | [optional] [default to nothing]
**topRegionOrigin** | **String** | Most likely top region of Origin (based on countryOrigin ISO2 code) | [optional] [default to nothing]
**subRegionOrigin** | **String** | Most likely sub region of Origin (based on countryOrigin ISO2 code) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for countryOrigin to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for countryOrigin OR countryOriginAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**religionStats** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, assuming country of origin is correctly predicted. | [optional] [default to nothing]
**religionStatsAlt** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, for origin best alternative. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 665 | # FirstLastNameOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2158 | # FirstLastNamePhoneCodedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**internationalPhoneNumberVerified** | **String** | The normalized phone number, verified using libphonenumber. | [optional] [default to nothing]
**phoneCountryIso2Verified** | **String** | The phone ISO2 country code, verified using libphonenumber. | [optional] [default to nothing]
**phoneCountryCode** | **Int64** | The phone country code of the phone number, verified using libphonenumber. | [optional] [default to nothing]
**phoneCountryCodeAlt** | **Int64** | The best alternative phone country code of the phone number. | [optional] [default to nothing]
**phoneCountryIso2** | **String** | The likely country of the phone number. | [optional] [default to nothing]
**phoneCountryIso2Alt** | **String** | The best alternative country of the phone number. | [optional] [default to nothing]
**originCountryIso2** | **String** | The likely country of origin of the name. | [optional] [default to nothing]
**originCountryIso2Alt** | **String** | The best alternative country of origin of the name. | [optional] [default to nothing]
**phoneNumber** | **String** | The input phone number. | [optional] [default to nothing]
**verified** | **Bool** | Indicates if the phone number could be positively verified using libphonenumber. | [optional] [default to nothing]
**score** | **Float64** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 658 | # FirstLastNamePhoneNumberGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**phoneNumber** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
**countryIso2Alt** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 520 | # FirstLastNamePhoneNumberIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**phoneNumber** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1523 | # FirstLastNameReligionedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**religion** | **String** | Most likely religion | [optional] [default to nothing]
**religionAlt** | **String** | Second best alternative : religion | [optional] [default to nothing]
**religionsTop** | **Vector{String}** | List countries (top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for caste to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for caste OR casteAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 523 | # FirstLastNameSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**firstName** | **String** | | [optional] [default to nothing]
**lastName** | **String** | | [optional] [default to nothing]
**subdivisionIso** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1559 | # FirstLastNameUSRaceEthnicityOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**raceEthnicityAlt** | **String** | Second most likely US 'race'/ethnicity | [optional] [default to nothing]
**raceEthnicity** | **String** | Most likely US 'race'/ethnicity | [optional] [default to nothing]
**score** | **Float64** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**raceEthnicitiesTop** | **Vector{String}** | List 'race'/ethnicities | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for raceEthnicity to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for raceEthnicity OR raceEthnicityAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 5447 | # GeneralApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**name_type**](GeneralApi.md#name_type) | **GET** /api2/json/nameType/{properNoun} | Infer the likely type of a proper noun (personal name, brand name, place name etc.)
[**name_type_batch**](GeneralApi.md#name_type_batch) | **POST** /api2/json/nameTypeBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
[**name_type_geo**](GeneralApi.md#name_type_geo) | **GET** /api2/json/nameTypeGeo/{properNoun}/{countryIso2} | Infer the likely type of a proper noun (personal name, brand name, place name etc.)
[**name_type_geo_batch**](GeneralApi.md#name_type_geo_batch) | **POST** /api2/json/nameTypeGeoBatch | Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
# **name_type**
> name_type(_api::GeneralApi, proper_noun::String; _mediaType=nothing) -> ProperNounCategorizedOut, OpenAPI.Clients.ApiResponse <br/>
> name_type(_api::GeneralApi, response_stream::Channel, proper_noun::String; _mediaType=nothing) -> Channel{ ProperNounCategorizedOut }, OpenAPI.Clients.ApiResponse
Infer the likely type of a proper noun (personal name, brand name, place name etc.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **GeneralApi** | API context |
**proper_noun** | **String**| | [default to nothing]
### Return type
[**ProperNounCategorizedOut**](ProperNounCategorizedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **name_type_batch**
> name_type_batch(_api::GeneralApi; batch_name_in=nothing, _mediaType=nothing) -> BatchProperNounCategorizedOut, OpenAPI.Clients.ApiResponse <br/>
> name_type_batch(_api::GeneralApi, response_stream::Channel; batch_name_in=nothing, _mediaType=nothing) -> Channel{ BatchProperNounCategorizedOut }, OpenAPI.Clients.ApiResponse
Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **GeneralApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_name_in** | [**BatchNameIn**](BatchNameIn.md)| A list of proper names |
### Return type
[**BatchProperNounCategorizedOut**](BatchProperNounCategorizedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **name_type_geo**
> name_type_geo(_api::GeneralApi, proper_noun::String, country_iso2::String; _mediaType=nothing) -> ProperNounCategorizedOut, OpenAPI.Clients.ApiResponse <br/>
> name_type_geo(_api::GeneralApi, response_stream::Channel, proper_noun::String, country_iso2::String; _mediaType=nothing) -> Channel{ ProperNounCategorizedOut }, OpenAPI.Clients.ApiResponse
Infer the likely type of a proper noun (personal name, brand name, place name etc.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **GeneralApi** | API context |
**proper_noun** | **String**| | [default to nothing]
**country_iso2** | **String**| | [default to nothing]
### Return type
[**ProperNounCategorizedOut**](ProperNounCategorizedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **name_type_geo_batch**
> name_type_geo_batch(_api::GeneralApi; batch_name_geo_in=nothing, _mediaType=nothing) -> BatchProperNounCategorizedOut, OpenAPI.Clients.ApiResponse <br/>
> name_type_geo_batch(_api::GeneralApi, response_stream::Channel; batch_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchProperNounCategorizedOut }, OpenAPI.Clients.ApiResponse
Infer the likely common type of up to 100 proper nouns (personal name, brand name, place name etc.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **GeneralApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_name_geo_in** | [**BatchNameGeoIn**](BatchNameGeoIn.md)| A list of proper names |
### Return type
[**BatchProperNounCategorizedOut**](BatchProperNounCategorizedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 22200 | # IndianApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**caste_indian_batch**](IndianApi.md#caste_indian_batch) | **POST** /api2/json/casteIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names.
[**castegroup_indian**](IndianApi.md#castegroup_indian) | **GET** /api2/json/castegroupIndian/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name.
[**castegroup_indian_batch**](IndianApi.md#castegroup_indian_batch) | **POST** /api2/json/castegroupIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names.
[**castegroup_indian_full**](IndianApi.md#castegroup_indian_full) | **GET** /api2/json/castegroupIndianFull/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.
[**castegroup_indian_full_batch**](IndianApi.md#castegroup_indian_full_batch) | **POST** /api2/json/castegroupIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.
[**castegroup_indian_hindu**](IndianApi.md#castegroup_indian_hindu) | **GET** /api2/json/casteIndian/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name.
[**religion**](IndianApi.md#religion) | **GET** /api2/json/religionIndianFull/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian full name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
[**religion1**](IndianApi.md#religion1) | **GET** /api2/json/religionIndian/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian first/last name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
[**religion_indian_batch**](IndianApi.md#religion_indian_batch) | **POST** /api2/json/religionIndianBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
[**religion_indian_full_batch**](IndianApi.md#religion_indian_full_batch) | **POST** /api2/json/religionIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
[**subclassification_indian**](IndianApi.md#subclassification_indian) | **GET** /api2/json/subclassificationIndian/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
[**subclassification_indian_batch**](IndianApi.md#subclassification_indian_batch) | **POST** /api2/json/subclassificationIndianBatch | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
[**subclassification_indian_full**](IndianApi.md#subclassification_indian_full) | **GET** /api2/json/subclassificationIndianFull/{fullName} | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
[**subclassification_indian_full_batch**](IndianApi.md#subclassification_indian_full_batch) | **POST** /api2/json/subclassificationIndianFullBatch | [USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
# **caste_indian_batch**
> caste_indian_batch(_api::IndianApi; batch_first_last_name_geo_subdivision_in=nothing, _mediaType=nothing) -> BatchFirstLastNameCasteOut, OpenAPI.Clients.ApiResponse <br/>
> caste_indian_batch(_api::IndianApi, response_stream::Channel; batch_first_last_name_geo_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameCasteOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name caste of up to 100 personal Indian Hindu names.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_subdivision_in** | [**BatchFirstLastNameGeoSubdivisionIn**](BatchFirstLastNameGeoSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameCasteOut**](BatchFirstLastNameCasteOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **castegroup_indian**
> castegroup_indian(_api::IndianApi, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameCastegroupOut, OpenAPI.Clients.ApiResponse <br/>
> castegroup_indian(_api::IndianApi, response_stream::Channel, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameCastegroupOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a first / last name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**sub_division_iso31662** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameCastegroupOut**](FirstLastNameCastegroupOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **castegroup_indian_batch**
> castegroup_indian_batch(_api::IndianApi; batch_first_last_name_subdivision_in=nothing, _mediaType=nothing) -> BatchFirstLastNameCastegroupOut, OpenAPI.Clients.ApiResponse <br/>
> castegroup_indian_batch(_api::IndianApi, response_stream::Channel; batch_first_last_name_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameCastegroupOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal first / last names.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_subdivision_in** | [**BatchFirstLastNameSubdivisionIn**](BatchFirstLastNameSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameCastegroupOut**](BatchFirstLastNameCastegroupOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **castegroup_indian_full**
> castegroup_indian_full(_api::IndianApi, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> PersonalNameCastegroupOut, OpenAPI.Clients.ApiResponse <br/>
> castegroup_indian_full(_api::IndianApi, response_stream::Channel, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameCastegroupOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of a personal full name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**sub_division_iso31662** | **String**| | [default to nothing]
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameCastegroupOut**](PersonalNameCastegroupOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **castegroup_indian_full_batch**
> castegroup_indian_full_batch(_api::IndianApi; batch_personal_name_subdivision_in=nothing, _mediaType=nothing) -> BatchPersonalNameCastegroupOut, OpenAPI.Clients.ApiResponse <br/>
> castegroup_indian_full_batch(_api::IndianApi, response_stream::Channel; batch_personal_name_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameCastegroupOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name castegroup of up to 100 personal full names.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_subdivision_in** | [**BatchPersonalNameSubdivisionIn**](BatchPersonalNameSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameCastegroupOut**](BatchPersonalNameCastegroupOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **castegroup_indian_hindu**
> castegroup_indian_hindu(_api::IndianApi, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameCasteOut, OpenAPI.Clients.ApiResponse <br/>
> castegroup_indian_hindu(_api::IndianApi, response_stream::Channel, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameCasteOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian name caste of a personal Hindu name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**sub_division_iso31662** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameCasteOut**](FirstLastNameCasteOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion**
> religion(_api::IndianApi, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> PersonalNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion(_api::IndianApi, response_stream::Channel, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian full name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**sub_division_iso31662** | **String**| | [default to nothing]
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameReligionedOut**](PersonalNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion1**
> religion1(_api::IndianApi, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion1(_api::IndianApi, response_stream::Channel, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of a personal Indian first/last name, provided the Indian state or Union territory (NB/ this can be inferred using the subclassification endpoint).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**sub_division_iso31662** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameReligionedOut**](FirstLastNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion_indian_batch**
> religion_indian_batch(_api::IndianApi; batch_first_last_name_subdivision_in=nothing, _mediaType=nothing) -> BatchFirstLastNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion_indian_batch(_api::IndianApi, response_stream::Channel; batch_first_last_name_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_subdivision_in** | [**BatchFirstLastNameSubdivisionIn**](BatchFirstLastNameSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameReligionedOut**](BatchFirstLastNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion_indian_full_batch**
> religion_indian_full_batch(_api::IndianApi; batch_personal_name_subdivision_in=nothing, _mediaType=nothing) -> BatchPersonalNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion_indian_full_batch(_api::IndianApi, response_stream::Channel; batch_personal_name_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full Indian names, provided the subclassification at State or Union territory level (NB/ can be inferred using the subclassification endpoint).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_subdivision_in** | [**BatchPersonalNameSubdivisionIn**](BatchPersonalNameSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameReligionedOut**](BatchPersonalNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_indian**
> subclassification_indian(_api::IndianApi, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_indian(_api::IndianApi, response_stream::Channel, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGeoSubclassificationOut**](FirstLastNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_indian_batch**
> subclassification_indian_batch(_api::IndianApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_indian_batch(_api::IndianApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameGeoSubclassificationOut**](BatchFirstLastNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_indian_full**
> subclassification_indian_full(_api::IndianApi, full_name::String; _mediaType=nothing) -> PersonalNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_indian_full(_api::IndianApi, response_stream::Channel, full_name::String; _mediaType=nothing) -> Channel{ PersonalNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on the name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
**full_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameGeoSubclassificationOut**](PersonalNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_indian_full_batch**
> subclassification_indian_full_batch(_api::IndianApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_indian_full_batch(_api::IndianApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely Indian state of Union territory according to ISO 3166-2:IN based on a list of up to 100 names.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **IndianApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameGeoSubclassificationOut**](BatchPersonalNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 23029 | # JapaneseApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**gender_japanese_name_full**](JapaneseApi.md#gender_japanese_name_full) | **GET** /api2/json/genderJapaneseNameFull/{japaneseName} | Infer the likely gender of a Japanese full name ex. ηζζ
[**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_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 = japaneseGivenName; lastName=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 = japaneseGivenName; lastName=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
[**japanese_name_match**](JapaneseApi.md#japanese_name_match) | **GET** /api2/json/japaneseNameMatch/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName} | Return a score for matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
[**japanese_name_match_batch**](JapaneseApi.md#japanese_name_match_batch) | **POST** /api2/json/japaneseNameMatchBatch | Return a score for matching a list of Japanese names in KANJI ex. ε±±ζ¬ ζ©θ with romanized names ex. Yamamoto Sanae
[**japanese_name_match_feedback_loop**](JapaneseApi.md#japanese_name_match_feedback_loop) | **GET** /api2/json/japaneseNameMatchFeedbackLoop/{japaneseSurnameLatin}/{japaneseGivenNameLatin}/{japaneseName} | [CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
[**parse_japanese_name**](JapaneseApi.md#parse_japanese_name) | **GET** /api2/json/parseJapaneseName/{japaneseName} | Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
[**parse_japanese_name_batch**](JapaneseApi.md#parse_japanese_name_batch) | **POST** /api2/json/parseJapaneseNameBatch | Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
# **gender_japanese_name_full**
> gender_japanese_name_full(_api::JapaneseApi, japanese_name::String; _mediaType=nothing) -> PersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_japanese_name_full(_api::JapaneseApi, response_stream::Channel, japanese_name::String; _mediaType=nothing) -> Channel{ PersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a Japanese full name ex. ηζζ
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameGenderedOut**](PersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_japanese_name_full_batch**
> gender_japanese_name_full_batch(_api::JapaneseApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_japanese_name_full_batch(_api::JapaneseApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 full names
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameGenderedOut**](BatchPersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_japanese_name_pinyin**
> gender_japanese_name_pinyin(_api::JapaneseApi, japanese_surname::String, japanese_given_name::String; _mediaType=nothing) -> FirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_japanese_name_pinyin(_api::JapaneseApi, response_stream::Channel, japanese_surname::String, japanese_given_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a Japanese name in LATIN (Pinyin).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname** | **String**| | [default to nothing]
**japanese_given_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_japanese_name_pinyin_batch**
> gender_japanese_name_pinyin_batch(_api::JapaneseApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_japanese_name_pinyin_batch(_api::JapaneseApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 Japanese names in LATIN (Pinyin).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of names, with country code. |
### Return type
[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_gender_kanji_candidates_batch**
> japanese_name_gender_kanji_candidates_batch(_api::JapaneseApi; batch_first_last_name_gender_in=nothing, _mediaType=nothing) -> BatchNameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_gender_kanji_candidates_batch(_api::JapaneseApi, response_stream::Channel; batch_first_last_name_gender_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname) with KNOWN gender, ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_gender_in** | [**BatchFirstLastNameGenderIn**](BatchFirstLastNameGenderIn.md)| A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname and known gender |
### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_kanji_candidates**
> japanese_name_kanji_candidates(_api::JapaneseApi, japanese_surname_latin::String, japanese_given_name_latin::String, known_gender::String; _mediaType=nothing) -> NameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_kanji_candidates(_api::JapaneseApi, response_stream::Channel, japanese_surname_latin::String, japanese_given_name_latin::String, known_gender::String; _mediaType=nothing) -> Channel{ NameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae - and a known gender.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname_latin** | **String**| | [default to nothing]
**japanese_given_name_latin** | **String**| | [default to nothing]
**known_gender** | **String**| | [default to nothing]
### Return type
[**NameMatchCandidatesOut**](NameMatchCandidatesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_kanji_candidates1**
> japanese_name_kanji_candidates1(_api::JapaneseApi, japanese_surname_latin::String, japanese_given_name_latin::String; _mediaType=nothing) -> NameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_kanji_candidates1(_api::JapaneseApi, response_stream::Channel, japanese_surname_latin::String, japanese_given_name_latin::String; _mediaType=nothing) -> Channel{ NameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify japanese name candidates in KANJI, based on the romanized name ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname_latin** | **String**| | [default to nothing]
**japanese_given_name_latin** | **String**| | [default to nothing]
### Return type
[**NameMatchCandidatesOut**](NameMatchCandidatesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_kanji_candidates_batch**
> japanese_name_kanji_candidates_batch(_api::JapaneseApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchNameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_kanji_candidates_batch(_api::JapaneseApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Identify japanese name candidates in KANJI, based on the romanized name (firstName = japaneseGivenName; lastName=japaneseSurname), ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname |
### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_latin_candidates**
> japanese_name_latin_candidates(_api::JapaneseApi, japanese_surname_kanji::String, japanese_given_name_kanji::String; _mediaType=nothing) -> NameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_latin_candidates(_api::JapaneseApi, response_stream::Channel, japanese_surname_kanji::String, japanese_given_name_kanji::String; _mediaType=nothing) -> Channel{ NameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Romanize japanese name, based on the name in Kanji.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname_kanji** | **String**| | [default to nothing]
**japanese_given_name_kanji** | **String**| | [default to nothing]
### Return type
[**NameMatchCandidatesOut**](NameMatchCandidatesOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_latin_candidates_batch**
> japanese_name_latin_candidates_batch(_api::JapaneseApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchNameMatchCandidatesOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_latin_candidates_batch(_api::JapaneseApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchCandidatesOut }, OpenAPI.Clients.ApiResponse
Romanize japanese names, based on the name in KANJI
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal japanese names in KANJI, firstName = japaneseGivenName; lastName=japaneseSurname |
### 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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_match**
> japanese_name_match(_api::JapaneseApi, japanese_surname_latin::String, japanese_given_name_latin::String, japanese_name::String; _mediaType=nothing) -> NameMatchedOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_match(_api::JapaneseApi, response_stream::Channel, japanese_surname_latin::String, japanese_given_name_latin::String, japanese_name::String; _mediaType=nothing) -> Channel{ NameMatchedOut }, OpenAPI.Clients.ApiResponse
Return a score for matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname_latin** | **String**| | [default to nothing]
**japanese_given_name_latin** | **String**| | [default to nothing]
**japanese_name** | **String**| | [default to nothing]
### Return type
[**NameMatchedOut**](NameMatchedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_match_batch**
> japanese_name_match_batch(_api::JapaneseApi; batch_match_personal_first_last_name_in=nothing, _mediaType=nothing) -> BatchNameMatchedOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_match_batch(_api::JapaneseApi, response_stream::Channel; batch_match_personal_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchNameMatchedOut }, OpenAPI.Clients.ApiResponse
Return a score for matching a list of Japanese names in KANJI ex. ε±±ζ¬ ζ©θ with romanized names ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_match_personal_first_last_name_in** | [**BatchMatchPersonalFirstLastNameIn**](BatchMatchPersonalFirstLastNameIn.md)| A list of personal Japanese names in LATIN, firstName = japaneseGivenName; lastName=japaneseSurname |
### Return type
[**BatchNameMatchedOut**](BatchNameMatchedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **japanese_name_match_feedback_loop**
> japanese_name_match_feedback_loop(_api::JapaneseApi, japanese_surname_latin::String, japanese_given_name_latin::String, japanese_name::String; _mediaType=nothing) -> FeedbackLoopOut, OpenAPI.Clients.ApiResponse <br/>
> japanese_name_match_feedback_loop(_api::JapaneseApi, response_stream::Channel, japanese_surname_latin::String, japanese_given_name_latin::String, japanese_name::String; _mediaType=nothing) -> Channel{ FeedbackLoopOut }, OpenAPI.Clients.ApiResponse
[CREDITS 1 UNIT] Feedback loop to better perform matching Japanese name in KANJI ex. ε±±ζ¬ ζ©θ with a romanized name ex. Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_surname_latin** | **String**| | [default to nothing]
**japanese_given_name_latin** | **String**| | [default to nothing]
**japanese_name** | **String**| | [default to nothing]
### Return type
[**FeedbackLoopOut**](FeedbackLoopOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_japanese_name**
> parse_japanese_name(_api::JapaneseApi, japanese_name::String; _mediaType=nothing) -> PersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_japanese_name(_api::JapaneseApi, response_stream::Channel, japanese_name::String; _mediaType=nothing) -> Channel{ PersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
**japanese_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameParsedOut**](PersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_japanese_name_batch**
> parse_japanese_name_batch(_api::JapaneseApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_japanese_name_batch(_api::JapaneseApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. ε±±ζ¬ ζ©θ or Yamamoto Sanae
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **JapaneseApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameParsedOut**](BatchPersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 511 | # MatchPersonalFirstLastNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name1** | [***FirstLastNameIn**](FirstLastNameIn.md) | | [optional] [default to nothing]
**name2** | [***PersonalNameIn**](PersonalNameIn.md) | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 435 | # NameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 366 | # NameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 686 | # NameMatchCandidateOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**candidateName** | **String** | The name matching candidate name | [optional] [default to nothing]
**probability** | **Float64** | The name matching estimated probability. | [optional] [default to nothing]
**predScoreGivenName** | **Float64** | The given name prediction score. | [optional] [default to nothing]
**predScoreFamilyName** | **Float64** | The family name prediction score. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 925 | # NameMatchCandidatesOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**firstName** | **String** | The first name (also known as given name) | [optional] [default to nothing]
**lastName** | **String** | The last name (also known as family name, or surname) | [optional] [default to nothing]
**orderOption** | **String** | The option for ordering | [optional] [default to nothing]
**matchCandidates** | [**Vector{NameMatchCandidateOut}**](NameMatchCandidateOut.md) | The ordered list of name matching candidates | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 594 | # NameMatchedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**matchStatus** | **String** | The name matching status. | [optional] [default to nothing]
**score** | **Float64** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 71734 | # PersonalApi
All URIs are relative to *https://v2.namsor.com/NamSorAPIv2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**community_engage**](PersonalApi.md#community_engage) | **GET** /api2/json/communityEngage/{countryIso2}/{firstName}/{lastName} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
[**community_engage_batch**](PersonalApi.md#community_engage_batch) | **POST** /api2/json/communityEngageBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
[**community_engage_full**](PersonalApi.md#community_engage_full) | **GET** /api2/json/communityEngageFull/{countryIso2}/{personalNameFull} | [USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
[**community_engage_full_batch**](PersonalApi.md#community_engage_full_batch) | **POST** /api2/json/communityEngageFullBatch | Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
[**corridor**](PersonalApi.md#corridor) | **GET** /api2/json/corridor/{countryIso2From}/{firstNameFrom}/{lastNameFrom}/{countryIso2To}/{firstNameTo}/{lastNameTo} | [USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)
[**corridor_batch**](PersonalApi.md#corridor_batch) | **POST** /api2/json/corridorBatch | [USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)
[**country**](PersonalApi.md#country) | **GET** /api2/json/country/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
[**country_batch**](PersonalApi.md#country_batch) | **POST** /api2/json/countryBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
[**country_fn_ln**](PersonalApi.md#country_fn_ln) | **GET** /api2/json/countryFnLn/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
[**country_fn_ln_batch**](PersonalApi.md#country_fn_ln_batch) | **POST** /api2/json/countryFnLnBatch | [USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
[**diaspora**](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.)
[**diaspora_batch**](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.)
[**diaspora_full**](PersonalApi.md#diaspora_full) | **GET** /api2/json/diasporaFull/{countryIso2}/{personalNameFull} | [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.)
[**diaspora_full_batch**](PersonalApi.md#diaspora_full_batch) | **POST** /api2/json/diasporaFullBatch | [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.)
[**gender**](PersonalApi.md#gender) | **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.
[**gender1**](PersonalApi.md#gender1) | **GET** /api2/json/gender/{firstName}/{lastName} | Infer the likely gender of a name.
[**gender_batch**](PersonalApi.md#gender_batch) | **POST** /api2/json/genderBatch | Infer the likely gender of up to 100 names, detecting automatically the cultural context.
[**gender_full**](PersonalApi.md#gender_full) | **GET** /api2/json/genderFull/{fullName} | Infer the likely gender of a full name, ex. John H. Smith
[**gender_full_batch**](PersonalApi.md#gender_full_batch) | **POST** /api2/json/genderFullBatch | Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
[**gender_full_geo**](PersonalApi.md#gender_full_geo) | **GET** /api2/json/genderFullGeo/{fullName}/{countryIso2} | Infer the likely gender of a full name, given a local context (ISO2 country code).
[**gender_full_geo_batch**](PersonalApi.md#gender_full_geo_batch) | **POST** /api2/json/genderFullGeoBatch | Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
[**gender_geo**](PersonalApi.md#gender_geo) | **GET** /api2/json/genderGeo/{firstName}/{lastName}/{countryIso2} | Infer the likely gender of a name, given a local context (ISO2 country code).
[**gender_geo_batch**](PersonalApi.md#gender_geo_batch) | **POST** /api2/json/genderGeoBatch | Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
[**origin**](PersonalApi.md#origin) | **GET** /api2/json/origin/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
[**origin_batch**](PersonalApi.md#origin_batch) | **POST** /api2/json/originBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
[**origin_full**](PersonalApi.md#origin_full) | **GET** /api2/json/originFull/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
[**origin_full_batch**](PersonalApi.md#origin_full_batch) | **POST** /api2/json/originFullBatch | [USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
[**parse_name**](PersonalApi.md#parse_name) | **GET** /api2/json/parseName/{nameFull} | Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
[**parse_name_batch**](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.
[**parse_name_geo**](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.
[**parse_name_geo_batch**](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.
[**religion2**](PersonalApi.md#religion2) | **GET** /api2/json/religion/{countryIso2}/{subDivisionIso31662}/{firstName}/{lastName} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal first/last name. NB: only for INDIA (as of current version).
[**religion_batch**](PersonalApi.md#religion_batch) | **POST** /api2/json/religionBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.
[**religion_full**](PersonalApi.md#religion_full) | **GET** /api2/json/religionFull/{countryIso2}/{subDivisionIso31662}/{personalNameFull} | [USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).
[**religion_full_batch**](PersonalApi.md#religion_full_batch) | **POST** /api2/json/religionFullBatch | [USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.
[**subclassification**](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').
[**subclassification_batch**](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').
[**subclassification_full**](PersonalApi.md#subclassification_full) | **GET** /api2/json/subclassificationFull/{countryIso2}/{fullName} | [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').
[**subclassification_full_batch**](PersonalApi.md#subclassification_full_batch) | **POST** /api2/json/subclassificationFullBatch | [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').
[**us_race_ethnicity**](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).
[**us_race_ethnicity_batch**](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).
[**us_race_ethnicity_full**](PersonalApi.md#us_race_ethnicity_full) | **GET** /api2/json/usRaceEthnicityFull/{personalNameFull} | [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).
[**us_race_ethnicity_full_batch**](PersonalApi.md#us_race_ethnicity_full_batch) | **POST** /api2/json/usRaceEthnicityFullBatch | [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).
[**us_race_ethnicity_z_i_p5**](PersonalApi.md#us_race_ethnicity_z_i_p5) | **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).
[**us_zip_race_ethnicity_batch**](PersonalApi.md#us_zip_race_ethnicity_batch) | **POST** /api2/json/usZipRaceEthnicityBatch | [USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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).
# **community_engage**
> community_engage(_api::PersonalApi, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> CommunityEngageOut, OpenAPI.Clients.ApiResponse <br/>
> community_engage(_api::PersonalApi, response_stream::Channel, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ CommunityEngageOut }, OpenAPI.Clients.ApiResponse
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**CommunityEngageOut**](CommunityEngageOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **community_engage_batch**
> community_engage_batch(_api::PersonalApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchCommunityEngageOut, OpenAPI.Clients.ApiResponse <br/>
> community_engage_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchCommunityEngageOut }, OpenAPI.Clients.ApiResponse
Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names |
### Return type
[**BatchCommunityEngageOut**](BatchCommunityEngageOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **community_engage_full**
> community_engage_full(_api::PersonalApi, country_iso2::String, personal_name_full::String; _mediaType=nothing) -> CommunityEngageOut, OpenAPI.Clients.ApiResponse <br/>
> community_engage_full(_api::PersonalApi, response_stream::Channel, country_iso2::String, personal_name_full::String; _mediaType=nothing) -> Channel{ CommunityEngageOut }, OpenAPI.Clients.ApiResponse
[USES 20 UNITS PER NAME] Infer the likely ethnicity/diaspora, country, gender of a personal name, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**CommunityEngageOut**](CommunityEngageOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **community_engage_full_batch**
> community_engage_full_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchCommunityEngageFullOut, OpenAPI.Clients.ApiResponse <br/>
> community_engage_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchCommunityEngageFullOut }, OpenAPI.Clients.ApiResponse
Infer the likely ethnicity/diaspora, country, gender of up to 100 personal names, given a country of residence ISO2 code (ex. US, CA, AU, NZ etc.) for community engagement (require special module/pricing)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchCommunityEngageFullOut**](BatchCommunityEngageFullOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **corridor**
> corridor(_api::PersonalApi, country_iso2_from::String, first_name_from::String, last_name_from::String, country_iso2_to::String, first_name_to::String, last_name_to::String; _mediaType=nothing) -> CorridorOut, OpenAPI.Clients.ApiResponse <br/>
> corridor(_api::PersonalApi, response_stream::Channel, country_iso2_from::String, first_name_from::String, last_name_from::String, country_iso2_to::String, first_name_to::String, last_name_to::String; _mediaType=nothing) -> Channel{ CorridorOut }, OpenAPI.Clients.ApiResponse
[USES 20 UNITS PER NAME COUPLE] Infer several classifications for a cross border interaction between names (ex. remit, travel, intl com)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2_from** | **String**| | [default to nothing]
**first_name_from** | **String**| | [default to nothing]
**last_name_from** | **String**| | [default to nothing]
**country_iso2_to** | **String**| | [default to nothing]
**first_name_to** | **String**| | [default to nothing]
**last_name_to** | **String**| | [default to nothing]
### Return type
[**CorridorOut**](CorridorOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **corridor_batch**
> corridor_batch(_api::PersonalApi; batch_corridor_in=nothing, _mediaType=nothing) -> BatchCorridorOut, OpenAPI.Clients.ApiResponse <br/>
> corridor_batch(_api::PersonalApi, response_stream::Channel; batch_corridor_in=nothing, _mediaType=nothing) -> Channel{ BatchCorridorOut }, OpenAPI.Clients.ApiResponse
[USES 20 UNITS PER NAME PAIR] Infer several classifications for up to 100 cross border interaction between names (ex. remit, travel, intl com)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_corridor_in** | [**BatchCorridorIn**](BatchCorridorIn.md)| A list of name pairs, with country code (nameFrom -> nameTo). |
### Return type
[**BatchCorridorOut**](BatchCorridorOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **country**
> country(_api::PersonalApi, personal_name_full::String; _mediaType=nothing) -> PersonalNameGeoOut, OpenAPI.Clients.ApiResponse <br/>
> country(_api::PersonalApi, response_stream::Channel, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameGeoOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal full name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameGeoOut**](PersonalNameGeoOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **country_batch**
> country_batch(_api::PersonalApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameGeoOut, OpenAPI.Clients.ApiResponse <br/>
> country_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGeoOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal full names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameGeoOut**](BatchPersonalNameGeoOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **country_fn_ln**
> country_fn_ln(_api::PersonalApi, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameOriginedOut, OpenAPI.Clients.ApiResponse <br/>
> country_fn_ln(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameOriginedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of residence of a personal first / last name, or one surname. Assumes names as they are in the country of residence OR the country of origin.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **country_fn_ln_batch**
> country_fn_ln_batch(_api::PersonalApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGeoOut, OpenAPI.Clients.ApiResponse <br/>
> country_fn_ln_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGeoOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of residence of up to 100 personal first / last names, or surnames. Assumes names as they are in the country of residence OR the country of origin.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameGeoOut**](BatchFirstLastNameGeoOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **diaspora**
> diaspora(_api::PersonalApi, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameDiasporaedOut, OpenAPI.Clients.ApiResponse <br/>
> diaspora(_api::PersonalApi, response_stream::Channel, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameDiasporaedOut }, OpenAPI.Clients.ApiResponse
[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.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameDiasporaedOut**](FirstLastNameDiasporaedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **diaspora_batch**
> diaspora_batch(_api::PersonalApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchFirstLastNameDiasporaedOut, OpenAPI.Clients.ApiResponse <br/>
> diaspora_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameDiasporaedOut }, OpenAPI.Clients.ApiResponse
[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.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameDiasporaedOut**](BatchFirstLastNameDiasporaedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **diaspora_full**
> diaspora_full(_api::PersonalApi, country_iso2::String, personal_name_full::String; _mediaType=nothing) -> PersonalNameDiasporaedOut, OpenAPI.Clients.ApiResponse <br/>
> diaspora_full(_api::PersonalApi, response_stream::Channel, country_iso2::String, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameDiasporaedOut }, OpenAPI.Clients.ApiResponse
[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.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameDiasporaedOut**](PersonalNameDiasporaedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **diaspora_full_batch**
> diaspora_full_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameDiasporaedOut, OpenAPI.Clients.ApiResponse <br/>
> diaspora_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameDiasporaedOut }, OpenAPI.Clients.ApiResponse
[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.)
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameDiasporaedOut**](BatchPersonalNameDiasporaedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender**
> gender(_api::PersonalApi, first_name::String; _mediaType=nothing) -> FirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender(_api::PersonalApi, response_stream::Channel, first_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
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.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender1**
> gender1(_api::PersonalApi, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender1(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a name.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_batch**
> gender_batch(_api::PersonalApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 names, detecting automatically the cultural context.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_full**
> gender_full(_api::PersonalApi, full_name::String; _mediaType=nothing) -> PersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_full(_api::PersonalApi, response_stream::Channel, full_name::String; _mediaType=nothing) -> Channel{ PersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a full name, ex. John H. Smith
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**full_name** | **String**| | [default to nothing]
### Return type
[**PersonalNameGenderedOut**](PersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_full_batch**
> gender_full_batch(_api::PersonalApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 full names, detecting automatically the cultural context.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameGenderedOut**](BatchPersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_full_geo**
> gender_full_geo(_api::PersonalApi, full_name::String, country_iso2::String; _mediaType=nothing) -> PersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_full_geo(_api::PersonalApi, response_stream::Channel, full_name::String, country_iso2::String; _mediaType=nothing) -> Channel{ PersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a full name, given a local context (ISO2 country code).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**full_name** | **String**| | [default to nothing]
**country_iso2** | **String**| | [default to nothing]
### Return type
[**PersonalNameGenderedOut**](PersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_full_geo_batch**
> gender_full_geo_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_full_geo_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 full names, with a given cultural context (country ISO2 code).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names, with a country ISO2 code |
### Return type
[**BatchPersonalNameGenderedOut**](BatchPersonalNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_geo**
> gender_geo(_api::PersonalApi, first_name::String, last_name::String, country_iso2::String; _mediaType=nothing) -> FirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_geo(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String, country_iso2::String; _mediaType=nothing) -> Channel{ FirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of a name, given a local context (ISO2 country code).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
**country_iso2** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGenderedOut**](FirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **gender_geo_batch**
> gender_geo_batch(_api::PersonalApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGenderedOut, OpenAPI.Clients.ApiResponse <br/>
> gender_geo_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGenderedOut }, OpenAPI.Clients.ApiResponse
Infer the likely gender of up to 100 names, each given a local context (ISO2 country code).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of names, with country code. |
### Return type
[**BatchFirstLastNameGenderedOut**](BatchFirstLastNameGenderedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **origin**
> origin(_api::PersonalApi, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameOriginedOut, OpenAPI.Clients.ApiResponse <br/>
> origin(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameOriginedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameOriginedOut**](FirstLastNameOriginedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **origin_batch**
> origin_batch(_api::PersonalApi; batch_first_last_name_in=nothing, _mediaType=nothing) -> BatchFirstLastNameOriginedOut, OpenAPI.Clients.ApiResponse <br/>
> origin_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameOriginedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_in** | [**BatchFirstLastNameIn**](BatchFirstLastNameIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameOriginedOut**](BatchFirstLastNameOriginedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **origin_full**
> origin_full(_api::PersonalApi, personal_name_full::String; _mediaType=nothing) -> PersonalNameOriginedOut, OpenAPI.Clients.ApiResponse <br/>
> origin_full(_api::PersonalApi, response_stream::Channel, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameOriginedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of origin of a personal name. Assumes names as they are in the country of origin. For US, CA, AU, NZ and other melting-pots : use 'diaspora' instead.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameOriginedOut**](PersonalNameOriginedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **origin_full_batch**
> origin_full_batch(_api::PersonalApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameOriginedOut, OpenAPI.Clients.ApiResponse <br/>
> origin_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameOriginedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely country of origin of up to 100 names, detecting automatically the cultural context.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameOriginedOut**](BatchPersonalNameOriginedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_name**
> parse_name(_api::PersonalApi, name_full::String; _mediaType=nothing) -> PersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_name(_api::PersonalApi, response_stream::Channel, name_full::String; _mediaType=nothing) -> Channel{ PersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameParsedOut**](PersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_name_batch**
> parse_name_batch(_api::PersonalApi; batch_personal_name_in=nothing, _mediaType=nothing) -> BatchPersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_name_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
Infer the likely first/last name structure of a name, ex. John Smith or SMITH, John or SMITH; John.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_in** | [**BatchPersonalNameIn**](BatchPersonalNameIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameParsedOut**](BatchPersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_name_geo**
> parse_name_geo(_api::PersonalApi, name_full::String, country_iso2::String; _mediaType=nothing) -> PersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_name_geo(_api::PersonalApi, response_stream::Channel, name_full::String, country_iso2::String; _mediaType=nothing) -> Channel{ PersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
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.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**name_full** | **String**| | [default to nothing]
**country_iso2** | **String**| | [default to nothing]
### Return type
[**PersonalNameParsedOut**](PersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **parse_name_geo_batch**
> parse_name_geo_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameParsedOut, OpenAPI.Clients.ApiResponse <br/>
> parse_name_geo_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameParsedOut }, OpenAPI.Clients.ApiResponse
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.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameParsedOut**](BatchPersonalNameParsedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion2**
> religion2(_api::PersonalApi, country_iso2::String, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion2(_api::PersonalApi, response_stream::Channel, country_iso2::String, sub_division_iso31662::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of a personal first/last name. NB: only for INDIA (as of current version).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**sub_division_iso31662** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameReligionedOut**](FirstLastNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion_batch**
> religion_batch(_api::PersonalApi; batch_first_last_name_geo_subdivision_in=nothing, _mediaType=nothing) -> BatchFirstLastNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal first/last names. NB: only for India as of currently.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_subdivision_in** | [**BatchFirstLastNameGeoSubdivisionIn**](BatchFirstLastNameGeoSubdivisionIn.md)| A list of personal first / last names |
### Return type
[**BatchFirstLastNameReligionedOut**](BatchFirstLastNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion_full**
> religion_full(_api::PersonalApi, country_iso2::String, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> PersonalNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion_full(_api::PersonalApi, response_stream::Channel, country_iso2::String, sub_division_iso31662::String, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of a personal full name. NB: only for INDIA (as of current version).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**sub_division_iso31662** | **String**| | [default to nothing]
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameReligionedOut**](PersonalNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **religion_full_batch**
> religion_full_batch(_api::PersonalApi; batch_personal_name_geo_subdivision_in=nothing, _mediaType=nothing) -> BatchPersonalNameReligionedOut, OpenAPI.Clients.ApiResponse <br/>
> religion_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_subdivision_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameReligionedOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer the likely religion of up to 100 personal full names. NB: only for India as of currently.
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_subdivision_in** | [**BatchPersonalNameGeoSubdivisionIn**](BatchPersonalNameGeoSubdivisionIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameReligionedOut**](BatchPersonalNameReligionedOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification**
> subclassification(_api::PersonalApi, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification(_api::PersonalApi, response_stream::Channel, country_iso2::String, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[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').
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGeoSubclassificationOut**](FirstLastNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_batch**
> subclassification_batch(_api::PersonalApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchFirstLastNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[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').
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameGeoSubclassificationOut**](BatchFirstLastNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_full**
> subclassification_full(_api::PersonalApi, country_iso2::String, full_name::String; _mediaType=nothing) -> FirstLastNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_full(_api::PersonalApi, response_stream::Channel, country_iso2::String, full_name::String; _mediaType=nothing) -> Channel{ FirstLastNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[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').
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**country_iso2** | **String**| | [default to nothing]
**full_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameGeoSubclassificationOut**](FirstLastNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **subclassification_full_batch**
> subclassification_full_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameGeoSubclassificationOut, OpenAPI.Clients.ApiResponse <br/>
> subclassification_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameGeoSubclassificationOut }, OpenAPI.Clients.ApiResponse
[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').
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameGeoSubclassificationOut**](BatchPersonalNameGeoSubclassificationOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_race_ethnicity**
> us_race_ethnicity(_api::PersonalApi, first_name::String, last_name::String; _mediaType=nothing) -> FirstLastNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_race_ethnicity(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String; _mediaType=nothing) -> Channel{ FirstLastNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
### Return type
[**FirstLastNameUSRaceEthnicityOut**](FirstLastNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_race_ethnicity_batch**
> us_race_ethnicity_batch(_api::PersonalApi; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> BatchFirstLastNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_race_ethnicity_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_in** | [**BatchFirstLastNameGeoIn**](BatchFirstLastNameGeoIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameUSRaceEthnicityOut**](BatchFirstLastNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_race_ethnicity_full**
> us_race_ethnicity_full(_api::PersonalApi, personal_name_full::String; _mediaType=nothing) -> PersonalNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_race_ethnicity_full(_api::PersonalApi, response_stream::Channel, personal_name_full::String; _mediaType=nothing) -> Channel{ PersonalNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**personal_name_full** | **String**| | [default to nothing]
### Return type
[**PersonalNameUSRaceEthnicityOut**](PersonalNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_race_ethnicity_full_batch**
> us_race_ethnicity_full_batch(_api::PersonalApi; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> BatchPersonalNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_race_ethnicity_full_batch(_api::PersonalApi, response_stream::Channel; batch_personal_name_geo_in=nothing, _mediaType=nothing) -> Channel{ BatchPersonalNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_personal_name_geo_in** | [**BatchPersonalNameGeoIn**](BatchPersonalNameGeoIn.md)| A list of personal names |
### Return type
[**BatchPersonalNameUSRaceEthnicityOut**](BatchPersonalNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_race_ethnicity_z_i_p5**
> us_race_ethnicity_z_i_p5(_api::PersonalApi, first_name::String, last_name::String, zip5_code::String; _mediaType=nothing) -> FirstLastNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_race_ethnicity_z_i_p5(_api::PersonalApi, response_stream::Channel, first_name::String, last_name::String, zip5_code::String; _mediaType=nothing) -> Channel{ FirstLastNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
**first_name** | **String**| | [default to nothing]
**last_name** | **String**| | [default to nothing]
**zip5_code** | **String**| | [default to nothing]
### Return type
[**FirstLastNameUSRaceEthnicityOut**](FirstLastNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
# **us_zip_race_ethnicity_batch**
> us_zip_race_ethnicity_batch(_api::PersonalApi; batch_first_last_name_geo_zipped_in=nothing, _mediaType=nothing) -> BatchFirstLastNameUSRaceEthnicityOut, OpenAPI.Clients.ApiResponse <br/>
> us_zip_race_ethnicity_batch(_api::PersonalApi, response_stream::Channel; batch_first_last_name_geo_zipped_in=nothing, _mediaType=nothing) -> Channel{ BatchFirstLastNameUSRaceEthnicityOut }, OpenAPI.Clients.ApiResponse
[USES 10 UNITS PER NAME] Infer up-to 100 US resident's likely race/ethnicity according to US Census taxonomy, with (optional) ZIP code. 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).
### Required Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_api** | **PersonalApi** | API context |
### Optional Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**batch_first_last_name_geo_zipped_in** | [**BatchFirstLastNameGeoZippedIn**](BatchFirstLastNameGeoZippedIn.md)| A list of personal names |
### Return type
[**BatchFirstLastNameUSRaceEthnicityOut**](BatchFirstLastNameUSRaceEthnicityOut.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#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1347 | # PersonalNameCastegroupOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**name** | **String** | The input name. | [optional] [default to nothing]
**score** | **Float64** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**castegroup** | **String** | Most likely caste group | [optional] [default to nothing]
**castegroupAlt** | **String** | Second best alternative : caste group | [optional] [default to nothing]
**castegroupTop** | **Vector{String}** | List caste group (top 10) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for country to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for country OR countryAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2181 | # PersonalNameDiasporaedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**name** | **String** | The input name. | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Diaspora score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**ethnicityAlt** | **String** | The second best alternative ethnicity | [optional] [default to nothing]
**ethnicity** | **String** | The most likely ethnicity | [optional] [default to nothing]
**lifted** | **Bool** | Indicates if the output ethnicity is based on machine learning only, or further lifted as a known fact by a country-specific rule. Let us know if you believe ethnicity is incorrect on a specific case where lifted is true. | [optional] [default to nothing]
**countryIso2** | **String** | From input data, the countryIso2 of geographic context (US,CA etc.) | [optional] [default to nothing]
**ethnicitiesTop** | **Vector{String}** | List most likely ethnicities (top 10) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for ethnicity to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for ethnicity OR ethnicityAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**religionStats** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, assuming ethnicity is correctly predicted. | [optional] [default to nothing]
**religionStatsAlt** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1123 | # PersonalNameGenderedOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**name** | **String** | The input name. | [optional] [default to nothing]
**likelyGender** | **String** | Most likely gender | [optional] [default to nothing]
**genderScale** | **Float64** | Compatibility to NamSor_v1 Gender Scale M[-1..U..+1]F value. | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Gender score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for inferred gender to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 443 | # PersonalNameGeoIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 2014 | # PersonalNameGeoOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**name** | **String** | The input name. | [optional] [default to nothing]
**score** | **Float64** | Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**country** | **String** | Most likely country | [optional] [default to nothing]
**countryAlt** | **String** | Second best alternative : country | [optional] [default to nothing]
**region** | **String** | Most likely region (based on country ISO2 code) | [optional] [default to nothing]
**topRegion** | **String** | Most likely top region (based on country ISO2 code) | [optional] [default to nothing]
**subRegion** | **String** | Most likely sub region (based on country ISO2 code) | [optional] [default to nothing]
**countriesTop** | **Vector{String}** | List countries (top 10) | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for country to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for country OR countryAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**religionStats** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, assuming country is correctly predicted. | [optional] [default to nothing]
**religionStatsAlt** | [**Vector{ReligionStatOut}**](ReligionStatOut.md) | Geographic religious statistics, for country best alternative. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 1614 | # PersonalNameGeoSubclassificationOut
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**script** | **String** | | [optional] [default to nothing]
**id** | **String** | | [optional] [default to nothing]
**explanation** | **String** | | [optional] [default to nothing]
**name** | **String** | The input name. | [optional] [default to nothing]
**countryIso2** | **String** | The input country ISO2 code | [optional] [default to nothing]
**subClassification** | **String** | Most likely subclassification ISO_3166-2 code | [optional] [default to nothing]
**subClassificationAlt** | **String** | Second best alternative : subclassification ISO_3166-2 code | [optional] [default to nothing]
**subclassificationTop** | **Vector{String}** | List subclassification ISO_3166-2 codes (top 10) | [optional] [default to nothing]
**score** | **Float64** | Compatibility to NamSor_v1 Origin score value. Higher score is better, but score is not normalized. Use calibratedProbability if available. | [optional] [default to nothing]
**probabilityCalibrated** | **Float64** | The calibrated probability for subclassification to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
**probabilityAltCalibrated** | **Float64** | The calibrated probability for subclassification OR subclassificationAlt to have been guessed correctly. -1 = still calibrating. | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 523 | # PersonalNameGeoSubdivisionIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name** | **String** | | [optional] [default to nothing]
**countryIso2** | **String** | | [optional] [default to nothing]
**subdivisionIso** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
|
[
"MIT"
] | 0.1.0 | 2d6ab091a1f4af72f40a76fe35b2c01982aa0bbf | docs | 374 | # PersonalNameIn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **String** | | [optional] [default to nothing]
**name** | **String** | | [optional] [default to nothing]
[[Back to Model list]](../README.md#models) [[Back to API list]](../README.md#api-endpoints) [[Back to README]](../README.md)
| NamSor | https://github.com/NeroBlackstone/NamSor.jl.git |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.