-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1823 lines (1802 loc) · 62.7 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Nalantis API
description: |-
Nalantis' v2 REST API is a set of endpoints for semantic analysis and matching.
A few notes on the usage of the API:
- If an HTTP status code of 4xx or 5xx is returned then the response body contains an instance of ApiErrorResponse serialized as JSON.
- In case a fileURL can be specified with request instances then you first have to POST the binary file to the /files endpoint which returns the required URL.
- Wherever you can pass the id of a document (id or documentId parameter) you can either use the internal UUID or the external reference in the format 'ER:\<external reference\>' (e.g. ER:cv-john-doe.pdf).
- The external reference is unique per document type therefore a cv and a job may have the same external reference
contact:
name: API team
url: https://www.nalantis.com
email: apiteam@nalantis.com
version: 2.0.0
security:
- bearerAuthenticationJWT: []
tags:
- name: File
description: Resources for working with files (mainly uploading of binary files
which can then be used as input for other API endpoints)
- name: Semantic analysis
description: Resources for analysing text semantically
externalDocs:
description: Indepth view on semantic analysis & matching
url: https://tech.beworkhappy.com/
- name: Document
description: Resources for handling a collection of documents.
- name: Query
description: Resources for running queries, both keyword and semantic queries.
- name: Lexicon
description: Resources for working with lexica (like getting suggestions for inputs
etc.)
paths:
/v2/documents:
post:
tags:
- Document
description: |-
Add a new document. Returns the URI of the newly created resource in the response header.
**For a description of the custom fields format please see the CustomFields schema**.
If you are providing at least one of the location fields the automatic geo location analyzer is skipped and the values provided are used instead.
operationId: addDocument
requestBody:
description: Document index request
content:
application/xml:
schema:
$ref: '#/components/schemas/DocumentIndexRequest'
application/json:
schema:
$ref: '#/components/schemas/DocumentIndexRequest'
required: true
responses:
201:
description: CREATED - document has been indexed sucessfully. Location header
of response contains URL of the document.
400:
description: BAD REQUEST - in case file input stream or file disposition
is null.
404:
description: NOT FOUND - in case the binary document could not be retrieved.
409:
description: CONFLICT - in case a document with the same externalReference
already exists and the updateIfExists parameter is set to false.
455:
description: LANGUAGE NOT ALLOWED - the document language is not allowed.
456:
description: NO USABLE CONTENT - the document is empty or too short (might
also happen if the document only contains images).
/v2/documents/analyse:
post:
tags:
- Semantic analysis
description: Get the analysis of an uploaded document and return the result
in the SemanticAnalysisResponse.
operationId: analyseDocument
requestBody:
description: Analysis request
content:
application/xml:
schema:
$ref: '#/components/schemas/SemanticAnalysisRequest'
application/json:
schema:
$ref: '#/components/schemas/SemanticAnalysisRequest'
required: true
responses:
200:
description: The semantic analysis
content:
application/json:
schema:
$ref: '#/components/schemas/SemanticAnalysisResponse'
400:
description: BAD REQUEST - in case of missing or wrong input parameters.
404:
description: NOT FOUND - in case the document could not be retrieved.
455:
description: LANGUAGE NOT ALLOWED - the document language is not allowed
for this tenant.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
456:
description: NO USABLE CONTENT - the document is empty or too short (might
also happen if the document only contains images).
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
/v2/documents/query/keyword:
post:
tags:
- Query
description: |-
Find documents using keyword search. The query parameter in the request instance specifies the Solr query.
Please note: this search type can be used on all document types.
operationId: queryKeyword
requestBody:
description: Query request
content:
application/xml:
schema:
$ref: '#/components/schemas/QueryRequestHR'
application/json:
schema:
$ref: '#/components/schemas/QueryRequestHR'
required: true
responses:
200:
description: The query result
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponse'
400:
description: BAD REQUEST - in case of a missing or incorrect parameters.
/v2/documents/query/semantic/generic:
post:
tags:
- Query
description: |-
Run a generic semantic query on the indexed documents with the given parameters.
If a fileURL is specified in the request and the file has been POSTED to the /files endpoint then the file is automatically removed from the cache.
Please note: this search type can be used on other than HR document types.
operationId: querySemanticGeneric
requestBody:
description: Query request
content:
application/xml:
schema:
$ref: '#/components/schemas/QueryRequestGeneric'
application/json:
schema:
$ref: '#/components/schemas/QueryRequestGeneric'
required: true
responses:
200:
description: The query result
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponse'
400:
description: BAD REQUEST - in case of a missing or incorrect parameters.
/v2/documents/query/semantic/hr:
post:
tags:
- Query
description: |-
Find documents by using semantic matching. They query parameter in the request instance specifies (if set) the text content of the input.
If a fileURL is specified in the request and the file has been POSTED to the /files endpoint then the file is automatically removed from the cache.
Please note: this search type can be used on HR document types only (cv,job).
operationId: querySemanticHR
requestBody:
description: Query request
content:
application/xml:
schema:
$ref: '#/components/schemas/QueryRequestHR'
application/json:
schema:
$ref: '#/components/schemas/QueryRequestHR'
required: true
responses:
200:
description: The query result
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResponse'
400:
description: BAD REQUEST - in case of a missing or incorrect parameters.
/v2/documents/selection/all:
delete:
tags:
- Document
description: |-
Delete ALL documents.
__WARNING: Be very carefull with this method since there is no way back once you called this URL!!__
The query parameter 'confirmation' is used as a safety measure so it is not executed by accient: you have to specify YES-DELETE!, otherwise a BAD_REQUEST is returned.
operationId: deleteDocumentSelectionAll
parameters:
- name: confirmation
in: query
description: Safety measure - always specify 'YES-DELETE!'
required: true
schema:
type: string
responses:
200:
description: OK - documents have been deleted
400:
description: BAD REQUEST - in case of missing or wrong input parameters.
/v2/documents/selection/byQuery:
get:
tags:
- Document
description: |-
Do a keyword search for retrieveing all documents matching the given Solr query.
This is a shortcut/convenience version of the corresponding /documents/query/keyword POST endpoint for running keyword queries. If you encounter any issues because the query gets to complex or long please use the POST call instead.
operationId: getDocuments
parameters:
- name: q
in: query
description: Solr query to use for the keyword search (e.g. content:developer)
schema:
type: string
default: '*:*'
- name: filterQuery
in: query
description: Keyword query used for filtering the matching results. Has no
impact on the ranking.
schema:
type: string
- name: rows
in: query
description: Maximum number of returned documents
schema:
type: integer
format: int32
default: 10
- name: start
in: query
description: Start position of returned documents
schema:
type: integer
format: int32
default: 0
- name: sortBy[]
in: query
description: Specify the sort fields and sort order of the result. Can be
set multiple times.
schema:
type: array
items:
type: string
example: <fieldname>:[-1 | 0 | 1] (-1 ..desc, 0 .. unsorted, 1 .. asc)
- name: resultDetailLevel
in: query
description: Level of detail returned in the search result. 0 = light attribute
value set, 5 = medium set, 9 = full set
schema:
type: integer
format: int32
default: 5
example: 0..9
responses:
200:
description: OK - keyword search was successful.
400:
description: BAD REQUEST - in case of missing or illegal input parameters.
delete:
tags:
- Document
description: |-
Delete the documents which are found via the given query.
Please note: each document is deleted in its own transaction therefore if the delete of one document fails the process continues until all documents are handled.
operationId: deleteDocumentSelectionByQuery
parameters:
- name: q
in: query
description: Solr query to use for the delete (e.g. content:developer)
required: true
schema:
type: string
- name: numberOfWorkerThreads
in: query
description: Number of worker threads to use to delete documents in parallel
schema:
type: integer
format: int32
default: 10
example: 1..100
- name: docDiscoveryQueueDepth
in: query
description: Document discovery queue depth
schema:
type: integer
format: int32
default: 100
example: 100..10000
- name: dryRun
in: query
description: Determine the number of documents which would be deleted by this
query but do not actually perform any deletes
schema:
type: boolean
default: false
responses:
200:
description: OK - Returned object contains the total number of documents,
the number of successfully deleted and the number of failed documents.
content:
application/xml:
schema:
$ref: '#/components/schemas/DocumentProcessingStatistics'
application/json:
schema:
$ref: '#/components/schemas/DocumentProcessingStatistics'
400:
description: BAD REQUEST - in case of missing or wrong input parameters.
/v2/documents/{id}:
get:
tags:
- Document
description: Return the details about a specified document. The document is
identified by the id parameter.
operationId: getDocument
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
responses:
400:
description: BAD REQUEST - in case of missing id.
404:
description: NOT FOUND - in case a document with the specified id is not
found.
put:
tags:
- Document
description: |-
Update a document. Returns URI of updated resource in the response header.
**For a description of the custom fields format please see the CustomFields schema**.
If you are providing at least one of the location fields the automatic geo location analyzer is skipped and the values provided are used instead.
operationId: updateDocument
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
requestBody:
description: Document index request
content:
application/xml:
schema:
$ref: '#/components/schemas/DocumentIndexRequest'
application/json:
schema:
$ref: '#/components/schemas/DocumentIndexRequest'
required: true
responses:
200:
description: OK - document has been updated sucessfully. Location header
of response contains URL of the document.
400:
description: BAD REQUEST - in case file input stream or file disposition
is null.
404:
description: NOT FOUND - in case the document with the given id is not found
OR the binary document could not be retrieved.
409:
description: CONFLICT - in case a document with the same externalReference
already exists and the updateIfExists parameter is set to false.
455:
description: LANGUAGE NOT ALLOWED - the document language is not allowed.
456:
description: NO USABLE CONTENT - the document is empty or too short (might
also happen if the document only contains images).
delete:
tags:
- Document
description: Delete a specified document from the search index. The document
is identified by the id parameter.
operationId: deleteDocument
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
responses:
400:
description: BAD REQUEST - in case of missing id.
404:
description: NOT FOUND - in case a document with the specified id is not
found.
/v2/documents/{id}/conceptModifier:
put:
tags:
- Document
description: Adds (or updates) a word to a document. The word is resolved to
a concept of the given languages and then added / updated.
operationId: addOrUpdateConceptModifier
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
requestBody:
description: Request instance for adding (or updating) concept to the document
content:
application/xml:
schema:
$ref: '#/components/schemas/AddConceptModifierRequest'
application/json:
schema:
$ref: '#/components/schemas/AddConceptModifierRequest'
required: true
responses:
400:
description: BAD REQUEST - in case of missing or wrong input parameters.
404:
description: NOT FOUND - in case the referenced document is not found.
delete:
tags:
- Document
description: Deletes a word from a document. The word is resolved to a concept.
operationId: deleteConceptModifier
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
- name: word
in: query
description: Word to remove from the document
required: true
schema:
type: string
responses:
400:
description: BAD REQUEST - in case of missing or wrong input parameters.
404:
description: NOT FOUND - in case the referenced document is not found.
/v2/documents/{id}/customFields:
get:
tags:
- Document
description: |-
Get the custom fields stored for the specified document.
Please note: only JSON serialization is supported atm.
operationId: getCustomFields
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
responses:
400:
description: BAD REQUEST - in case of missing id.
404:
description: NOT FOUND - in case a document with the specified id is not
found.
put:
tags:
- Document
description: |-
Set the custom fields for the specified document.
Please note: only JSON serialization is supported atm.
operationId: setCustomFields
parameters:
- name: id
in: path
description: ID of the document
required: true
schema:
type: string
requestBody:
description: Custom fields to set
content:
application/xml:
schema:
type: object
additionalProperties:
type: string
description: "The custom fields can be used to store additional data\
\ with a document.\n\nThis type implements a Map with the fieldname\
\ as key and the value (as String) as value.\n\nThe ending of the\
\ field name determines the datatype:\n```\nnone or _s = string,\n\
_i = integer,\n_l = long\n_b = boolean (allowable values true|false)\n\
_f = float\n_d = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n\
```\nIf the field type is string a second field with suffix _tci\
\ is automatically added for case-independent search. The final\
\ field name for using it in keyword queries is constructed by adding\
\ the prefix 'cust_'. For instance if you add a field named 'ourDocID_s'\
\ the name to use in queries would be 'cust_ourDocID_s'. "
description: "The custom fields can be used to store additional data\
\ with a document.\n\nThis type implements a Map with the fieldname\
\ as key and the value (as String) as value.\n\nThe ending of the\
\ field name determines the datatype:\n```\nnone or _s = string,\n\
_i = integer,\n_l = long\n_b = boolean (allowable values true|false)\n\
_f = float\n_d = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n\
```\nIf the field type is string a second field with suffix _tci is\
\ automatically added for case-independent search. The final field\
\ name for using it in keyword queries is constructed by adding the\
\ prefix 'cust_'. For instance if you add a field named 'ourDocID_s'\
\ the name to use in queries would be 'cust_ourDocID_s'. "
xml:
name: customFields
application/json:
schema:
type: object
additionalProperties:
type: string
description: "The custom fields can be used to store additional data\
\ with a document.\n\nThis type implements a Map with the fieldname\
\ as key and the value (as String) as value.\n\nThe ending of the\
\ field name determines the datatype:\n```\nnone or _s = string,\n\
_i = integer,\n_l = long\n_b = boolean (allowable values true|false)\n\
_f = float\n_d = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n\
```\nIf the field type is string a second field with suffix _tci\
\ is automatically added for case-independent search. The final\
\ field name for using it in keyword queries is constructed by adding\
\ the prefix 'cust_'. For instance if you add a field named 'ourDocID_s'\
\ the name to use in queries would be 'cust_ourDocID_s'. "
description: "The custom fields can be used to store additional data\
\ with a document.\n\nThis type implements a Map with the fieldname\
\ as key and the value (as String) as value.\n\nThe ending of the\
\ field name determines the datatype:\n```\nnone or _s = string,\n\
_i = integer,\n_l = long\n_b = boolean (allowable values true|false)\n\
_f = float\n_d = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n\
```\nIf the field type is string a second field with suffix _tci is\
\ automatically added for case-independent search. The final field\
\ name for using it in keyword queries is constructed by adding the\
\ prefix 'cust_'. For instance if you add a field named 'ourDocID_s'\
\ the name to use in queries would be 'cust_ourDocID_s'. "
xml:
name: customFields
required: true
responses:
400:
description: BAD REQUEST - in case of missing id.
404:
description: NOT FOUND - in case a document with the specified id is not
found.
/v2/files:
post:
tags:
- File
description: |-
Store the given file in a cache for later use.
Please note: depending on the back-ends cache configuration the file gets removed from the cache automatically after some time.
operationId: uploadFileBinary
parameters:
- name: filename
in: query
description: Name of the posted file
schema:
type: string
requestBody:
content:
'*/*':
schema:
type: object
responses:
201:
description: CREATED - file has been successfully stored. Location field
of the the response contains the URL of the file.
400:
description: BAD REQUEST - if the file size is larger than the configured
maximum value.
/v2/files/{id}:
get:
tags:
- File
description: Get an uploaded file from the cache.
operationId: getFileBinary
parameters:
- name: id
in: path
description: Id of uploaded file
required: true
schema:
type: string
responses:
200:
description: OK - file has been found and returned.
404:
description: NOT FOUND - file with the given id has not been found in cache.
delete:
tags:
- File
description: Remove an uploaded file from the cache.
operationId: deleteFile
parameters:
- name: id
in: path
description: Id of uploaded file
required: true
schema:
type: string
responses:
200:
description: OK - file has been found and removed.
404:
description: NOT FOUND - file with the given id has not been found in cache.
/v2/lexicon/suggestions:
post:
tags:
- Lexicon
description: Return a list of lexicon suggestions for the given languages.
operationId: getSuggestions
requestBody:
description: Lexicion suggestions request
content:
application/xml:
schema:
$ref: '#/components/schemas/LexiconSuggestionsRequest'
application/json:
schema:
$ref: '#/components/schemas/LexiconSuggestionsRequest'
required: true
responses:
200:
description: The lexicon suggestion results
content:
application/json:
schema:
$ref: '#/components/schemas/LexicionSuggestionsResponse'
400:
description: BAD REQUEST - in case of a missing or incorrect parameters.
components:
schemas:
AddConceptModifierRequest:
required:
- languages
- word
type: object
properties:
word:
type: string
description: Word to add - resolves to concepts by using the language models
of the given languages
languages:
type: array
description: List of ISO 639-1 language codes (2 letter code)
items:
type: string
description: List of ISO 639-1 language codes (2 letter code)
xml:
name: languages
description: Represents the request for adding a concept (determined by the
word in the given languages).
xml:
name: addConceptModifierRequest
ApiErrorResponse:
type: object
properties:
version:
type: string
description: Version of response class. Currently always 1.0
httpStatusCode:
type: integer
description: HTTP status code of response. Mirrors HTTP response status
line for convenience.
format: int32
httpStatusReason:
type: string
description: HTTP status reason of response. Mirrors HTTP response status
line for convenience.
apiCode:
type: string
description: API specific error code.
developerMessage:
type: string
description: More detailed description of the error. Useful for API consumers.
moreInfo:
type: string
description: Link to a more indepth documentation of the apiCode.
format: url
description: Response entity in case an error occurs in the API call. All attributes
except version may be null.
xml:
name: error
Category:
type: object
properties:
name:
type: string
xml:
attribute: true
concepts:
type: array
xml:
wrapped: true
items:
$ref: '#/components/schemas/Concept'
xml:
name: category
CategoryMatch:
type: object
properties:
name:
type: string
score:
type: number
format: float
conceptMatches:
type: array
xml:
wrapped: true
items:
$ref: '#/components/schemas/ConceptMatch'
Concept:
type: object
properties:
name:
type: string
word:
type: string
level:
type: integer
format: int32
xml:
name: concept
ConceptMatch:
type: object
properties:
sourceConcept:
$ref: '#/components/schemas/Concept'
targetConcepts:
type: array
items:
$ref: '#/components/schemas/Concept'
xml:
name: conceptMatch
CustomFields:
type: object
additionalProperties:
type: string
description: "The custom fields can be used to store additional data with\
\ a document.\n\nThis type implements a Map with the fieldname as key and\
\ the value (as String) as value.\n\nThe ending of the field name determines\
\ the datatype:\n```\nnone or _s = string,\n_i = integer,\n_l = long\n_b\
\ = boolean (allowable values true|false)\n_f = float\n_d = double\n_tdt\
\ = date (in format YYYY-MM-DDThh:mm:ssZ)\n```\nIf the field type is string\
\ a second field with suffix _tci is automatically added for case-independent\
\ search. The final field name for using it in keyword queries is constructed\
\ by adding the prefix 'cust_'. For instance if you add a field named 'ourDocID_s'\
\ the name to use in queries would be 'cust_ourDocID_s'. "
description: "The custom fields can be used to store additional data with a\
\ document.\n\nThis type implements a Map with the fieldname as key and the\
\ value (as String) as value.\n\nThe ending of the field name determines the\
\ datatype:\n```\nnone or _s = string,\n_i = integer,\n_l = long\n_b = boolean\
\ (allowable values true|false)\n_f = float\n_d = double\n_tdt = date (in\
\ format YYYY-MM-DDThh:mm:ssZ)\n```\nIf the field type is string a second\
\ field with suffix _tci is automatically added for case-independent search.\
\ The final field name for using it in keyword queries is constructed by adding\
\ the prefix 'cust_'. For instance if you add a field named 'ourDocID_s' the\
\ name to use in queries would be 'cust_ourDocID_s'. "
xml:
name: customFields
DocumentIndexRequest:
required:
- documentType
- fileURL
type: object
properties:
fileURL:
type: string
description: URL of file to be indexed
format: url
documentType:
type: string
description: Type of document to be indexed
enum:
- cv
- job
- competence
- citynet
- legal
externalReference:
type: string
description: An external reference value which can be used to 'link' the
indexed document to an external store.
updateIfExists:
type: boolean
description: If a document with the same external reference as specified
with this request exists, the existing document will be replaced if this
parameter is set to true. If set to false a 409 CONFLICT error will be
returned.
default: false
language:
type: string
description: Language of uploaded document in ISO 639-1 format. If missing
it is detected automatically.
customFields:
type: object
additionalProperties:
type: string
description: "The custom fields can be used to store additional data with\
\ a document.\n\nThis type implements a Map with the fieldname as key\
\ and the value (as String) as value.\n\nThe ending of the field name\
\ determines the datatype:\n```\nnone or _s = string,\n_i = integer,\n\
_l = long\n_b = boolean (allowable values true|false)\n_f = float\n\
_d = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n```\nIf the\
\ field type is string a second field with suffix _tci is automatically\
\ added for case-independent search. The final field name for using\
\ it in keyword queries is constructed by adding the prefix 'cust_'.\
\ For instance if you add a field named 'ourDocID_s' the name to use\
\ in queries would be 'cust_ourDocID_s'. "
description: "The custom fields can be used to store additional data with\
\ a document.\n\nThis type implements a Map with the fieldname as key\
\ and the value (as String) as value.\n\nThe ending of the field name\
\ determines the datatype:\n```\nnone or _s = string,\n_i = integer,\n\
_l = long\n_b = boolean (allowable values true|false)\n_f = float\n_d\
\ = double\n_tdt = date (in format YYYY-MM-DDThh:mm:ssZ)\n```\nIf the\
\ field type is string a second field with suffix _tci is automatically\
\ added for case-independent search. The final field name for using it\
\ in keyword queries is constructed by adding the prefix 'cust_'. For\
\ instance if you add a field named 'ourDocID_s' the name to use in queries\
\ would be 'cust_ourDocID_s'. "
xml:
name: customFields
documentLocation:
$ref: '#/components/schemas/Location'
description: Represents the request for indexing a document.
xml:
name: DocumentIndexRequest
DocumentProcessingStatistics:
type: object
properties:
totalDocuments:
type: integer
format: int64
processedDocuments:
type: integer
format: int64
successDocuments:
type: integer
format: int64
errorDocuments:
type: integer
format: int64
xml:
name: documentProcessingStatistics
DomainMatches:
type: object
properties:
domains:
type: array
items:
type: string
xml:
name: topUniversities
score:
type: number
format: float
FacetingQueryParameters:
type: object
properties:
empty:
type: boolean
additionalProperties:
type: array
description: Faceting specifications (key-value pairs)
example: '''range'':[''publication_date_dt''],''range.start'':[''NOW/YEAR-15YEAR''],''range.end'':[''NOW''],''range.gap'':[''+1YEAR'']'
items:
type: string
description: Faceting specifications (key-value pairs)
example: '''range'':[''publication_date_dt''],''range.start'':[''NOW/YEAR-15YEAR''],''range.end'':[''NOW''],''range.gap'':[''+1YEAR'']'
description: Faceting specifications (key-value pairs)
example: '''range'':[''publication_date_dt''],''range.start'':[''NOW/YEAR-15YEAR''],''range.end'':[''NOW''],''range.gap'':[''+1YEAR'']'
JobSummary:
type: object
properties:
jobTitle:
type: string
mainFunctionDomain:
type: string
subCategories:
uniqueItems: true
type: array
items:
type: string
xml:
name: subCategories
environments:
uniqueItems: true
type: array
items:
type: string
xml:
name: environments
location:
$ref: '#/components/schemas/Location'
requiredEducation:
type: string
xml:
name: jobSummary
JobTimeline:
type: object
properties:
job:
type: string
beginDate:
type: string
format: date-time
endDate:
type: string
format: date-time
durationInMonths:
type: integer
format: int32
xml:
name: jobTimeline
LexicionSuggestionsResponse:
type: object
properties:
suggestions:
type: array
description: List of suggestions
items:
$ref: '#/components/schemas/LexiconEntry'
description: Represents the response for retrieving suggestions from the lexicon.
xml:
name: lexicionSuggestionsResponse
LexiconEntry:
type: object
properties:
word:
type: string
description: The lexicon word entry
language:
type: string
description: Language of the lexicon word entry
description: Word-language pair representing a lexicon entry
xml:
name: lexiconEntry
LexiconSuggestionsRequest:
required:
- inputString
- languages
type: object
properties:
inputString:
maxLength: 100
minLength: 3
type: string
description: The input string to find suggestions for
example: devel
maximumNumberOfSuggestions:
maximum: 20
minimum: 1
type: integer
description: Maximum number of returned suggestions
format: int32
example: 10
default: 10
languages:
maxItems: 10
minItems: 1
type: array
items:
type: string