Name AI Name operations.
AI-powered Name API.
This API should be used to:
Determine a person’s gender from the name.
Complete name using given starting characters.
Compare names to determine similarity.
Format name.
Parse a name from the email address.
Complete
The call proposes k most probable names for given starting characters.
Returns AiNameWeightedVariants model. Requires:
request
Complete method request. Type: AiNameCompleteRequest .
Expand
Expands a person’s name into a list of possible alternatives using options for expanding instructions.
Returns AiNameWeightedVariants model. Requires:
request
Expand method request. Type: AiNameExpandRequest .
ExpandParsed
Expands a person’s parsed name into a list of possible alternatives using options for expanding instructions.
Returns AiNameWeightedVariants model. Requires:
request
Parsed name with options. Type: AiNameParsedRequest .
C#
var request = new AiNameParsedRequest
{
ParsedName = new List < AiNameComponent >
{
new AiNameComponent
{
Value = "John" ,
Category = "FirstName" ,
Score = 0.95
},
new AiNameComponent
{
Value = "Cane" ,
Category = "LastName" ,
Score = 0.5 ,
Position = 5
},
new AiNameComponent
{
Value = "%F%L" ,
Category = "Format"
},
new AiNameComponent
{
Value = "0.5" ,
Category = "Score" ,
Score = 0.5
}
}
};
Java
AiNameParsedRequest request = Models . aiNameParsedRequest ()
. parsedName ( Arrays .< AiNameComponent > asList (
Models . aiNameComponent ()
. value ( "John" )
. category ( "FirstName" )
. score ( 0 . 95 )
. build (),
Models . aiNameComponent ()
. value ( "Cane" )
. category ( "LastName" )
. score ( 0 . 5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( "%F%L" )
. category ( "Format" )
. build (),
Models . aiNameComponent ()
. value ( "0.5" )
. category ( "Score" )
. score ( 0 . 5 )
. build ()))
. build ();
Python
request = models . AiNameParsedRequest (
parsed_name = [
models . AiNameComponent (
value = 'John' ,
category = 'FirstName' ,
score = 0.95 ),
models . AiNameComponent (
value = 'Cane' ,
category = 'LastName' ,
score = 0.5 ,
position = 5 ),
models . AiNameComponent (
value = ' %F %L' ,
category = 'Format' ),
models . AiNameComponent (
value = '0.5' ,
category = 'Score' ,
score = 0.5 )])
Ruby
request = AiNameParsedRequest . new (
parsed_name : [
AiNameComponent . new (
value : 'John' ,
category : 'FirstName' ,
score : 0 . 95 ),
AiNameComponent . new (
value : 'Cane' ,
category : 'LastName' ,
score : 0 . 5 ,
position : 5 ),
AiNameComponent . new (
value : '%F%L' ,
category : 'Format' ),
AiNameComponent . new (
value : '0.5' ,
category : 'Score' ,
score : 0 . 5 ) ] )
Typescript
let request = Models . aiNameParsedRequest ()
. parsedName ([
Models . aiNameComponent ()
. value ( 'John' )
. category ( 'FirstName' )
. score ( 0.95 )
. build (),
Models . aiNameComponent ()
. value ( 'Cane' )
. category ( 'LastName' )
. score ( 0.5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( '%F%L' )
. category ( 'Format' )
. build (),
Models . aiNameComponent ()
. value ( '0.5' )
. category ( 'Score' )
. score ( 0.5 )
. build ()])
. build ();
PHP
$request = Models :: aiNameParsedRequest ()
-> parsedName ( array (
Models :: aiNameComponent ()
-> value ( 'John' )
-> category ( 'FirstName' )
-> score ( 0.95 )
-> build (),
Models :: aiNameComponent ()
-> value ( 'Cane' )
-> category ( 'LastName' )
-> score ( 0.5 )
-> position ( 5 )
-> build (),
Models :: aiNameComponent ()
-> value ( '%F%L' )
-> category ( 'Format' )
-> build (),
Models :: aiNameComponent ()
-> value ( '0.5' )
-> category ( 'Score' )
-> score ( 0.5 )
-> build ()))
-> build ();
Formats a person’s name in correct case and name order using options for formatting instructions.
Returns AiNameFormatted model. Requires:
request
Format method request. Type: AiNameFormatRequest .
Formats a person’s parsed name in correct case and name order using options for formatting instructions.
Returns AiNameFormatted model. Requires:
request
Parsed name with options. Type: AiNameParsedRequest .
C#
var request = new AiNameParsedRequest
{
ParsedName = new List < AiNameComponent >
{
new AiNameComponent
{
Value = "John" ,
Category = "FirstName" ,
Score = 0.95
},
new AiNameComponent
{
Value = "Cane" ,
Category = "LastName" ,
Score = 0.5 ,
Position = 5
},
new AiNameComponent
{
Value = "%F%L" ,
Category = "Format"
},
new AiNameComponent
{
Value = "0.5" ,
Category = "Score" ,
Score = 0.5
}
}
};
Java
AiNameParsedRequest request = Models . aiNameParsedRequest ()
. parsedName ( Arrays .< AiNameComponent > asList (
Models . aiNameComponent ()
. value ( "John" )
. category ( "FirstName" )
. score ( 0 . 95 )
. build (),
Models . aiNameComponent ()
. value ( "Cane" )
. category ( "LastName" )
. score ( 0 . 5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( "%F%L" )
. category ( "Format" )
. build (),
Models . aiNameComponent ()
. value ( "0.5" )
. category ( "Score" )
. score ( 0 . 5 )
. build ()))
. build ();
Python
request = models . AiNameParsedRequest (
parsed_name = [
models . AiNameComponent (
value = 'John' ,
category = 'FirstName' ,
score = 0.95 ),
models . AiNameComponent (
value = 'Cane' ,
category = 'LastName' ,
score = 0.5 ,
position = 5 ),
models . AiNameComponent (
value = ' %F %L' ,
category = 'Format' ),
models . AiNameComponent (
value = '0.5' ,
category = 'Score' ,
score = 0.5 )])
Ruby
request = AiNameParsedRequest . new (
parsed_name : [
AiNameComponent . new (
value : 'John' ,
category : 'FirstName' ,
score : 0 . 95 ),
AiNameComponent . new (
value : 'Cane' ,
category : 'LastName' ,
score : 0 . 5 ,
position : 5 ),
AiNameComponent . new (
value : '%F%L' ,
category : 'Format' ),
AiNameComponent . new (
value : '0.5' ,
category : 'Score' ,
score : 0 . 5 ) ] )
Typescript
let request = Models . aiNameParsedRequest ()
. parsedName ([
Models . aiNameComponent ()
. value ( 'John' )
. category ( 'FirstName' )
. score ( 0.95 )
. build (),
Models . aiNameComponent ()
. value ( 'Cane' )
. category ( 'LastName' )
. score ( 0.5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( '%F%L' )
. category ( 'Format' )
. build (),
Models . aiNameComponent ()
. value ( '0.5' )
. category ( 'Score' )
. score ( 0.5 )
. build ()])
. build ();
PHP
$request = Models :: aiNameParsedRequest ()
-> parsedName ( array (
Models :: aiNameComponent ()
-> value ( 'John' )
-> category ( 'FirstName' )
-> score ( 0.95 )
-> build (),
Models :: aiNameComponent ()
-> value ( 'Cane' )
-> category ( 'LastName' )
-> score ( 0.5 )
-> position ( 5 )
-> build (),
Models :: aiNameComponent ()
-> value ( '%F%L' )
-> category ( 'Format' )
-> build (),
Models :: aiNameComponent ()
-> value ( '0.5' )
-> category ( 'Score' )
-> score ( 0.5 )
-> build ()))
-> build ();
Genderize
Detect person’s gender from name string.
Returns AiNameGenderHypothesisList model. Requires:
request
Genderize method request. Type: AiNameGenderizeRequest .
GenderizeParsed
Detect person’s gender from parsed name.
Returns AiNameGenderHypothesisList model. Requires:
request
Gender detection request data. Type: AiNameParsedRequest .
C#
var request = new AiNameParsedRequest
{
ParsedName = new List < AiNameComponent >
{
new AiNameComponent
{
Value = "John" ,
Category = "FirstName" ,
Score = 0.95
},
new AiNameComponent
{
Value = "Cane" ,
Category = "LastName" ,
Score = 0.5 ,
Position = 5
},
new AiNameComponent
{
Value = "%F%L" ,
Category = "Format"
},
new AiNameComponent
{
Value = "0.5" ,
Category = "Score" ,
Score = 0.5
}
}
};
Java
AiNameParsedRequest request = Models . aiNameParsedRequest ()
. parsedName ( Arrays .< AiNameComponent > asList (
Models . aiNameComponent ()
. value ( "John" )
. category ( "FirstName" )
. score ( 0 . 95 )
. build (),
Models . aiNameComponent ()
. value ( "Cane" )
. category ( "LastName" )
. score ( 0 . 5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( "%F%L" )
. category ( "Format" )
. build (),
Models . aiNameComponent ()
. value ( "0.5" )
. category ( "Score" )
. score ( 0 . 5 )
. build ()))
. build ();
Python
request = models . AiNameParsedRequest (
parsed_name = [
models . AiNameComponent (
value = 'John' ,
category = 'FirstName' ,
score = 0.95 ),
models . AiNameComponent (
value = 'Cane' ,
category = 'LastName' ,
score = 0.5 ,
position = 5 ),
models . AiNameComponent (
value = ' %F %L' ,
category = 'Format' ),
models . AiNameComponent (
value = '0.5' ,
category = 'Score' ,
score = 0.5 )])
Ruby
request = AiNameParsedRequest . new (
parsed_name : [
AiNameComponent . new (
value : 'John' ,
category : 'FirstName' ,
score : 0 . 95 ),
AiNameComponent . new (
value : 'Cane' ,
category : 'LastName' ,
score : 0 . 5 ,
position : 5 ),
AiNameComponent . new (
value : '%F%L' ,
category : 'Format' ),
AiNameComponent . new (
value : '0.5' ,
category : 'Score' ,
score : 0 . 5 ) ] )
Typescript
let request = Models . aiNameParsedRequest ()
. parsedName ([
Models . aiNameComponent ()
. value ( 'John' )
. category ( 'FirstName' )
. score ( 0.95 )
. build (),
Models . aiNameComponent ()
. value ( 'Cane' )
. category ( 'LastName' )
. score ( 0.5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( '%F%L' )
. category ( 'Format' )
. build (),
Models . aiNameComponent ()
. value ( '0.5' )
. category ( 'Score' )
. score ( 0.5 )
. build ()])
. build ();
PHP
$request = Models :: aiNameParsedRequest ()
-> parsedName ( array (
Models :: aiNameComponent ()
-> value ( 'John' )
-> category ( 'FirstName' )
-> score ( 0.95 )
-> build (),
Models :: aiNameComponent ()
-> value ( 'Cane' )
-> category ( 'LastName' )
-> score ( 0.5 )
-> position ( 5 )
-> build (),
Models :: aiNameComponent ()
-> value ( '%F%L' )
-> category ( 'Format' )
-> build (),
Models :: aiNameComponent ()
-> value ( '0.5' )
-> category ( 'Score' )
-> score ( 0.5 )
-> build ()))
-> build ();
Match
Compare people’s names. Uses options for comparing instructions.
Returns AiNameMatchResult model. Requires:
request
Match method request. Type: AiNameMatchRequest .
MatchParsed
Compare people’s parsed names and attributes. Uses options for comparing instructions.
Returns AiNameMatchResult model. Requires:
request
Parsed names to match. Type: AiNameMatchParsedRequest .
C#
var request = new AiNameMatchParsedRequest
{
OtherParsedName = new List < AiNameComponent >
{
new AiNameComponent
{
Value = "J" ,
Category = "FirstInitial" ,
Score = 1
},
new AiNameComponent
{
Value = "Cane" ,
Category = "LastName" ,
Score = 0.5 ,
Position = 3
},
new AiNameComponent
{
Value = "%f%L" ,
Category = "Format"
},
new AiNameComponent
{
Value = "0.5" ,
Category = "Score" ,
Score = 0.5
}
},
ParsedName = new List < AiNameComponent >
{
new AiNameComponent
{
Value = "John" ,
Category = "FirstName" ,
Score = 0.95
},
new AiNameComponent
{
Value = "Cane" ,
Category = "LastName" ,
Score = 0.5 ,
Position = 5
},
new AiNameComponent
{
Value = "%F%L" ,
Category = "Format"
},
new AiNameComponent
{
Value = "0.5" ,
Category = "Score" ,
Score = 0.5
}
}
};
Java
AiNameMatchParsedRequest request = Models . aiNameMatchParsedRequest ()
. otherParsedName ( Arrays .< AiNameComponent > asList (
Models . aiNameComponent ()
. value ( "J" )
. category ( "FirstInitial" )
. score ( 1 )
. build (),
Models . aiNameComponent ()
. value ( "Cane" )
. category ( "LastName" )
. score ( 0 . 5 )
. position ( 3 )
. build (),
Models . aiNameComponent ()
. value ( "%f%L" )
. category ( "Format" )
. build (),
Models . aiNameComponent ()
. value ( "0.5" )
. category ( "Score" )
. score ( 0 . 5 )
. build ()))
. parsedName ( Arrays .< AiNameComponent > asList (
Models . aiNameComponent ()
. value ( "John" )
. category ( "FirstName" )
. score ( 0 . 95 )
. build (),
Models . aiNameComponent ()
. value ( "Cane" )
. category ( "LastName" )
. score ( 0 . 5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( "%F%L" )
. category ( "Format" )
. build (),
Models . aiNameComponent ()
. value ( "0.5" )
. category ( "Score" )
. score ( 0 . 5 )
. build ()))
. build ();
Python
request = models . AiNameMatchParsedRequest (
other_parsed_name = [
models . AiNameComponent (
value = 'J' ,
category = 'FirstInitial' ,
score = 1 ),
models . AiNameComponent (
value = 'Cane' ,
category = 'LastName' ,
score = 0.5 ,
position = 3 ),
models . AiNameComponent (
value = ' %f %L' ,
category = 'Format' ),
models . AiNameComponent (
value = '0.5' ,
category = 'Score' ,
score = 0.5 )],
parsed_name = [
models . AiNameComponent (
value = 'John' ,
category = 'FirstName' ,
score = 0.95 ),
models . AiNameComponent (
value = 'Cane' ,
category = 'LastName' ,
score = 0.5 ,
position = 5 ),
models . AiNameComponent (
value = ' %F %L' ,
category = 'Format' ),
models . AiNameComponent (
value = '0.5' ,
category = 'Score' ,
score = 0.5 )])
Ruby
request = AiNameMatchParsedRequest . new (
other_parsed_name : [
AiNameComponent . new (
value : 'J' ,
category : 'FirstInitial' ,
score : 1 ),
AiNameComponent . new (
value : 'Cane' ,
category : 'LastName' ,
score : 0 . 5 ,
position : 3 ),
AiNameComponent . new (
value : '%f%L' ,
category : 'Format' ),
AiNameComponent . new (
value : '0.5' ,
category : 'Score' ,
score : 0 . 5 ) ] ,
parsed_name : [
AiNameComponent . new (
value : 'John' ,
category : 'FirstName' ,
score : 0 . 95 ),
AiNameComponent . new (
value : 'Cane' ,
category : 'LastName' ,
score : 0 . 5 ,
position : 5 ),
AiNameComponent . new (
value : '%F%L' ,
category : 'Format' ),
AiNameComponent . new (
value : '0.5' ,
category : 'Score' ,
score : 0 . 5 ) ] )
Typescript
let request = Models . aiNameMatchParsedRequest ()
. otherParsedName ([
Models . aiNameComponent ()
. value ( 'J' )
. category ( 'FirstInitial' )
. score ( 1 )
. build (),
Models . aiNameComponent ()
. value ( 'Cane' )
. category ( 'LastName' )
. score ( 0.5 )
. position ( 3 )
. build (),
Models . aiNameComponent ()
. value ( '%f%L' )
. category ( 'Format' )
. build (),
Models . aiNameComponent ()
. value ( '0.5' )
. category ( 'Score' )
. score ( 0.5 )
. build ()])
. parsedName ([
Models . aiNameComponent ()
. value ( 'John' )
. category ( 'FirstName' )
. score ( 0.95 )
. build (),
Models . aiNameComponent ()
. value ( 'Cane' )
. category ( 'LastName' )
. score ( 0.5 )
. position ( 5 )
. build (),
Models . aiNameComponent ()
. value ( '%F%L' )
. category ( 'Format' )
. build (),
Models . aiNameComponent ()
. value ( '0.5' )
. category ( 'Score' )
. score ( 0.5 )
. build ()])
. build ();
PHP
$request = Models :: aiNameMatchParsedRequest ()
-> otherParsedName ( array (
Models :: aiNameComponent ()
-> value ( 'J' )
-> category ( 'FirstInitial' )
-> score ( 1 )
-> build (),
Models :: aiNameComponent ()
-> value ( 'Cane' )
-> category ( 'LastName' )
-> score ( 0.5 )
-> position ( 3 )
-> build (),
Models :: aiNameComponent ()
-> value ( '%f%L' )
-> category ( 'Format' )
-> build (),
Models :: aiNameComponent ()
-> value ( '0.5' )
-> category ( 'Score' )
-> score ( 0.5 )
-> build ()))
-> parsedName ( array (
Models :: aiNameComponent ()
-> value ( 'John' )
-> category ( 'FirstName' )
-> score ( 0.95 )
-> build (),
Models :: aiNameComponent ()
-> value ( 'Cane' )
-> category ( 'LastName' )
-> score ( 0.5 )
-> position ( 5 )
-> build (),
Models :: aiNameComponent ()
-> value ( '%F%L' )
-> category ( 'Format' )
-> build (),
Models :: aiNameComponent ()
-> value ( '0.5' )
-> category ( 'Score' )
-> score ( 0.5 )
-> build ()))
-> build ();
Parse
Parse name to components.
Returns AiNameComponentList model. Requires:
request
Parse method request. Type: AiNameParseRequest .
ParseEmailAddress
Parse person’s name out of an email address.
Returns AiNameExtractedList model. Requires:
request
ParseEmailAddress method request. Type: AiNameParseEmailAddressRequest .
More APIs