{"swagger": "2.0", "basePath": "/", "paths": {"/enrichtextdocuments": {"post": {"responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/EnrichDocsResponse"}}, "422": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Enriches multiple job ads, returning structured job data. The result includes both demanded and non demanded concepts and a prediction between 0 and 1 (~0 = non demanded, ~1 = demanded).", "operationId": "post_enrich_multiple_textdocuments_endpoint", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/EnrichDocsRequest"}}], "tags": ["jobad-enrichments-API"]}}, "/enrichtextdocumentsbinary": {"post": {"responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/EnrichDocsBinaryResponse"}}, "422": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Enriches multiple job ads, returning structured job data. The result contains demanded concepts only. If occupations or geographical terms are found in the headline, they are also considered as demanded.", "operationId": "post_enrich_multiple_textdocuments_binary_endpoint", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"$ref": "#/definitions/EnrichDocsBinaryRequest"}}], "tags": ["jobad-enrichments-API"]}}, "/synonymdictionary": {"get": {"responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/SynonymDictionaryResponse"}}, "422": {"description": "Bad request"}, "500": {"description": "Technical error"}}, "description": "Returns all the items in the synonym dictionary that is used for identifying keywords in the job ads.", "operationId": "get_get_synonym_dictionary_endpoint", "parameters": [{"name": "type", "in": "query", "type": "string", "required": true, "enum": ["COMPETENCE", "OCCUPATION", "TRAIT", "GEO"]}, {"name": "spelling", "in": "query", "type": "string", "required": true, "enum": ["CORRECTLY_SPELLED", "MISSPELLED", "BOTH"]}], "tags": ["jobad-enrichments-API"]}}}, "info": {"title": "JobAd Enrichments API", "version": "1.5.7", "description": "Enriching job ads, making unstructured text structured"}, "produces": ["application/json"], "consumes": ["application/json"], "tags": [{"name": "jobad-enrichments-API"}], "definitions": {"EnrichDocsRequest": {"properties": {"documents_input": {"type": "array", "items": {"properties": {"doc_id": {"type": "string", "description": "Id for the job ad (optional)", "example": "123ABC"}, "doc_headline": {"type": "string", "description": "Headline for the job ad (either doc_headline or doc_text required)", "example": "Systemutvecklare"}, "doc_text": {"type": "string", "description": "Text for the job ad (either doc_headline or doc_text required))", "example": "Vi letar efter en vass javautvecklare. Du ska vara noggrann, snabb och trevlig. Du m\u00e5ste kunna Java, Python, AngularJS och Cobol. Du kommer att jobba p\u00e5 v\u00e5rt kontor i Ystad. V\u00e5rt huvudkontor ligger i Kiruna"}}, "required": [], "type": "object"}, "description": "List of job ads (maximum of 100 documents/job ads per request)", "example": [{"doc_id": "123ABC", "doc_headline": "Systemutvecklare", "doc_text": "Vi letar efter en vass javautvecklare. Du ska vara noggrann, snabb och trevlig. Du m\u00e5ste kunna Java, Python, AngularJS och Cobol. Du kommer att jobba p\u00e5 v\u00e5rt kontor i Ystad. V\u00e5rt huvudkontor ligger i Kiruna"}, {"doc_id": "456DEF", "doc_headline": "Sjuksk\u00f6terska", "doc_text": "Vi letar efter en empatisk sjuksk\u00f6terska. Du ska vara noggrann, kreativ och j\u00e4tteglad. Krav: sjuksk\u00f6terskelegitimation och ha erfarenhet av akutsjukv\u00e5rd. Du kommer att arbeta i Stockholm."}]}, "include_terms_info": {"type": "boolean", "description": "True if additional information about the terms should be included in the result", "example": false}, "include_sentences": {"type": "boolean", "description": "True if original sentences should be included in the result", "example": false}, "sort_by_prediction_score": {"type": "string", "description": "Sorts the candidates by prediction score within the candidate type. Valid input params: ['NOT_SORTED', 'ASC', 'DESC']", "choices": ["NOT_SORTED", "ASC", "DESC"], "default": "NOT_SORTED", "required": false, "example": "NOT_SORTED"}}, "required": [], "type": "object"}, "EnrichDocsResponse": {"properties": {"doc_id": {"type": "string", "description": "Id for the job ad. Not returned if not included in request input."}, "doc_headline": {"type": "string", "description": "Returned headline for the job ad."}, "doc_sentences": {"type": "array", "description": "All identified sentences in the job ad. Only returned if the input flag \"include_sentences\" is true.", "items": {"type": "string"}}, "enriched_candidates": {"description": "Found candidates/terms with a prediction of how likely it is that the term is requested by the employer. Prediction closer to 0.0 = Not requested, the closer to 1.0 = Requested", "allOf": [{"$ref": "#/definitions/EnrichedCandidates"}]}}, "type": "object"}, "EnrichedCandidates": {"properties": {"occupations": {"type": "array", "description": "Found and enriched occupations in the job ad text.", "items": {"$ref": "#/definitions/EnrichedCandidate"}}, "competencies": {"type": "array", "description": "Found and enriched competencies in the job ad text.", "items": {"$ref": "#/definitions/EnrichedCandidate"}}, "traits": {"type": "array", "description": "Found and enriched traits in the job ad text.", "items": {"$ref": "#/definitions/EnrichedCandidate"}}, "geos": {"type": "array", "description": "Found and enriched geographical locations (city names, districts, country names, names of subway stations and shuttle stations) in the job ad text.", "items": {"$ref": "#/definitions/EnrichedCandidate"}}}, "type": "object"}, "EnrichedCandidate": {"properties": {"concept_label": {"type": "string", "description": "The most common term/preferred label/key for the group of synonym terms that the found term belongs to."}, "term": {"type": "string", "description": "The extracted term found in the text, in lowercase."}, "term_misspelled": {"type": "boolean", "description": "True if the found term is misspelled. Only returned if the input flag \"include_terms_info\" is true."}, "sentence": {"type": "string", "description": "The sentence that the term was found in. Only returned if the input flag \"include_sentences\" is true."}, "sentence_index": {"type": "integer", "description": "Index of the sentence that the term was found in. The ad headline has sentence index 0. Only returned if the input flag \"include_sentences\" is true."}, "prediction": {"type": "number", "description": "A decimal between 0.0-1.0 how likely it is that the term is requested by the employer. The closer to 0.0 = Not requested, the closer to 1.0 = Requested)"}}, "type": "object"}, "EnrichDocsBinaryRequest": {"properties": {"documents_input": {"type": "array", "items": {"properties": {"doc_id": {"type": "string", "description": "Id for the job ad (optional)", "example": "123ABC"}, "doc_headline": {"type": "string", "description": "Headline for the job ad (either doc_headline or doc_text required)", "example": "Systemutvecklare"}, "doc_text": {"type": "string", "description": "Text for the job ad (either doc_headline or doc_text required))", "example": "Vi letar efter en vass javautvecklare. Du ska vara noggrann, snabb och trevlig. Du m\u00e5ste kunna Java, Python, AngularJS och Cobol. Du kommer att jobba p\u00e5 v\u00e5rt kontor i Ystad. V\u00e5rt huvudkontor ligger i Kiruna"}}, "required": [], "type": "object"}, "description": "List of job ads (maximum of 100 documents/job ads per request)", "example": [{"doc_id": "123ABC", "doc_headline": "Systemutvecklare", "doc_text": "Vi letar efter en vass javautvecklare. Du ska vara noggrann, snabb och trevlig. Du m\u00e5ste kunna Java, Python, AngularJS och Cobol. Du kommer att jobba p\u00e5 v\u00e5rt kontor i Ystad. V\u00e5rt huvudkontor ligger i Kiruna"}, {"doc_id": "456DEF", "doc_headline": "Sjuksk\u00f6terska", "doc_text": "Vi letar efter en empatisk sjuksk\u00f6terska. Du ska vara noggrann, kreativ och j\u00e4tteglad. Krav: sjuksk\u00f6terskelegitimation och ha erfarenhet av akutsjukv\u00e5rd. Du kommer att arbeta i Stockholm."}]}, "include_terms_info": {"type": "boolean", "description": "True if additional information about the terms should be included in the result", "example": false}, "include_sentences": {"type": "boolean", "description": "True if original sentences should be included in the result", "example": false}, "include_synonyms": {"type": "boolean", "description": "True if synonyms for enriched concepts should be included in the result", "example": false}, "include_misspelled_synonyms": {"type": "boolean", "description": "True if misspelled synonyms for enriched concepts should be included in the result", "example": false}}, "required": [], "type": "object"}, "EnrichDocsBinaryResponse": {"properties": {"doc_id": {"type": "string", "description": "Id for the job ad. Not returned if not included in request input."}, "doc_headline": {"type": "string", "description": "Returned headline for the job ad."}, "doc_sentences": {"type": "array", "description": "All identified sentences in the job ad. Only returned if the input flag \"include_sentences\" is true.", "items": {"type": "string"}}, "enriched_candidates": {"description": "Found candidates/terms that are considered as requested by the employer.", "allOf": [{"$ref": "#/definitions/EnrichedBinaryCandidates"}]}, "enriched_candidates_synonyms": {"description": "All known synonym terms for the found candidates/terms that are considered as requested by the employer. Only returned if the input flag \"include_synonyms\" is true.", "allOf": [{"$ref": "#/definitions/EnrichedBinaryCandidates"}]}, "enriched_candidates_misspelled_synonyms": {"description": "All known misspelled synonym terms for the found candidates/terms that are considered as requested by the employer. Only returned if the input flag \"include_synonyms\" is true.", "allOf": [{"$ref": "#/definitions/EnrichedBinaryCandidates"}]}}, "type": "object"}, "EnrichedBinaryCandidates": {"properties": {"occupations": {"type": "array", "description": "Found occupations that are considered as requested by the employer.", "items": {"$ref": "#/definitions/EnrichedBinaryCandidate"}}, "competencies": {"type": "array", "description": "Found competencies that are considered as requested by the employer.", "items": {"$ref": "#/definitions/EnrichedBinaryCandidate"}}, "traits": {"type": "array", "description": "Found traits that are considered as requested by the employer.", "items": {"$ref": "#/definitions/EnrichedBinaryCandidate"}}, "geos": {"type": "array", "description": "Found geographical locations (city names, districts, country names, names of subway stations and shuttle stations) that are considered as requested by the employer.", "items": {"$ref": "#/definitions/EnrichedBinaryCandidate"}}}, "type": "object"}, "EnrichedBinaryCandidate": {"properties": {"concept_label": {"type": "string", "description": "The most common term/preferred label/key for the group of synonym terms that the found term belongs to."}, "term": {"type": "string", "description": "The extracted term found in the text, in lowercase."}, "term_misspelled": {"type": "boolean", "description": "True if the found term is misspelled. Only returned if the input flag \"include_terms_info\" is true."}, "sentence": {"type": "string", "description": "The sentence that the term was found in. Only returned if the input flag \"include_sentences\" is true."}, "sentence_index": {"type": "integer", "description": "Index of the sentence that the term was found in. The ad headline has sentence index 0. Only returned if the input flag \"include_sentences\" is true."}}, "type": "object"}, "SynonymDictionaryResponse": {"properties": {"total": {"type": "integer", "description": "Number of items in this particular response."}, "build_datetime": {"type": "string", "description": "Date and time when this synonym dictionary was built (instead of version)."}, "build_datetime_unix_epoch": {"type": "integer", "description": "Unix epoch time when this synonym dictionary was built (instead of version)."}, "items": {"type": "array", "description": "List with items from the synonym dictionary used while enriching the job ads.", "items": {"$ref": "#/definitions/SynonymDictionaryItem"}}}, "type": "object"}, "SynonymDictionaryItem": {"properties": {"concept": {"type": "string", "description": "The most common term/preferred label for a group of synonym terms. The concept can for example be used as a common key in digital matching."}, "term": {"type": "string", "description": "The term in lowercase"}, "term_misspelled": {"type": "boolean", "description": "True if the term is misspelled"}, "type": {"type": "string", "description": "Any of: ['COMPETENCE', 'OCCUPATION', 'TRAIT', 'GEO']"}, "plural_occupation": {"type": "boolean", "description": "True if type is OCCUPATION and the term is in plural form. Skipped if the type is other than OCCUPATION."}, "definite_occupation": {"type": "boolean", "description": "True if type is OCCUPATION and the term is in definite form. Skipped if the type is other than OCCUPATION."}}, "type": "object"}}, "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}, "ValidationError": {}}}