POST: /profile/indexing
This endpoint allows you to index new Profile object.
Please find below an example of Json profile that could be submitted.
1
{
2
"consent_algorithmic": {
3
"owner": {
4
"parsing": true,
5
"revealing": false,
6
"embedding": true,
7
"searching": false,
8
"scoring": true,
9
"reasoning": false
10
},
11
"controller": {
12
"parsing": true,
13
"revealing": false,
14
"embedding": true,
15
"searching": false,
16
"scoring": true,
17
"reasoning": false
18
}
19
},
20
"info" : {
21
"full_name":"Harry Potter",
22
"first_name": "Harry",
23
"last_name": "Potter",
24
"date_birth": "1990-08-09T00:00:00+0000"
25
"email":"[email protected]",
26
"phone":"0202",
27
"gender": null,
28
"urls": {
29
"from_resume": [],
30
"linkedin":"",
31
"twitter":"",
32
"facebook":"",
33
"github":""},
34
"picture": "picture public url",
35
"location":{"text": null},
36
"summary": "Brief summary"
37
},
38
"text": "Harry Potter [email protected] 0202 Brief summary \
39
Mathematic Departement Developping Mathematicien University Description \
40
manual skill Creative spirit Writing skills Communication english football",
41
"experiences": [{
42
"date_start": {"iso8601": "2016-01-01T00:00:00"},
43
"date_end": {"iso8601": "2018-07-01T00:00:00"},
44
"title": "Lead",
45
"company": "Mathematic Departement",
46
"description": "Developping."
47
"location": {"text":"Paris"},
48
"certifications": [{
49
"name": "certificate exp",
50
"value": null
51
}],
52
"courses": [{
53
"name": "course exp",
54
"value": null
55
}],
56
"tasks": [{
57
"name": "task exp",
58
'value': null
59
}],
60
"skills": [{
61
"name": "skill exp",
62
"value": null,
63
"type" : "hard"
64
}]
65
}],
66
"experiences_duration":5,
67
"educations": [{
68
"date_start": {"iso8601": "2016-01-01T00:00:00"},
69
"date_end": {"iso8601": "2018-01-01T00:00:00"},
70
"title": "Mathematicien",
71
"school": "University",
72
"description": "Description",
73
"location": {"text":"Scotland", "lat":"lat", "lng": "lng"},
74
"certifications": [{
75
"name": "certificate edu",
76
"value": null
77
}],
78
"courses": [{
79
"name": "course edu",
80
"value": null
81
}],
82
"tasks": [{
83
"name": "task edu",
84
"value": null
85
}],
86
"skills": [{
87
"name": "skill edu",
88
"value": null,
89
"type" : "hard"
90
}]
91
}],
92
"educations_duration":4,
93
"certifications": [
94
{"name": "certificate exp", "value": null},
95
{"name": "certificate edu", "value": null}
96
],
97
"courses": [
98
{"name": "course exp", "value": null},
99
{"name": "cours edu", "value": null}],
100
"tasks": [
101
{"name": "task exp", "value": null},
102
{"name": "task edu", "value": null}],
103
"skills": [{"name":"manual skill", "type": "hard", "value": null},
104
{"name":"Creative spirit", "type": "soft", "value": null},
105
{"name":"Writing skills", "type": "hard", "value": null},
106
{"name":"Communication", "type": "soft", "value": null},
107
{"name": "skill edu", 'value': null, "type": "hard"}
108
{"name": "skill exp", 'value': null, "type": "hard"}],
109
"languages" : [{"name":"english", "value": null}],
110
"interests": [{"name":"football", "value": null}],
111
"tags":[{"name":"archive", "value": false}],
112
"metadatas":[],
113
"labels":[{"stage":"yes", "job_key":"job_key"}],
114
"attachments": []
115
}
Copied!
post
https://api.hrflow.ai
/v1/profile/indexing
/profile/indexing
It is highly recommended to post the profile with a text field combining First Name / Last Name , Summary and education / experience 's description.
date_start and date_end in Experience and Education are objects, or conversely the GET endpoint sends you back date_start and date_end as string
1
{"iso8601" : "2018-01-01T00:00:00"}
Copied!

Example

Python
Javascript
1
from hrflow import Hrflow
2
3
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
4
5
data = {
6
"reference" : "my_profile",
7
"consent_algorithmic": {
8
"owner": {
9
"parsing": True,
10
"revealing": False,
11
"embedding": True,
12
"searching": False,
13
"scoring": True,
14
"reasoning": False
15
},
16
"controller": {
17
"parsing": True,
18
"revealing": False,
19
"embedding": True,
20
"searching": False,
21
"scoring": True,
22
"reasoning": False
23
}
24
},
25
"info" : {
26
"full_name":"John Doe",
27
"first_name": "John",
28
"last_name": "Doe",
29
"date_birth": "1990-08-09T00:00:00+0000",
30
"email":"[email protected]",
31
"phone":"0212787656",
32
"gender": "Male",
33
"urls": {
34
"from_resume": [],
35
"linkedin":"",
36
"twitter":"",
37
"facebook":"",
38
"github":""},
39
"picture": "picture public url",
40
"location":{"text": None},
41
"summary": "Brief summary"
42
},
43
"text": "In this section should be the bulk text of the \
44
whole profile with all the sections",
45
"experiences": [{
46
"date_start": {"iso8601": "2016-01-01T00:00:00"},
47
"date_end": {"iso8601": "2018-07-01T00:00:00"},
48
"title": "Lead software engineer",
49
"company": "HrFlow.ai",
50
"description": "Developping backend web apps using Python and Django framework.",
51
"location": {"text":"Paris"},
52
"certifications": [{
53
"name": "AWS cloud certification",
54
"value": None
55
}],
56
"courses": [],
57
"tasks": [{
58
"name": "Continuous integration",
59
'value': None
60
}],
61
"skills": [{
62
"name": "Django",
63
"value": None,
64
"type" : "hard"
65
}]
66
}],
67
"experiences_duration":2.5,
68
"educations": [{
69
"date_start": {"iso8601": "2016-01-01T00:00:00"},
70
"date_end": {"iso8601": "2018-01-01T00:00:00"},
71
"title": "Msc in software engineering",
72
"school": "Ecole Centrale Paris",
73
"description": "Education description text",
74
"location": {"text":"Paris"},
75
"certifications": [{
76
"name": "certificate edu",
77
"value": None
78
}],
79
"courses": [{
80
"name": "Python programming",
81
"value": None
82
}],
83
"tasks": [],
84
"skills": []
85
}],
86
"educations_duration": 2,
87
"certifications": [
88
{"name": "certificate exp", "value": None},
89
{"name": "certificate edu", "value": None}
90
],
91
"courses": [
92
{"name": "course exp", "value": None},
93
{"name": "cours edu", "value": None}],
94
"tasks": [
95
{"name": "task exp", "value": None},
96
{"name": "task edu", "value": None}],
97
"skills": [{"name":"manual skill", "type": "hard", "value": None},
98
{"name":"Creative spirit", "type": "soft", "value": None},
99
{"name":"Writing skills", "type": "hard", "value": None},
100
{"name":"Communication", "type": "soft", "value": None},
101
{"name": "skill edu", 'value': None, "type": "hard"},
102
{"name": "skill exp", 'value': None, "type": "hard"}],
103
"languages" : [{"name":"english", "value": None}],
104
"interests": [{"name":"football", "value": None}],
105
"tags":[{"name":"job_reference", "value": "external_id"}],
106
"metadatas":[],
107
"labels":[],
108
"attachments": []
109
};
110
111
client.profile.indexing.add_json(source_key="source_key", profile_json=data)
Copied!
1
import Hrflow from 'hrflow';
2
const client = new Hrflow({
3
api_secret: 'Your API Key',
4
api_user: 'Your API user email',
5
});
6
7
const data = {
8
'consent_algorithmic': {
9
'owner': {
10
'parsing': true,
11
'revealing': false,
12
'embedding': true,
13
'searching': false,
14
'scoring': true,
15
'reasoning': false
16
},
17
'controller': {
18
'parsing': true,
19
'revealing': false,
20
'embedding': true,
21
'searching': false,
22
'scoring': true,
23
'reasoning': false
24
}
25
},
26
'info' : {
27
'full_name':'Harry Potter',
28
'first_name': 'Harry',
29
'last_name': 'Potter',
30
'date_birth': '1990-08-09T00:00:00+0000',
31
'email':'[email protected]',
32
'phone':'0202',
33
'gender': null,
34
'urls': {
35
'from_resume': [],
36
'linkedin': '',
37
'twitter': '',
38
'facebook': '',
39
'github': ''},
40
'picture': null,
41
'location':{'text': null},
42
'summary': 'Brief summary'
43
},
44
'text': 'Harry Potter [email protected] 0202 Brief summary Mathematic Departement Developping Mathematicien University Description manual skill Creative spirit Writing skills Communication english football',
45
'experiences': [{
46
'date_start': {'iso8601': '2018-01-01T00:00:00'},
47
'date_end': {'iso8601': '2018-07-01T00:00:00'},
48
'title': 'Lead',
49
'company': 'Mathematic Departement',
50
'description': 'Developping.',
51
'location': {'text':'Paris', "lat":"lat", "lng": "lng"},
52
'certifications': [{'name': 'certificate exp', 'value': null}],
53
'courses': [{'name': 'cours exp', 'value': null}],
54
'tasks': [{'name': 'tache exp', 'value': null}],
55
'skills': [{'name': 'skill exp', 'value' : null, 'type' : 'hard'}]
56
}],
57
'experiences_duration':5,
58
'educations': [{
59
'date_start': {'iso8601': '2016-01-01T00:00:00'},
60
'date_end': {'iso8601': '2018-01-01T00:00:00'},
61
'title': 'Mathematicien',
62
'school': 'University',
63
'description': 'Description',
64
'location': {'text':'Scotland', 'lat':'lat', 'lng': 'lng'},
65
'certifications': [{'name': 'certificate edu', 'value': null}],
66
'courses': [{'name': 'cours edu', 'value': null}],
67
'tasks': [{'name': 'tache edu', 'value': null}],
68
'skills': [{'name': 'skill edu', 'value': null, 'type' : 'hard'}]
69
}],
70
'educations_duration':4,
71
'certifications': [
72
{'name': 'certificate exp', 'value': null},
73
{'name': 'certificate edu', 'value': null}
74
],
75
'courses': [
76
{'name': 'cours exp', 'value': null},
77
{'name': 'cours edu', 'value': null}],
78
'tasks': [
79
{'name': 'tache exp', 'value': null},
80
{'name': 'tache edu', 'value': null}],
81
'skills': [
82
{'name': 'manual skill', 'type': 'hard', 'value': null},
83
{'name': 'Creative spirit', "type": 'soft', 'value': null},
84
{'name': 'Writing skills', "type": 'hard', 'value': null},
85
{'name': 'Communication', 'type': 'soft', "value": null},
86
{'name': 'skill edu', 'value': null, 'type': "hard"}
87
{'name': 'skill exp', 'value': null, 'type': "hard"}],
88
'languages' : [{'name':'english', 'value': null}],
89
'interests': [{'name':'football', 'value': null}],
90
'tags':[{'name':'archive', 'value': false}],
91
'metadatas':[],
92
'labels':[{'stage':'yes', 'job_key':'job_key'}],
93
'attachments': []
94
};
95
96
client.profile.indexing.addJson('source_key', data).then(response => {
97
console.log(respone);
98
// ...
99
});
Copied!
Last modified 1mo ago